| Index: pkg/docgen/lib/docgen.dart
|
| diff --git a/pkg/docgen/lib/docgen.dart b/pkg/docgen/lib/docgen.dart
|
| index 415102a25614d80fb95d902ea0bceabdb8920941..7ecccb71e1c85741f9eab5f514cc6fec2b33f16e 100644
|
| --- a/pkg/docgen/lib/docgen.dart
|
| +++ b/pkg/docgen/lib/docgen.dart
|
| @@ -296,7 +296,7 @@ markdown.Node fixReference(String name, LibraryMirror currentLibrary,
|
| }
|
|
|
| /**
|
| - * 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) {
|
| @@ -315,7 +315,7 @@ Map<String, Variable> _getVariables(Map<String, VariableMirror> mirrorMap,
|
| }
|
|
|
| /**
|
| - * 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) {
|
| @@ -358,7 +358,7 @@ Map<String, Map<String, Method>> _getMethods
|
| }
|
|
|
| /**
|
| - * 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) {
|
| @@ -383,7 +383,10 @@ Map<String, Class> _getClasses(Map<String, ClassMirror> mirrorMap,
|
| 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) {
|
| @@ -402,7 +405,7 @@ Map<String, Class> _getClasses(Map<String, ClassMirror> mirrorMap,
|
| }
|
|
|
| /**
|
| - * 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 = {};
|
| @@ -465,7 +468,12 @@ bool isError(String qualifiedName) {
|
| * 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);
|
| }
|
| }
|
| @@ -475,9 +483,6 @@ class Indexable {
|
| */
|
| class Library extends Indexable {
|
|
|
| - /// Documentation comment with converted markdown.
|
| - String comment;
|
| -
|
| /// Top-level variables in the library.
|
| Map<String, Variable> variables;
|
|
|
| @@ -487,23 +492,17 @@ class Library extends Indexable {
|
| /// 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)
|
| + };
|
| }
|
|
|
| /**
|
| @@ -512,9 +511,6 @@ class Library extends Indexable {
|
| // 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;
|
|
|
| @@ -527,29 +523,51 @@ class Class extends Indexable {
|
| /// 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)
|
| + };
|
| }
|
|
|
| /**
|
| @@ -557,10 +575,6 @@ class Class extends Indexable {
|
| */
|
| class Variable extends Indexable {
|
|
|
| - /// Documentation comment with converted markdown.
|
| - String comment;
|
| -
|
| - String name;
|
| bool isFinal;
|
| bool isStatic;
|
| String type;
|
| @@ -568,20 +582,19 @@ class Variable extends Indexable {
|
| /// 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)
|
| + };
|
| }
|
|
|
| /**
|
| @@ -589,34 +602,28 @@ class Variable extends Indexable {
|
| */
|
| 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)
|
| + };
|
| }
|
|
|
| /**
|
| @@ -638,17 +645,15 @@ class Parameter {
|
| 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)
|
| + };
|
| }
|
|
|
| /**
|
| @@ -660,10 +665,8 @@ class Generic {
|
|
|
| Generic(this.name, this.type);
|
|
|
| - Map toMap() {
|
| - return {
|
| + Map toMap() => {
|
| 'name': name,
|
| 'type': type
|
| };
|
| - }
|
| }
|
|
|