Docgen returning a future

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. 
  * 
@@ skipping 40 matching lines @@
 markdown.Resolver linkResolver;
 
 /**
  * Docgen constructor initializes the link resolver for markdown parsing.
  * Also initializes the command line arguments. 
  * 
  * [packageRoot] is the packages directory of the directory being analyzed. 
  * If [includeSdk] is 'true', then any SDK libraries explicitly imported will 
  * also be documented. 
  * If [parseSdk] is 'true', then all Dart SDK libraries will be documented. 
  * This option is useful when only the SDK libraries are needed. 

[Emily Fortuna, 2013/07/03 20:24:40]

can we add some documentation explaining what a returned value of true means?

[janicejl, 2013/07/03 21:25:08]

Done.

  */
-void docgen(List<String> files, {String packageRoot, bool outputToYaml: true, 
-  bool includePrivate: false, bool includeSdk: false, bool parseSdk: false}) {  
+Future<bool> docgen(List<String> files, {String packageRoot, 
+    bool outputToYaml: true, bool includePrivate: false, bool includeSdk: false,
+    bool parseSdk: false}) {  
+  var docgenResult = new Completer<bool>();

[Andrei Mouravski, 2013/07/03 20:19:00]

You can do this without a completer.
Also, you don't need to catch the error.

[Andrei Mouravski, 2013/07/03 21:04:52]

Sorry, was trying to reply quickly.

You can just say something like:

Future<bool> docgen(...) {

  ...

  return getMirrorSystem(...)
    .then((...) {
      ...
      // All of this is is sync, so you can do
      return true;
    });
}

[janicejl, 2013/07/03 21:25:08]

Done.

+  
   if (packageRoot == null && !parseSdk) {
-    packageRoot = _findPackageRoot(files.first);
+    if (FileSystemEntity.typeSync(files.first) 

[Andrei Mouravski, 2013/07/03 20:19:00]

Why do you do this?

[janicejl, 2013/07/03 21:25:08]

To only pass in a directory. Before we were only searching for a package if it
was a directory. If it was a single file passed it, it assumed that it was not
part of a package. 

[Andrei Mouravski, 2013/07/03 21:27:50]

Um, okay. This code needs to be tested a bunch (not right now) but put in a
comment and a TODO.

[janicejl, 2013/07/03 21:46:45]

Done.

+        == FileSystemEntityType.DIRECTORY) {
+      packageRoot = _findPackageRoot(files.first);
+    }
   }
   logger.info('Package Root: ${packageRoot}');
   
   linkResolver = (name) => 
       fixReference(name, _currentLibrary, _currentClass, _currentMember);
   
   getMirrorSystem(files, packageRoot, parseSdk: parseSdk)
     .then((MirrorSystem mirrorSystem) {
       if (mirrorSystem.libraries.isEmpty) {
         throw new StateError('No library mirrors were created.');
       }
       _documentLibraries(mirrorSystem.libraries.values, 
           includeSdk: includeSdk, includePrivate: includePrivate, 
           outputToYaml: outputToYaml);
-    });
+    }).then((e) => docgenResult.complete(true))
+    .catchError((e) => docgenResult.complete(false));
+  
+  return docgenResult.future;
 }
 
 List<String> _listLibraries(List<String> args) {
   // TODO(janicejl): At the moment, only have support to have either one file,
   // or one directory. This is because there can only be one package directory
   // since only one docgen is created per run. 
   if (args.length != 1) throw new UnsupportedError(USAGE);
   var libraries = new List<String>();
   var type = FileSystemEntity.typeSync(args[0]);
   
@@ skipping 466 matching lines @@
     parameterMap['qualifiedname'] = qualifiedName;
     parameterMap['optional'] = isOptional.toString();
     parameterMap['named'] = isNamed.toString();
     parameterMap['default'] = hasDefaultValue.toString();
     parameterMap['type'] = type;
     parameterMap['value'] = defaultValue;
     parameterMap['annotations'] = new List.from(annotations);
     return parameterMap;
   } 
 }