add disqus comments

lib/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 10 matching lines @@
 #import('../../frog/lang.dart');
 #import('../../frog/file_system.dart');
 #import('../../frog/file_system_vm.dart');
 #import('classify.dart');
 #import('markdown.dart', prefix: 'md');
 
 #source('comment_map.dart');
 #source('utils.dart');
 
 /**
- * Generates completely static HTML containing everything you need to browse
- * the docs. The only client side behavior is trivial stuff like syntax
- * highlighting code.
- */
-final MODE_STATIC = 0;
-
-/**
- * Generated docs do not include baked HTML navigation. Instead, a single
- * `nav.json` file is created and the appropriate navigation is generated
- * client-side by parsing that and building HTML.
- *
- * This dramatically reduces the generated size of the HTML since a large
- * fraction of each static page is just redundant navigation links.
- *
- * In this mode, the browser will do a XHR for nav.json which means that to
- * preview docs locally, you will need to enable requesting file:// links in
- * your browser or run a little local server like `python -m SimpleHTTPServer`.
- */
-final MODE_LIVE_NAV = 1;
-
-/**
  * Run this from the `lib/dartdoc` directory.
  */
 void main() {
   final args = new Options().arguments;
 
   // Parse the dartdoc options.
   bool includeSource;
-  String mode;
+  int mode;
   String outputDir;
 
   for (int i = 0; i < args.length - 1; i++) {
     final arg = args[i];
 
     switch (arg) {
       case '--no-code':
         includeSource = false;
         break;
 
       case '--mode=static':
-        mode = MODE_STATIC;
+        mode = Dartdoc.MODE_STATIC;
         break;
 
       case '--mode=live-nav':
-        mode = MODE_LIVE_NAV;
+        mode = Dartdoc.MODE_LIVE_NAV;
         break;
 
       default:
         if (arg.startsWith('--out=')) {
           outputDir = arg.substring('--out='.length);
         } else {
           print('Unknown option: $arg');
           return;
         }
         break;
@@ skipping 17 matching lines @@
 
   final dartdoc = new Dartdoc();
 
   if (includeSource != null) dartdoc.includeSource = includeSource;
   if (mode != null) dartdoc.mode = mode;
   if (outputDir != null) dartdoc.outputDir = outputDir;
 
   cleanOutputDirectory(dartdoc.outputDir);
 
   // Compile the client-side code to JS.
-  final clientScript = (dartdoc.mode == MODE_STATIC) ? 'static' : 'live-nav';
+  final clientScript = (dartdoc.mode == Dartdoc.MODE_STATIC) ? 'static' : 'live-nav';
   compileScript(compilerPath, libDir, '$scriptDir/client-$clientScript.dart',
                '${dartdoc.outputDir}/client-$clientScript.js');
 
   copyFiles('$scriptDir/static', dartdoc.outputDir);
 
   dartdoc.document(entrypoint);
 
   print('Documented ${dartdoc._totalLibraries} libraries, ' +
       '${dartdoc._totalTypes} types, and ' +
       '${dartdoc._totalMembers} members.');
@@ skipping 51 matching lines @@
 void compileScript(String compilerPath, String libDir,
     String dartPath, String jsPath) {
   final process = new Process.start(compilerPath, [
     '--libdir=$libDir', '--out=$jsPath',
     '--compile-only', '--enable-type-checks', '--warnings-as-errors',
     dartPath]);
 
   process.stdout.pipe(stdout, close: false);
 
   process.onError = (error) {
-    print('Failed to compile $dartPath. Error:');
+    print('Failed to compile $dartPath with $compilerPath. Error:');
     print(error);
   };
 }
 
 class Dartdoc {
+

[Bob Nystrom, 2012/03/28 20:01:21]

Why move these here?

[sethladd, 2012/03/28 21:52:17]

Good question, I think I was trying something else and then abandoned the path.

+  /**
+   * Generates completely static HTML containing everything you need to browse
+   * the docs. The only client side behavior is trivial stuff like syntax
+   * highlighting code.
+   */
+  static final MODE_STATIC = 0;
+
+  /**
+   * Generated docs do not include baked HTML navigation. Instead, a single
+   * `nav.json` file is created and the appropriate navigation is generated
+   * client-side by parsing that and building HTML.
+   *
+   * This dramatically reduces the generated size of the HTML since a large
+   * fraction of each static page is just redundant navigation links.
+   *
+   * In this mode, the browser will do a XHR for nav.json which means that to
+   * preview docs locally, you will need to enable requesting file:// links in
+   * your browser or run a little local server like `python -m SimpleHTTPServer`.
+   */
+  static final MODE_LIVE_NAV = 1;
+
   /** Set to `false` to not include the source code in the generated docs. */
   bool includeSource = true;
 
   /**
    * Dartdoc can generate docs in a few different ways based on how dynamic you
    * want the client-side behavior to be. The value for this should be one of
    * the `MODE_` constants.
    */
   int mode = MODE_LIVE_NAV;
 
@@ skipping 16 matching lines @@
    * this is `null` then no search box will be shown.
    */
   String searchEngineId = null;
 
   /* The URL that the embedded search results should be displayed on. */
   String searchResultsUrl = 'results.html';
 
   /** Set this to add footer text to each generated page. */
   String footerText = '';
 
+  /** Set this to add content before the footer */
+  String preFooterText = '';
+
   /**
    * From exposes the set of libraries in `world.libraries`. That maps library
    * *keys* to [Library] objects. The keys are *not* exactly the same as their
    * names. This means if we order by key, we won't actually have them sorted
    * correctly. This list contains the libraries in correct order by their
    * *name*.
    */
   List<Library> _sortedLibraries;
 
   CommentMap _comments;
@@ skipping 42 matching lines @@
 
       world.resolveAll();
 
       // Sort the libraries by name (not key).
       _sortedLibraries = world.libraries.getValues();
       _sortedLibraries.sort((a, b) {
         return a.name.toUpperCase().compareTo(b.name.toUpperCase());
       });
 
       // Generate the docs.
-      if (mode == MODE_LIVE_NAV) docNavigationJson();
+      if (mode == Dartdoc.MODE_LIVE_NAV) docNavigationJson();
 
       docIndex();
       for (final library in _sortedLibraries) {
         docLibrary(library);
       }
     } finally {
       options.dietParse = oldDietParse;
     }
   }
 
@@ skipping 86 matching lines @@
     }
 
     writeln('</div>');
 
     docNavigation();
     writeln('<div class="content">');
   }
 
   String get clientScript() {
     switch (mode) {
-      case MODE_STATIC:   return 'client-static';
-      case MODE_LIVE_NAV: return 'client-live-nav';
+      case Dartdoc.MODE_STATIC:   return 'client-static';
+      case Dartdoc.MODE_LIVE_NAV: return 'client-live-nav';
       default: throw 'Unknown mode $mode.';
     }
   }
 
   void writeHeadContents(String title) {
     writeln(
         '''
         <meta charset="utf-8">
         <title>$title</title>
         <link rel="stylesheet" type="text/css"
-            href="${relativePath('styles.css')}" />
+            href="${relativePath('styles.css')}">
         <link href="http://fonts.googleapis.com/css?family=Open+Sans:400,600,700,800" rel="stylesheet" type="text/css">
-        <link rel="shortcut icon" href="${relativePath('favicon.ico')}" />
-        <script src="${relativePath('$clientScript.js')}"></script>
+        <link rel="shortcut icon" href="${relativePath('favicon.ico')}">
         ''');
   }
 
   void writeFooter() {
     writeln(
         '''
         </div>
         <div class="clear"></div>
         </div>
+        ${preFooterText}
         <div class="footer">$footerText</div>
+        <script async src="${relativePath('$clientScript.js')}"></script>

[Bob Nystrom, 2012/03/28 20:01:21]

\o/

[sethladd, 2012/03/28 21:52:17]

Done.

         </body></html>
         ''');
   }
 
   void docIndex() {
     startFile('index.html');
 
     writeHeader(mainTitle, []);
 
     writeln('<h2>$mainTitle</h2>');
@@ skipping 42 matching lines @@
 
     libraries[library.name] = types;
   }
 
   void docNavigation() {
     writeln(
         '''
         <div class="nav">
         ''');
 
-    if (mode == MODE_STATIC) {
+    if (mode == Dartdoc.MODE_STATIC) {
       for (final library in _sortedLibraries) {
         write('<h2><div class="icon-library"></div>');
 
         if ((_currentLibrary == library) && (_currentType == null)) {
           write('<strong>${library.name}</strong>');
         } else {
           write('${a(libraryUrl(library), library.name)}');
         }
         write('</h2>');
 
@@ skipping 777 matching lines @@
 
     return new md.Element.text('code', name);
   }
 
   // TODO(rnystrom): Move into SourceSpan?
   int getSpanColumn(SourceSpan span) {
     final line = span.file.getLine(span.start);
     return span.file.getColumn(line, span.start);
   }
 }