| OLD | NEW |
| 1 // Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file | 1 // Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file |
| 2 // for details. All rights reserved. Use of this source code is governed by a | 2 // for details. All rights reserved. Use of this source code is governed by a |
| 3 // BSD-style license that can be found in the LICENSE file. | 3 // BSD-style license that can be found in the LICENSE file. |
| 4 | 4 |
| 5 /** | 5 /** |
| 6 * To generate docs for a library, run this script with the path to an | 6 * To generate docs for a library, run this script with the path to an |
| 7 * entrypoint .dart file, like: | 7 * entrypoint .dart file, like: |
| 8 * | 8 * |
| 9 * $ dart dartdoc.dart foo.dart | 9 * $ dart dartdoc.dart foo.dart |
| 10 * | 10 * |
| 11 * This will create a "docs" directory with the docs for your libraries. To | 11 * This will create a "docs" directory with the docs for your libraries. To |
| 12 * create these beautiful docs, dartdoc parses your library and every library | 12 * create these beautiful docs, dartdoc parses your library and every library |
| 13 * it imports (recursively). From each library, it parses all classes and | 13 * it imports (recursively). From each library, it parses all classes and |
| 14 * members, finds the associated doc comments and builds crosslinked docs from | 14 * members, finds the associated doc comments and builds crosslinked docs from |
| 15 * them. | 15 * them. |
| 16 */ | 16 */ |
| 17 library dartdoc; | 17 library dartdoc; |
| 18 | 18 |
| 19 import 'dart:io'; | 19 import 'dart:io'; |
| 20 import 'dart:async'; |
| 20 | 21 |
| 21 // TODO(rnystrom): Use "package:" URL (#4968). | 22 // TODO(rnystrom): Use "package:" URL (#4968). |
| 22 import '../lib/dartdoc.dart'; | 23 import '../lib/dartdoc.dart'; |
| 23 import '../../../../../pkg/args/lib/args.dart'; | 24 import '../../../../../pkg/args/lib/args.dart'; |
| 24 | 25 |
| 25 /** | 26 /** |
| 26 * Run this from the `lib/_internal/dartdoc` directory. | 27 * Run this from the `lib/_internal/dartdoc` directory. |
| 27 */ | 28 */ |
| 28 main() { | 29 main() { |
| 29 // Need this because ArgParser.getUsage doesn't show command invocation. | 30 // Need this because ArgParser.getUsage doesn't show command invocation. |
| (...skipping 189 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 219 Future compiled = compileScript(dartdoc.mode, dartdoc.outputDir, libPath); | 220 Future compiled = compileScript(dartdoc.mode, dartdoc.outputDir, libPath); |
| 220 Future filesCopied = copyDirectory(scriptDir.append('../static'), | 221 Future filesCopied = copyDirectory(scriptDir.append('../static'), |
| 221 dartdoc.outputDir); | 222 dartdoc.outputDir); |
| 222 | 223 |
| 223 Futures.wait([compiled, filesCopied]).then((_) { | 224 Futures.wait([compiled, filesCopied]).then((_) { |
| 224 dartdoc.cleanup(); | 225 dartdoc.cleanup(); |
| 225 print('Documented ${dartdoc.totalLibraries} libraries, ' | 226 print('Documented ${dartdoc.totalLibraries} libraries, ' |
| 226 '${dartdoc.totalTypes} types, and ${dartdoc.totalMembers} members.'); | 227 '${dartdoc.totalTypes} types, and ${dartdoc.totalMembers} members.'); |
| 227 }); | 228 }); |
| 228 } | 229 } |
| OLD | NEW |