Several new features and improvements for dartdoc.

utils/apidoc/apidoc.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.
 
 /**
  * This generates the reference documentation for the core libraries that come
  * with dart. It is built on top of dartdoc, which is a general-purpose library
  * for generating docs from any Dart code. This library extends that to include
  * additional information and styling specific to our standard library.
  *
  * Usage:
  *
  *     $ dart apidoc.dart [--out=<output directory>]
  */
 
 #library('apidoc');
 
 #import('dart:io');
 #import('dart:json');
 #import('html_diff.dart');
 #import('../../lib/dartdoc/mirrors/mirrors.dart');
 #import('../../lib/dartdoc/mirrors/mirrors_util.dart');
 #import('../../lib/dartdoc/dartdoc.dart', prefix: 'doc');
+#import('../../lib/compiler/implementation/library_map.dart');
 
 HtmlDiff _diff;
 
 void main() {
   final args = new Options().arguments;
 
   int mode = doc.MODE_STATIC;
   Path outputDir = const Path('docs');
   bool generateAppCache = false;
 
@@ skipping 61 matching lines @@
   htmldoc.documentLibraries(
     <Path>[doc.scriptDir.append('../../lib/html/doc/html.dartdoc')],
     doc.libPath);
   print('Processing handwritten HTML documentation...');
 
   // Process libraries.
 
   // TODO(johnniwinther): Libraries for the compilation seem to be more like
   // URIs. Perhaps Path should have a toURI() method.
   // Add all of the core libraries.
-  var apidocLibraries = <Path>[
-    const Path('dart:core'),
-    const Path('dart:coreimpl'),
-    const Path('dart:crypto'),
-    const Path('dart:html'),
-    const Path('dart:io'),
-    const Path('dart:isolate'),
-    const Path('dart:json'),
-    doc.scriptDir.append('../../lib/math/math.dart'),
-    doc.scriptDir.append('../../lib/unittest/unittest.dart'),
-    doc.scriptDir.append('../../lib/i18n/intl.dart'),
-    const Path('dart:uri'),
-    const Path('dart:utf'),
-    const Path('dart:web'),
-  ];
+  var apidocLibraries = new List<Path>();

[floitsch, 2012/07/23 10:43:56]

= <Path>[];

[Johnni Winther, 2012/07/24 08:49:16]

Done.

+  DART2JS_LIBRARY_MAP.forEach((String name, LibraryInfo info) {
+    if (!info.internal) {
+      apidocLibraries.add(new Path('dart:$name'));
+    }
+  });
+  apidocLibraries.add(doc.scriptDir.append('../../lib/math/math.dart'));
+  apidocLibraries.add(doc.scriptDir.append('../../lib/unittest/unittest.dart'));
+  apidocLibraries.add(doc.scriptDir.append('../../lib/i18n/intl.dart'));
+
   print('Generating docs...');
   final apidoc = new Apidoc(mdn, htmldoc, outputDir, mode, generateAppCache);
   // Select the libraries to include in the produced documentation:
-  apidoc.libraries = <String>[
-    'core',
-    'coreimpl',
-    'crypto',
-    'html',
-    'io',
-    'dart:isolate',
-    'json',
-    'math',
+  apidoc.includeAPI = true;
+  apidoc.includeLibraries = <String>[
     'unittest',
     'intl',
-    'uri',
-    'utf',
-    'web',
   ];
 
   Futures.wait([compiled, copiedStatic, copiedApiDocStatic]).then((_) {
     apidoc.documentLibraries(apidocLibraries, doc.libPath);
   });
 }
 
 /**
  * This class is purely here to scrape handwritten HTML documentation.
  * This scraped documentation will later be merged with the generated
@@ skipping 18 matching lines @@
   }
 
   // Suppress any actual writing to file.  This is only for analysis.
   void endFile() {
   }
 
   void write(String s) {
   }
 
   String getRecordedLibraryComment(LibraryMirror library) {
-    if (library.simpleName() == 'html') {
+    if (library.simpleName() == HTML_LIBRARY_NAME) {
       return libraryComment;
     }
     return null;
   }
 
   String getRecordedTypeComment(TypeMirror type) {
     if (typeComments.containsKey(type.qualifiedName())) {
       return typeComments[type.qualifiedName()];
     }
     return null;
@@ skipping 171 matching lines @@
     super.docLibrary(library);
   }
 
   /** Override definition from parent class to strip out annotation tags. */
   String commentToHtml(String comment) {
     return super.commentToHtml(
         comment.replaceAll(const RegExp("@([a-zA-Z]+) ([^;]+)(?:;|\$)"), ''));
   }
 
   String getLibraryComment(LibraryMirror library) {
-    if (library.simpleName() == 'html') {
+    if (library.simpleName() == HTML_LIBRARY_NAME) {
       return htmldoc.libraryComment;
     }
     return super.getLibraryComment(library);
   }
 
   String getTypeComment(TypeMirror type) {
     return _mergeDocs(
         includeMdnTypeComment(type), super.getTypeComment(type),
         htmldoc.getRecordedTypeComment(type));
   }
@@ skipping 67 matching lines @@
           </p>
           ''');
     }
   }
 
   /**
    * Gets the MDN-scraped docs for [type], or `null` if this type isn't
    * scraped from MDN.
    */
   includeMdnTypeComment(TypeMirror type) {
-    if (type.library().simpleName() == 'html') {
+    if (type.library().simpleName() == HTML_LIBRARY_NAME) {
       // If it's an HTML type, try to map it to a base DOM type so we can find
       // the MDN docs.
       final domTypes = _diff.htmlTypesToDom[type.qualifiedName()];
 
       // Couldn't find a DOM type.
       if ((domTypes == null) || (domTypes.length != 1)) return null;
 
       // Use the corresponding DOM type when searching MDN.
       // TODO(rnystrom): Shame there isn't a simpler way to get the one item
       // out of a singleton Set.
       type = domTypes.iterator().next();
-    } else if (type.library().simpleName() != 'dom') {
+    } else if (type.library().simpleName() != DOM_LIBRARY_NAME) {
       // Not a DOM type.
       return null;
     }
 
     final mdnType = mdn[type.simpleName()];
     if (mdnType == null) return null;
     if (mdnType['skipped'] != null) return null;
 
     // Remember which MDN page we're using so we can attribute it.
     mdnUrl = mdnType['srcUrl'];
     return mdnType['summary'];
   }
 
   /**
    * Gets the MDN-scraped docs for [member], or `null` if this type isn't
    * scraped from MDN.
    */
   includeMdnMemberComment(MemberMirror member) {
     var library = findLibrary(member);
-    if (library.simpleName() == 'html') {
+    if (library.simpleName() == HTML_LIBRARY_NAME) {
       // If it's an HTML type, try to map it to a base DOM type so we can find
       // the MDN docs.
       final domMembers = _diff.htmlToDom[member.qualifiedName()];
 
       // Couldn't find a DOM type.
       if ((domMembers == null) || (domMembers.length != 1)) return null;
 
       // Use the corresponding DOM member when searching MDN.
       // TODO(rnystrom): Shame there isn't a simpler way to get the one item
       // out of a singleton Set.
       member = domMembers.iterator().next();
-    } else if (library.simpleName() != 'dom') {
+    } else if (library.simpleName() != DOM_LIBRARY_NAME) {
       // Not a DOM type.
       return null;
     }
 
     // Ignore top-level functions.
     if (member.isTopLevel) return null;
 
     final mdnType = mdn[member.surroundingDeclaration().simpleName()];
     if (mdnType == null) return null;
     var nameToFind = member.simpleName();
@@ skipping 20 matching lines @@
     final typeName = member.surroundingDeclaration().simpleName();
     var memberName = '$typeName.${member.simpleName()}';
     if (member is MethodMirror && (member.isConstructor || member.isFactory)) {
       final separator = member.constructorName == '' ? '' : '.';
       memberName = 'new $typeName$separator${member.constructorName}';
     }
 
     return a(memberUrl(member), memberName);
   }
 }