Removed ArgResult in lib/docgen.dart and removed top level variables.

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]
  *
  * This creates files called `docs/<library_name>.yaml` in your current 
  * working directory.
  */
 library docgen;
 
 import 'dart:io';
 import 'dart:json';
 import 'dart:async';
 
-import 'package:args/args.dart';
 import 'package:logging/logging.dart';
 import 'package:markdown/markdown.dart' as markdown;
 import 'package:pathos/path.dart' as path;
 
 import 'dart2yaml.dart';
 import 'src/io.dart';
 import '../../../sdk/lib/_internal/compiler/compiler.dart' as api;
 import '../../../sdk/lib/_internal/compiler/implementation/filenames.dart';
 import '../../../sdk/lib/_internal/compiler/implementation/mirrors/dart2js_mirror.dart'
     as dart2js;
@@ skipping 11 matching lines @@
 
 /// Current class being documented to be used for comment links.
 ClassMirror _currentClass;
 
 /// Current member being documented to be used for comment links.
 MemberMirror _currentMember;
 
 /// Resolves reference links in doc comments. 
 markdown.Resolver linkResolver;
 
-/// Package directory of directory being analyzed. 
-String packageDir;
-
-bool outputToYaml;
-bool outputToJson;
-bool includePrivate;
-/// State for whether imported SDK libraries should also be outputted.
-bool includeSdk;
-/// State for whether all SDK libraries should be outputted. 
-bool parseSdk;
+/// Package directory of directory being analyzed.
+String _packageDir;
 
 /**
  * Docgen constructor initializes the link resolver for markdown parsing.
  * Also initializes the command line arguments. 
+ *  
+ *  [includeSdk] Whether imported SDK libraries should also be outputted.

[Emily Fortuna, 2013/07/02 00:53:57]

nit -1 space here and below after the *

[Andrei Mouravski, 2013/07/02 00:58:29]

This is not the dartdoc way of talking about parameters. Instead, use sentences.

[janicejl, 2013/07/02 01:21:31]

Done.

[janicejl, 2013/07/02 01:21:31]

Done.

+ *  [parseSdk] Whether all SDK libraries should be outputted. 
  */
-void docgen(ArgResults argResults) {  
-  _setCommandLineArguments(argResults);
+void docgen(List<String> files, {String packageDir, 
+  bool outputToYaml: true, bool outputToJson: false,

[Andrei Mouravski, 2013/07/02 00:58:29]

You only need one of outputToYaml or outputToJson

[janicejl, 2013/07/02 01:21:31]

Done.

+  bool includePrivate: false, bool includeSdk: false, bool parseSdk: false}) {  
+  if (packageDir != null) {
+    logger.info('Package Root: ${packageDir}');
+    _packageDir = packageDir;
+  }
   
   linkResolver = (name) => 
       fixReference(name, _currentLibrary, _currentClass, _currentMember);
   
-  getMirrorSystem(argResults.rest).then((MirrorSystem mirrorSystem) {
-    if (mirrorSystem.libraries.values.isEmpty) {
-      throw new StateError('No Library Mirrors.');
-    }
-    _documentLibraries(mirrorSystem.libraries.values);
-  });
-}
-
-void _setCommandLineArguments(ArgResults argResults) {
-  outputToYaml = argResults['yaml'] || argResults['output-format'] == 'yaml';
-  outputToJson = argResults['json'] || argResults['output-format'] == 'json';
-  if (outputToYaml && outputToJson) {
-    throw new ArgumentError('Cannot have contradictory output flags.');
-  }
-  outputToYaml = outputToYaml || !outputToJson;
-  includePrivate = argResults['include-private'];
-  parseSdk = argResults['parse-sdk'];
-  includeSdk = parseSdk || argResults['include-sdk'];
-  packageDir = argResults['package-root'];
-  if (packageDir != null) logger.info('Package Root: ${packageDir}');
+  getMirrorSystem(files, parseSdk: parseSdk)
+      .then((MirrorSystem mirrorSystem) {
+        if (mirrorSystem.libraries.values.isEmpty) {
+          throw new StateError('No Library Mirrors.');
+        }
+        _documentLibraries(mirrorSystem.libraries.values, 
+            includeSdk: includeSdk, includePrivate: includePrivate, 
+            outputToYaml: outputToYaml, outputToJson: outputToJson);
+      });
 }
 
 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]);
   
   if (type == FileSystemEntityType.FILE) {
     libraries.add(path.absolute(args[0]));
     logger.info('Added to libraries: ${libraries.last}');
   } else {
     libraries.addAll(_listDartFromDir(args[0]));
   } 
   return libraries;
 }
 
 List<String> _listDartFromDir(String args) {
   var files = listDir(args, recursive: true);
-  if (packageDir == null) {
-    packageDir = files.firstWhere((f) => 
+  if (_packageDir == null) {
+    _packageDir = files.firstWhere((f) => 
         f.endsWith('/pubspec.yaml'), orElse: () => '');
-    if (packageDir != '') packageDir = path.dirname(packageDir) + '/packages';
-    logger.info('Package Directory: $packageDir');
+    if (_packageDir != '') {
+      _packageDir = path.dirname(_packageDir) + '/packages';
+    }
+    logger.info('Package Directory: $_packageDir');
   }
   // To avoid anaylzing package files twice, only files with paths not 
   // containing '/packages' will be added. The only exception is if the file to
   // analyze already has a '/package' in its path. 
   return files.where((f) => f.endsWith('.dart') && 
       (!f.contains('/packages') || args.contains('/packages'))).toList()
       ..forEach((lib) => logger.info('Added to libraries: $lib'));
 }
 
 List<String> _listSdk() {
   var sdk = new List<String>();
   LIBRARIES.forEach((String name, LibraryInfo info) {
     if (info.documented) { 
       sdk.add('dart:$name');
       logger.info('Add to SDK: ${sdk.last}');
     }
   });
   return sdk;
 }
 
 /**
  * Analyzes set of libraries by getting a mirror system and triggers the 
  * documentation of the libraries. 
  */
-Future<MirrorSystem> getMirrorSystem(List<String> args) {
+Future<MirrorSystem> getMirrorSystem(List<String> args, {bool parseSdk:false}) {
   var libraries = !parseSdk ? _listLibraries(args) : _listSdk();
   if (libraries.isEmpty) throw new StateError('No Libraries.');
   // DART_SDK should be set to the root of the SDK library. 
   var sdkRoot = Platform.environment['DART_SDK'];
   if (sdkRoot != null) {
     logger.info('Using DART_SDK to find SDK at $sdkRoot');
   } else {
     // If DART_SDK is not defined in the environment, 
     // assuming the dart executable is from the Dart SDK folder inside bin. 
     sdkRoot = path.dirname(path.dirname(new Options().executable));
     logger.info('SDK Root: ${sdkRoot}');
   }
   
-  return _getMirrorSystemHelper(libraries, sdkRoot, packageRoot: packageDir);
+  return _getMirrorSystemHelper(libraries, sdkRoot, packageRoot: _packageDir);
 }
 
 // TODO(janicejl): Should make docgen fail gracefully, or output a friendly
 // error message letting them know why it is failing to create a mirror system.
 // If there is conflicting library names, should modify it with a hash at the 
 // end of it's library name. 
 /**
  * Analyzes set of libraries and provides a mirror system which can be used 
  * for static inspection of the source code.
  */
@@ skipping 20 matching lines @@
         // Currently, a string is thrown when it fails to create a mirror 
         // system, and it is not possible to use the stack trace. BUG(#11622)
         // To avoid printing the stack trace. 
         exit(1);
       });
 }
 
 /**
  * Creates documentation for filtered libraries.
  */
-void _documentLibraries(List<LibraryMirror> libraries) {
+void _documentLibraries(List<LibraryMirror> libraries, 
+                        {bool includeSdk:false, bool includePrivate:false,
+                        bool outputToYaml:true, bool outputToJson:false}) {
   libraries.forEach((lib) {
     // Files belonging to the SDK have a uri that begins with 'dart:'.
     if (includeSdk || !lib.uri.toString().startsWith('dart:')) {
-      var library = generateLibrary(lib);
-      _outputLibrary(library);
+      var library = generateLibrary(lib, includePrivate: includePrivate);
+      _outputLibrary(library, outputToYaml, outputToJson);
     }
   });
   // Outputs a text file with a list of files available after creating all 
   // the libraries. This will help the viewer know what files are available 
   // to read in. 
   _writeToFile(listDir("docs").join('\n'), 'library_list.txt');
 }
 
-Library generateLibrary(dart2js.Dart2JsLibraryMirror library) {
+Library generateLibrary(dart2js.Dart2JsLibraryMirror library, 
+                        {bool includePrivate:false}) {
   _currentLibrary = library;
   var result = new Library(library.qualifiedName, _getComment(library),
-      _getVariables(library.variables), _getMethods(library.functions),
-      _getClasses(library.classes));
+      _getVariables(library.variables, includePrivate), 
+      _getMethods(library.functions, includePrivate),
+      _getClasses(library.classes, includePrivate));
   logger.fine('Generated library for ${result.name}');
   return result;
 }
 
-void _outputLibrary(Library result) {
+void _outputLibrary(Library result, bool outputToYaml, bool outputToJson) {
+  if (outputToYaml && outputToJson) {
+    throw new ArgumentError('Cannot have contradictory output flags.');

[Emily Fortuna, 2013/07/02 00:53:57]

this doesn't seem like an error. I thought the point of having these two
separate flags was so that from one run you could generate both if you wanted.
If you don't want this (which I don't really think is that beneficial) then just
have one flag and the other is the default behavior. 

Do something reasonable and document it.

[Andrei Mouravski, 2013/07/02 00:58:29]

I think you should also check this in the argParser to quickly short circuit.

[Andrei Mouravski, 2013/07/02 00:58:29]

Actually, you should only take one parameter here, an optional {bool
outputToYaml: true}

[janicejl, 2013/07/02 01:21:31]

Done.

+  }
+  outputToYaml = outputToYaml || !outputToJson;
+  
   if (outputToJson) {
     _writeToFile(stringify(result.toMap()), '${result.name}.json');
   } 
   if (outputToYaml) {
     _writeToFile(getYamlString(result.toMap()), '${result.name}.yaml');
   }
 }
 
 /**
  * Returns a list of meta annotations assocated with a mirror. 
@@ skipping 34 matching lines @@
 // TODO(tmandel): Create proper links for [_] style markdown based
 // on scope once layout of viewer is finished.
 markdown.Node fixReference(String name, LibraryMirror currentLibrary, 
     ClassMirror currentClass, MemberMirror currentMember) {
   return new markdown.Element.text('code', name);
 }
 
 /**
  * Returns a map of [Variable] objects constructed from inputted mirrors.
  */
-Map<String, Variable> _getVariables(Map<String, VariableMirror> mirrorMap) {
+Map<String, Variable> _getVariables(Map<String, VariableMirror> mirrorMap, 
+    bool includePrivate) {
   var data = {};
   mirrorMap.forEach((String mirrorName, VariableMirror mirror) {
     if (includePrivate || !mirror.isPrivate) {
       _currentMember = mirror;
       data[mirrorName] = new Variable(mirrorName, mirror.qualifiedName, 
           mirror.isFinal, mirror.isStatic, mirror.type.qualifiedName, 
           _getComment(mirror), _getAnnotations(mirror));
     }
   });
   return data;
 }
 
 /**
  * Returns a map of [Method] objects constructed from inputted mirrors.
  */
-Map<String, Method> _getMethods(Map<String, MethodMirror> mirrorMap) {
+Map<String, Method> _getMethods(Map<String, MethodMirror> mirrorMap, 
+    bool includePrivate) {
   var data = {};
   mirrorMap.forEach((String mirrorName, MethodMirror mirror) {
     if (includePrivate || !mirror.isPrivate) {
       _currentMember = mirror;
       data[mirrorName] = new Method(mirrorName, mirror.qualifiedName, 
           mirror.isSetter, mirror.isGetter, mirror.isConstructor, 
           mirror.isOperator, mirror.isStatic, mirror.returnType.qualifiedName, 
           _getComment(mirror), _getParameters(mirror.parameters), 
           _getAnnotations(mirror));
     }
   });
   return data;
 } 
 
 /**
  * Returns a map of [Class] objects constructed from inputted mirrors.
  */
-Map<String, Class> _getClasses(Map<String, ClassMirror> mirrorMap) {
+Map<String, Class> _getClasses(Map<String, ClassMirror> mirrorMap,
+    bool includePrivate) {
   var data = {};
   mirrorMap.forEach((String mirrorName, ClassMirror mirror) {
     if (includePrivate || !mirror.isPrivate) {
       _currentClass = mirror;
       var superclass = (mirror.superclass != null) ? 
           mirror.superclass.qualifiedName : '';
       var interfaces = 
           mirror.superinterfaces.map((interface) => interface.qualifiedName);
       data[mirrorName] = new Class(mirrorName, mirror.qualifiedName, 
           superclass, mirror.isAbstract, mirror.isTypedef, 
           _getComment(mirror), interfaces.toList(),
-          _getVariables(mirror.variables), _getMethods(mirror.methods), 
+          _getVariables(mirror.variables, includePrivate),
+          _getMethods(mirror.methods, includePrivate), 
           _getAnnotations(mirror));
     }
   });
   return data;
 }
 
 /**
  * Returns a map of [Parameter] objects constructed from inputted mirrors.
  */
 Map<String, Parameter> _getParameters(List<ParameterMirror> mirrorList) {
@@ skipping 220 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;
   } 
 }