Full typedef support in dartdoc.

pkg/dartdoc/dartdoc.dart

 // Copyright (c) 2012, 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.
 
 /**
  * To generate docs for a library, run this script with the path to an
  * entrypoint .dart file, like:
  *
  *     $ dart dartdoc.dart foo.dart
  *
@@ skipping 761 matching lines @@
     if (comment != null) {
       writeln('<div class="doc">$comment</div>');
     }
 
     // Document the top-level members.
     docMembers(library);
 
     // Document the types.
     final classes = <InterfaceMirror>[];
     final interfaces = <InterfaceMirror>[];
+    final typedefs = <TypedefMirror>[];
     final exceptions = <InterfaceMirror>[];
 
     for (InterfaceMirror type in orderByName(library.types.getValues())) {
       if (type.isPrivate) continue;
 
       if (isException(type)) {
         exceptions.add(type);
       } else if (type.isClass) {
         classes.add(type);
+      } else if (type.isInterface){
+        interfaces.add(type);
       } else {
-        interfaces.add(type);
+        assert(type is TypedefMirror);

[ahe, 2012/08/21 08:50:28]

This is one of the many places where an assertion is inferior.

If dart2js adds another kind of type, dartdoc simply ignores it in production
mode and crashes with an assertion error in developer mode.

It would be much better to do something like this:

} else if (type is TypedefMirror) {
...
} else {
throw new StateError("internal error: unknown type $type.");

[Johnni Winther, 2012/08/21 09:30:27]

Done.

+        typedefs.add(type);
       }
     }
 
     docTypes(classes, 'Classes');
     docTypes(interfaces, 'Interfaces');
+    docTypes(typedefs, 'Typedefs');
     docTypes(exceptions, 'Exceptions');
 
     writeFooter();
     endFile();
 
     for (final type in library.types.getValues()) {
       if (type.isPrivate) continue;
 
       docType(type);
     }
   }
 
-  void docTypes(List<InterfaceMirror> types, String header) {
+  void docTypes(List types, String header) {
     if (types.length == 0) return;
 
     writeln('<h3>$header</h3>');
 
     for (final type in types) {
       writeln(
           '''
           <div class="type">
           <h4>
             ${a(typeUrl(type), "<strong>${typeName(type)}</strong>")}
@@ skipping 161 matching lines @@
   void docTypedef(TypeMirror type) {
     if (type is! TypedefMirror) {
       return;
     }
     writeln('<div class="method"><h4 id="${type.simpleName}">');
 
     if (includeSource) {
       writeln('<span class="show-code">Code</span>');
     }
 
-    if (type.definition !== null) {
-      // TODO(johnniwinther): Implement [:TypedefMirror.definition():].
-      write('typedef ');
-      annotateType(type, type.definition, type.simpleName);
+    write('typedef ');
+    annotateType(type, type.definition, type.simpleName);
 
-      write(''' <a class="anchor-link" href="#${type.simpleName}"
-                title="Permalink to ${type.simpleName}">#</a>''');
-    }
+    write(''' <a class="anchor-link" href="#${type.simpleName}"
+              title="Permalink to ${type.simpleName}">#</a>''');
     writeln('</h4>');
 
     docCode(type.location, null, showCode: true);
 
     writeln('</div>');
   }
 
   /** Document the constructors for [Type], if any. */
   void docConstructors(InterfaceMirror type) {
     final constructors = <MethodMirror>[];
@@ skipping 574 matching lines @@
   }
 
   /**
    * Returns [:true:] if [type] should be regarded as an exception.
    */
   bool isException(TypeMirror type) {
     return type.simpleName.endsWith('Exception');
   }
 }