OLD | NEW |
1 // Copyright (c) 2013, the Dart project authors. Please see the AUTHORS file | 1 // Copyright (c) 2013, 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 /// **docgen** is a tool for creating machine readable representations of Dart | 5 /// **docgen** is a tool for creating machine readable representations of Dart |
6 /// code metadata, including: classes, members, comments and annotations. | 6 /// code metadata, including: classes, members, comments and annotations. |
7 /// | 7 /// |
8 /// docgen is run on a `.dart` file or a directory containing `.dart` files. | 8 /// docgen is run on a `.dart` file or a directory containing `.dart` files. |
9 /// | 9 /// |
10 /// $ dart docgen.dart [OPTIONS] [FILE/DIR] | 10 /// $ dart docgen.dart [OPTIONS] [FILE/DIR] |
(...skipping 26 matching lines...) Expand all Loading... |
37 /// simple server to view the documentation. | 37 /// simple server to view the documentation. |
38 /// | 38 /// |
39 /// Returned Future completes with true if document generation is successful. | 39 /// Returned Future completes with true if document generation is successful. |
40 Future<bool> docgen(List<String> files, {String packageRoot, | 40 Future<bool> docgen(List<String> files, {String packageRoot, |
41 bool includePrivate: false, bool includeSdk: false, bool parseSdk: false, | 41 bool includePrivate: false, bool includeSdk: false, bool parseSdk: false, |
42 String introFileName: '', String out: gen.DEFAULT_OUTPUT_DIRECTORY, | 42 String introFileName: '', String out: gen.DEFAULT_OUTPUT_DIRECTORY, |
43 List<String> excludeLibraries: const [], | 43 List<String> excludeLibraries: const [], |
44 bool includeDependentPackages: false, bool compile: false, | 44 bool includeDependentPackages: false, bool compile: false, |
45 bool serve: false, bool noDocs: false, String startPage, | 45 bool serve: false, bool noDocs: false, String startPage, |
46 String pubScript : 'pub', String dartBinary: 'dart', | 46 String pubScript : 'pub', String dartBinary: 'dart', |
47 bool indentJSON: false}) { | 47 bool indentJSON: false, String sdk}) { |
48 var result; | 48 var result; |
49 if (!noDocs) { | 49 if (!noDocs) { |
50 viewer.ensureMovedViewerCode(); | 50 viewer.ensureMovedViewerCode(); |
51 result = gen.generateDocumentation(files, packageRoot: packageRoot, | 51 result = gen.generateDocumentation(files, packageRoot: packageRoot, |
52 includePrivate: includePrivate, | 52 includePrivate: includePrivate, |
53 includeSdk: includeSdk, parseSdk: parseSdk, | 53 includeSdk: includeSdk, parseSdk: parseSdk, |
54 introFileName: introFileName, out: out, | 54 introFileName: introFileName, out: out, |
55 excludeLibraries: excludeLibraries, | 55 excludeLibraries: excludeLibraries, |
56 includeDependentPackages: includeDependentPackages, | 56 includeDependentPackages: includeDependentPackages, |
57 startPage: startPage, pubScriptValue: pubScript, | 57 startPage: startPage, pubScriptValue: pubScript, |
58 dartBinaryValue: dartBinary, indentJSON: indentJSON); | 58 dartBinaryValue: dartBinary, indentJSON: indentJSON, sdk: sdk); |
59 viewer.addBackViewerCode(); | 59 viewer.addBackViewerCode(); |
60 if (compile || serve) { | 60 if (compile || serve) { |
61 result.then((success) { | 61 result.then((success) { |
62 if (success) { | 62 if (success) { |
63 viewer.createViewer(serve); | 63 viewer.createViewer(serve); |
64 } | 64 } |
65 }); | 65 }); |
66 } | 66 } |
67 } else if (compile || serve) { | 67 } else if (compile || serve) { |
68 gen.pubScript = pubScript; | 68 gen.pubScript = pubScript; |
69 gen.dartBinary = dartBinary; | 69 gen.dartBinary = dartBinary; |
70 viewer.createViewer(serve); | 70 viewer.createViewer(serve); |
71 } | 71 } |
72 return result; | 72 return result; |
73 } | 73 } |
OLD | NEW |