human-friendly type names for model elements

Author: sethladd

lib/src/html_generator.dart

@@ -179,16 +179,12 @@ class HtmlGeneratorInstance {
     File jsonFile = createOutputFile(out, 'index.json');
     String json = JSON.encode(documentedElements.map((ModelElement e) {
       // TODO: find a better string for type
-      Map data = {
-        'name': e.name,
-        'href': e.href,
-        'type': e.runtimeType.toString()
-      };
+      Map data = {'name': e.name, 'href': e.href, 'type': e.kind};
       if (e is EnclosedElement) {
         EnclosedElement ee = e as EnclosedElement;
         data['enclosedBy'] = {
           'name': ee.enclosingElement.name,
-          'type': ee.enclosingElement.runtimeType.toString()
+          'type': ee.enclosingElement.kind
         };
       }
       return data;

lib/src/model.dart

@@ -125,6 +125,9 @@ abstract class ModelElement implements Comparable, Nameable {
     }
   }
 
+  /// A human-friendly name for the kind of element this is.
+  String get kind;
+
   String get _computeDocumentationComment =>
       element.computeDocumentationComment();
 
@@ -381,6 +384,9 @@ class Dynamic extends ModelElement {
   ModelElement get enclosingElement => throw new UnsupportedError('');
 
   String get _href => throw new StateError('dynamic should not have an href');
+
+  @override
+  String get kind => 'dynamic';
 }
 
 class Package implements Nameable {
@@ -520,6 +526,9 @@ class Library extends ModelElement {
     return library;
   }
 
+  @override
+  String get kind => 'library';
+
   /// Libraries are not enclosed by anything.
   ModelElement get enclosingElement => null;
 
@@ -830,6 +839,7 @@ class Class extends ModelElement implements EnclosedElement {
         return new TypeParameter(f, lib);
       }).toList();
 
+  @override
   String get kind => 'class';
 
   String get fileName => "${name}-class.html";
@@ -1312,6 +1322,9 @@ class ModelFunction extends ModelElement
 
   String get fileName => "$name.html";
 
+  @override
+  String get kind => 'function';
+
   @override
   String get _href => '${library.dirName}/$fileName';
 }
@@ -1327,6 +1340,9 @@ class Typedef extends ModelElement implements EnclosedElement {
     }
   }
 
+  @override
+  String get kind => 'typedef';
+
   @override
   ModelElement get enclosingElement => library;
 
@@ -1339,6 +1355,7 @@ class Typedef extends ModelElement implements EnclosedElement {
   String get _href => '${library.dirName}/$fileName';
 }
 
+// TODO: rename this to property
 class Field extends ModelElement implements EnclosedElement {
   String _constantValue;
   bool _isInherited = false;
@@ -1355,6 +1372,9 @@ class Field extends ModelElement implements EnclosedElement {
     _setModelType();
   }
 
+  @override
+  String get kind => 'property';
+
   @override
   ModelElement get enclosingElement =>
       new ModelElement.from(_field.enclosingElement, library);
@@ -1476,6 +1496,9 @@ class Constructor extends ModelElement implements EnclosedElement {
   Constructor(ConstructorElement element, Library library)
       : super(element, library);
 
+  @override
+  String get kind => 'constructor';
+
   @override
   ModelElement get enclosingElement =>
       new ModelElement.from(_constructor.enclosingElement, library);
@@ -1523,6 +1546,9 @@ class Method extends ModelElement
     _isInherited = true;
   }
 
+  @override
+  String get kind => 'method';
+
   @override
   ModelElement get enclosingElement =>
       new ModelElement.from(_method.enclosingElement, library);
@@ -1613,6 +1639,9 @@ class Accessor extends ModelElement implements EnclosedElement {
   Accessor(PropertyAccessorElement element, Library library)
       : super(element, library);
 
+  @override
+  String get kind => 'accessor';
+
   @override
   ModelElement get enclosingElement =>
       new ModelElement.from(_accessor.enclosingElement, library);
@@ -1642,6 +1671,9 @@ class TopLevelVariable extends ModelElement implements EnclosedElement {
     }
   }
 
+  @override
+  String get kind => 'top-level property';
+
   @override
   ModelElement get enclosingElement => library;
 
@@ -1690,6 +1722,9 @@ class Parameter extends ModelElement implements EnclosedElement {
         t, new ModelElement.from(t.element, package._getLibraryFor(t.element)));
   }
 
+  @override
+  String get kind => 'parameter';
+
   @override
   ModelElement get enclosingElement =>
       new ModelElement.from(_parameter.enclosingElement, library);
@@ -1740,6 +1775,9 @@ class TypeParameter extends ModelElement {
     _modelType = new ElementType(_typeParameter.type, this);
   }
 
+  @override
+  String get kind => 'type parameter';
+
   TypeParameterElement get _typeParameter => element as TypeParameterElement;
 
   String toString() => element.name;