Typedef information showing properly.

pkg/docgen/lib/docgen.dart

 // Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 /**
  * **docgen** is a tool for creating machine readable representations of Dart
  * code metadata, including: classes, members, comments and annotations.
  *
  * docgen is run on a `.dart` file or a directory containing `.dart` files.
  *
@@ skipping 278 matching lines @@
   if (memberScope != null) reference = memberScope.qualifiedName;
   else {
     var classScope = currentClass == null ?
         null : currentClass.lookupInScope(name);
     reference = classScope != null ? classScope.qualifiedName : name;
   }
   return new markdown.Element.text('a', reference);
 }
 
 /**
- * Returns a map of [Variable] objects constructed from inputted mirrors.
+ * Returns a map of [Variable] objects constructed from [mirrorMap].
  */
 Map<String, Variable> _getVariables(Map<String, VariableMirror> mirrorMap,
     bool includePrivate) {
   var data = {};
   // TODO(janicejl): When map to map feature is created, replace the below with
   // a filter. Issue(#9590).
   mirrorMap.forEach((String mirrorName, VariableMirror mirror) {
     if (includePrivate || !mirror.isPrivate) {
       _currentMember = mirror;
       data[mirrorName] = new Variable(mirrorName, mirror.isFinal, 
           mirror.isStatic, mirror.type.qualifiedName, _getComment(mirror), 
           _getAnnotations(mirror), mirror.qualifiedName);
     }
   });
   return data;
 }
 
 /**
- * Returns a map of [Method] objects constructed from inputted mirrors.
+ * Returns a map of [Method] objects constructed from [mirrorMap].
  */
 Map<String, Map<String, Method>> _getMethods
     (Map<String, MethodMirror> mirrorMap, bool includePrivate) {
 
   var setters = {};
   var getters = {};
   var constructors = {};
   var operators = {};
   var methods = {};
   
@@ skipping 22 matching lines @@
   return {
     'setters': setters,
     'getters': getters,
     'constructors': constructors,
     'operators': operators,
     'methods': methods
   };
 } 
 
 /**
- * Returns a map of [Class] objects constructed from inputted mirrors.
+ * Returns a map of [Class] objects constructed from [mirrorMap].
  */
 Map<String, Class> _getClasses(Map<String, ClassMirror> mirrorMap,
     bool includePrivate) {
   
   var abstractClasses = {};
   var classes = {};
   var typedefs = {};
   var errors = {};
   
   mirrorMap.forEach((String mirrorName, ClassMirror mirror) {    
     if (includePrivate || !mirror.isPrivate) {
       var superclass = (mirror.superclass != null) ?
           mirror.superclass.qualifiedName : '';
       var interfaces =
           mirror.superinterfaces.map((interface) => interface.qualifiedName);
       var clazz = new Class(mirrorName, superclass, _getComment(mirror), 
           interfaces.toList(), _getVariables(mirror.variables, includePrivate),
           _getMethods(mirror.methods, includePrivate),
           _getAnnotations(mirror), _getGenerics(mirror), mirror.qualifiedName);
       _currentClass = mirror;
       
       if (isError(mirror.qualifiedName)) {
         errors[mirrorName] = clazz;
       } else if (mirror.isTypedef) {
-        typedefs[mirrorName] = clazz;
+        typedefs[mirrorName] = new Typedef(mirrorName, 
+            mirror.value.returnType.qualifiedName,  _getComment(mirror), 
+            _getGenerics(mirror), _getParameters(mirror.value.parameters),
+            _getAnnotations(mirror), mirror.qualifiedName);
       } else if (mirror.isAbstract) {
         abstractClasses[mirrorName] = clazz;
       } else if (mirror.isClass) {
         classes[mirrorName] = clazz;
       } else {
         throw new ArgumentError('$mirrorName - no class type match. ');
       }
     }
   });
   return {
     'abstract': abstractClasses, 
     'class': classes,
     'typedef': typedefs,
     'error': errors
   };
 }
 
 /**
- * Returns a map of [Parameter] objects constructed from inputted mirrors.
+ * Returns a map of [Parameter] objects constructed from [mirrorList].
  */
 Map<String, Parameter> _getParameters(List<ParameterMirror> mirrorList) {
   var data = {};
   mirrorList.forEach((ParameterMirror mirror) {
     _currentMember = mirror;
     data[mirror.simpleName] = new Parameter(mirror.simpleName, 
         mirror.isOptional, mirror.isNamed, mirror.hasDefaultValue, 
         mirror.type.qualifiedName, mirror.defaultValue, 
         _getAnnotations(mirror));
   });
@@ skipping 42 matching lines @@
 
 bool isError(String qualifiedName) {
   return qualifiedName.toLowerCase().contains('error') || 
       qualifiedName.toLowerCase().contains('exception');
 }
 
 /**
  * A class representing all programming constructs, like library or class. 
  */
 class Indexable {
-  Indexable(String qualifiedName) {
+  String name;
+  
+  /// Documentation comment with converted markdown.
+  String comment;
+  
+  Indexable(this.name, this.comment, String qualifiedName) {
     qualifiedNameIndex.add(qualifiedName);
   }
 }
 
 /**
  * A class containing contents of a Dart library.
  */
 class Library extends Indexable {
 
-  /// Documentation comment with converted markdown.
-  String comment;
-
   /// Top-level variables in the library.
   Map<String, Variable> variables;
 
   /// Top-level functions in the library.
   Map<String, Map<String, Method>> functions;
   
   /// Classes defined within the library
   Map<String, Class> classes;
 
-  String name;
-
-  Library(name, this.comment, this.variables,
-      this.functions, this.classes) : super(name) {
-    this.name = name; 
-  }
+  Library(String name, String comment, this.variables,
+      this.functions, this.classes) : super(name, comment, name) {}
 
   /// Generates a map describing the [Library] object.
-  Map toMap() {
-    var libraryMap = {};
-    libraryMap['name'] = name;
-    libraryMap['comment'] = comment;
-    libraryMap['variables'] = recurseMap(variables);
-    libraryMap['functions'] = recurseMap(functions);
-    libraryMap['classes'] = recurseMap(classes);
-    return libraryMap;
-  }
+  Map toMap() => {
+      'name': name,
+      'comment': comment,
+      'variables': recurseMap(variables),
+      'functions': recurseMap(functions),
+      'classes': recurseMap(classes)
+    };
 }
 
 /**
  * A class containing contents of a Dart class.
  */
 // TODO(tmandel): Figure out how to do typedefs (what is needed)
 class Class extends Indexable {
 
-  /// Documentation comment with converted markdown.
-  String comment;
-
   /// List of the names of interfaces that this class implements.
   List<String> interfaces;
 
   /// Top-level variables in the class.
   Map<String, Variable> variables;
 
   /// Methods in the class.
   Map<String, Map<String, Method>> methods;
   
   /// Generic infomation about the class. 
   Map<String, Generic> generics;
   
-  String name;
   String superclass;
 
   /// List of the meta annotations on the class.
   List<String> annotations;
   
-  Class(this.name, this.superclass, this.comment, this.interfaces, 
+  Class(String name, this.superclass, String comment, this.interfaces, 
       this.variables, this.methods, this.annotations, this.generics,
-      String qualifiedName) : super(qualifiedName) {}
+      String qualifiedName) : super(name, comment, qualifiedName) {}
 
   /// Generates a map describing the [Class] object.
-  Map toMap() {
-    var classMap = {};
-    classMap['name'] = name;
-    classMap['comment'] = comment;
-    classMap['superclass'] = superclass;
-    classMap['implements'] = new List.from(interfaces);
-    classMap['variables'] = recurseMap(variables);
-    classMap['methods'] = recurseMap(methods);
-    classMap['annotations'] = new List.from(annotations);
-    classMap['generics'] = recurseMap(generics);
-    return classMap;
-  }
+  Map toMap() => {
+      'name': name,
+      'comment': comment,
+      'superclass': superclass,
+      'implements': new List.from(interfaces),
+      'variables': recurseMap(variables),
+      'methods': recurseMap(methods),
+      'annotations': new List.from(annotations),
+      'generics': recurseMap(generics)
+    };
+}
+
+class Typedef extends Indexable {
+  String returnType;
+  
+  Map<String, Parameter> parameters;
+  
+  /// Generic information about the typedef. 
+  Map<String, Generic> generics;
+  
+  /// List of the meta annotations on the typedef. 
+  List<String> annotations;
+  
+  Typedef(String name, this.returnType, String comment, this.generics, 
+      this.parameters, this.annotations,
+      String qualifiedName) : super(name, comment, qualifiedName) {}
+  
+  Map toMap() => {
+      'name': name,
+      'comment': comment,
+      'return': returnType,
+      'parameters': recurseMap(parameters),
+      'annotations': new List.from(annotations),
+      'generics': recurseMap(generics)
+    };
 }
 
 /**
  * A class containing properties of a Dart variable.
  */
 class Variable extends Indexable {
 
-  /// Documentation comment with converted markdown.
-  String comment;
-
-  String name;
   bool isFinal;
   bool isStatic;
   String type;
 
   /// List of the meta annotations on the variable.
   List<String> annotations;
   
-  Variable(this.name, this.isFinal, this.isStatic, this.type, this.comment, 
-      this.annotations, String qualifiedName) : super(qualifiedName);
+  Variable(String name, this.isFinal, this.isStatic, this.type, String comment, 
+      this.annotations, String qualifiedName) : super(name, comment, 
+          qualifiedName);
   
   /// Generates a map describing the [Variable] object.
-  Map toMap() {
-    var variableMap = {};
-    variableMap['name'] = name;
-    variableMap['comment'] = comment;
-    variableMap['final'] = isFinal.toString();
-    variableMap['static'] = isStatic.toString();
-    variableMap['type'] = type;
-    variableMap['annotations'] = new List.from(annotations);
-    return variableMap;
-  }
+  Map toMap() => {
+      'name': name,
+      'comment': comment,
+      'final': isFinal.toString(),
+      'static': isStatic.toString(),
+      'type': type,
+      'annotations': new List.from(annotations)
+    };
 }
 
 /**
  * A class containing properties of a Dart method.
  */
 class Method extends Indexable {
 
-  /// Documentation comment with converted markdown.
-  String comment;
-
   /// Parameters for this method.
   Map<String, Parameter> parameters;
 
-  String name;
   bool isStatic;
   String returnType;
 
   /// List of the meta annotations on the method.
   List<String> annotations;
   
-  Method(this.name, this.isStatic, this.returnType, this.comment, 
+  Method(String name, this.isStatic, this.returnType, String comment, 
       this.parameters, this.annotations, String qualifiedName) 
-      : super(qualifiedName);
+      : super(name, comment, qualifiedName);
   
   /// Generates a map describing the [Method] object.
-  Map toMap() {
-    var methodMap = {};
-    methodMap['name'] = name;
-    methodMap['comment'] = comment;
-    methodMap['static'] = isStatic.toString();
-    methodMap['return'] = returnType;
-    methodMap['parameters'] = recurseMap(parameters);
-    methodMap['annotations'] = new List.from(annotations);
-    return methodMap;
-  }
+  Map toMap() => {
+      'name': name,
+      'comment': comment,
+      'static': isStatic.toString(),
+      'return': returnType,
+      'parameters': recurseMap(parameters),
+      'annotations': new List.from(annotations)
+    };
 }
 
 /**
  * A class containing properties of a Dart method/function parameter.
  */
 class Parameter {
 
   String name;
   bool isOptional;
   bool isNamed;
   bool hasDefaultValue;
   String type;
   String defaultValue;
 
   /// List of the meta annotations on the parameter.
   List<String> annotations;
   
   Parameter(this.name, this.isOptional, this.isNamed, this.hasDefaultValue, 
       this.type, this.defaultValue, this.annotations);
   
   /// Generates a map describing the [Parameter] object.
-  Map toMap() {
-    var parameterMap = {};
-    parameterMap['name'] = name;
-    parameterMap['optional'] = isOptional.toString();
-    parameterMap['named'] = isNamed.toString();
-    parameterMap['default'] = hasDefaultValue.toString();
-    parameterMap['type'] = type;
-    parameterMap['value'] = defaultValue;
-    parameterMap['annotations'] = new List.from(annotations);
-    return parameterMap;
-  }
+  Map toMap() => {
+      'name': name,
+      'optional': isOptional.toString(),
+      'named': isNamed.toString(),
+      'default': hasDefaultValue.toString(),
+      'type': type,
+      'value': defaultValue,
+      'annotations': new List.from(annotations)
+    };
 }
 
 /**
  * A class containing properties of a Generic. 
  */
 class Generic {
   String name;
   String type;
   
   Generic(this.name, this.type);
   
-  Map toMap() {
-    return {
+  Map toMap() => {
       'name': name,
       'type': type
     };
-  }
 }