Adding 'preview' to typedef

pkg/docgen/lib/docgen.dart

 // Copyright (c) 2013, 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.
 
 /// **docgen** is a tool for creating machine readable representations of Dart
 /// code metadata, including: classes, members, comments and annotations.
 ///
 /// docgen is run on a `.dart` file or a directory containing `.dart` files.
 ///
 ///      $ dart docgen.dart [OPTIONS] [FILE/DIR]
@@ skipping 699 matching lines @@
     }
   }
 
   /// Move the dartdoc-viewer code back into place for "webpage deployment."
   static void addBackViewerCode() {
     if (movedViewerCode) _dartdocViewerDir.renameSync(_dartdocViewerString);
   }
 
   /// Serve up our generated documentation for viewing in a browser.
   static void _clone() {
-    // If the viewer code is already there, then don't clone again.
-    if (_dartdocViewerDir.existsSync()) {
-      _moveDirectoryAndServe();
-    }
-    else {
-      var processResult = Process.runSync('git', ['clone', '-b', 'master',
-          'git://github.com/dart-lang/dartdoc-viewer.git'],
-          runInShell: true);
+    // TODO(16959) _moveDirectoryAndServe was removed in 32639 without cleaning
+    //             up this call.
+    // if (_dartdocViewerDir.existsSync()) {
+    //   _moveDirectoryAndServe();

[Emily Fortuna, 2014/03/05 01:35:30]

I thought you were going to add back in the function _moveDirectoryAndServe. We
definitely still want this behavior.

+    // }
 
-      if (processResult.exitCode == 0) {
-        /// Move the generated json/yaml docs directory to the dartdoc-viewer
-        /// directory, to run as a webpage.
-        var processResult = Process.runSync(_Generator._pubScript,
-            ['upgrade'], runInShell: true,
-            workingDirectory: viewerCodePath);
-        print('process output: ${processResult.stdout}');
-        print('process stderr: ${processResult.stderr}');
+    var processResult = Process.runSync('git', ['clone', '-b', 'master',
+        'git://github.com/dart-lang/dartdoc-viewer.git'],
+        runInShell: true);
 
-        var dir = new Directory(_Generator._outputDirectory == null? 'docs' :
-            _Generator._outputDirectory);
-        _webDocsDir = new Directory(path.join(viewerCodePath, 'web', 'docs'));
-        if (dir.existsSync()) {
-          // Move the docs folder to dartdoc-viewer/client/web/docs
-          dir.renameSync(_webDocsDir.path);
-        }
-      } else {
-        print('Error cloning git repository:');
-        print('process output: ${processResult.stdout}');
-        print('process stderr: ${processResult.stderr}');
+    if (processResult.exitCode == 0) {
+      /// Move the generated json/yaml docs directory to the dartdoc-viewer
+      /// directory, to run as a webpage.
+      var processResult = Process.runSync(_Generator._pubScript,
+          ['upgrade'], runInShell: true,
+          workingDirectory: viewerCodePath);
+      print('process output: ${processResult.stdout}');
+      print('process stderr: ${processResult.stderr}');
+
+      var dir = new Directory(_Generator._outputDirectory == null? 'docs' :
+          _Generator._outputDirectory);
+      _webDocsDir = new Directory(path.join(viewerCodePath, 'web', 'docs'));
+      if (dir.existsSync()) {
+        // Move the docs folder to dartdoc-viewer/client/web/docs
+        dir.renameSync(_webDocsDir.path);
       }
+    } else {
+      print('Error cloning git repository:');

[Emily Fortuna, 2014/03/05 01:35:30]

no please add back in moveDirectoryAndServe!

+      print('process output: ${processResult.stdout}');
+      print('process stderr: ${processResult.stderr}');
     }
   }
 
   static void _compile() {
     if (_webDocsDir.existsSync()) {
       // Compile the code to JavaScript so we can run on any browser.
       print('Compile app to JavaScript for viewing.');
       var processResult = Process.runSync(_Generator._dartBinary,
           ['deploy.dart'], workingDirectory: viewerCodePath, runInShell: true);
       print('process output: ${processResult.stdout}');
@@ skipping 222 matching lines @@
     return '<div class="mdn">' + content.trim() + '<p class="mdn-note">'
         '<a href="' + url.trim() + '">from Mdn</a></p></div>';
   }
 
   /// The type of this member to be used in index.txt.
   String get typeName => '';
 
   /// Creates a [Map] with this [Indexable]'s name and a preview comment.
   Map get previewMap {
     var finalMap = { 'name' : name, 'qualifiedName' : qualifiedName };
+    var preview = _preview;
+    if(preview != null) finalMap['preview'] = preview;
+    return finalMap;
+  }
+
+  String get _preview {
     if (comment != '') {
       var index = comment.indexOf('</p>');
-      finalMap['preview'] = index > 0 ?
+      return index > 0 ?
           '${comment.substring(0, index)}</p>' :
           '<p><i>Comment preview not available</i></p>';
     }
-    return finalMap;
+    return null;
   }
 
   /// Accessor to obtain the raw comment text for a given item, _without_ any
   /// of the links resolved.
   String get _commentText {
     String commentText;
     mirror.metadata.forEach((metadata) {
       if (metadata is CommentInstanceMirror) {
         CommentInstanceMirror comment = metadata;
         if (comment.isDocComment) {
@@ skipping 902 matching lines @@
   }
 
   Typedef._(TypedefMirror mirror, Library owningLibrary) :
       super(mirror, owningLibrary) {
     returnType = Indexable.getDocgenObject(mirror.referent.returnType).docName;
     generics = _createGenerics(mirror);
     parameters = _createParameters(mirror.referent.parameters, owningLibrary);
     annotations = MirrorBased._createAnnotations(mirror, owningLibrary);
   }
 
-  Map toMap() => {
-    'name': name,
-    'qualifiedName': qualifiedName,
-    'comment': comment,
-    'return': returnType,
-    'parameters': recurseMap(parameters),
-    'annotations': annotations.map((a) => a.toMap()).toList(),
-    'generics': recurseMap(generics)
-  };
+  Map toMap() {
+    var map = {
+      'name': name,
+      'qualifiedName': qualifiedName,
+      'comment': comment,
+      'return': returnType,
+      'parameters': recurseMap(parameters),
+      'annotations': annotations.map((a) => a.toMap()).toList(),
+      'generics': recurseMap(generics)
+    };
+
+    // Typedef is displayed on the library page as a class, so a preview is
+    // added manually
+    var preview = _preview;
+    if(preview != null) map['preview'] = preview;
+
+    return map;
+  }
 
   markdown.Node fixReference(String name) => null;
 
   String get typeName => 'typedef';
 
   bool _isValidMirror(DeclarationMirror mirror) => mirror is TypedefMirror;
 }
 
 /// A class containing properties of a Dart variable.
 class Variable extends OwnedIndexable {
@@ skipping 323 matching lines @@
         .map((e) => originalMirror.getField(e.simpleName).reflectee)
         .where((e) => e != null)
         .toList();
   }
 
   Map toMap() => {
     'name': Indexable.getDocgenObject(mirror, owningLibrary).docName,
     'parameters': parameters
   };
 }