Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(732)

Side by Side Diff: pkg/docgen/README.md

Issue 23003010: Appending working for library_list.json (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 7 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « no previous file | pkg/docgen/bin/docgen.dart » ('j') | pkg/docgen/lib/docgen.dart » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 docgen 1 docgen
2 ====== 2 ======
3 3
4 A documentation generator for Dart. 4 A documentation generator for Dart.
5 - - - 5 - - -
6 The docgen tool takes in a file or directory as input and produces documentation 6 The docgen tool takes in a file or directory as input and produces documentation
7 for all `.dart` file it finds as YAML or JSON files. This outputs information 7 for all `.dart` file it finds as YAML or JSON files. This outputs information
8 about all classes, variables, functions, and methods defined in the library and 8 about all classes, variables, functions, and methods defined in the library and
9 its imported libraries. 9 its imported libraries.
10 10
(...skipping 14 matching lines...) Expand all
25 YAML files can be generated using the docgen package in the dart repository. 25 YAML files can be generated using the docgen package in the dart repository.
26 26
27 ###### Usage 27 ###### Usage
28 28
29 Run `dart docgen.dart [OPTIONS] <path to directory or file>` 29 Run `dart docgen.dart [OPTIONS] <path to directory or file>`
30 30
31 ###### Options available 31 ###### Options available
32 32
33 - `-h`, `--help` Prints help and usage information. 33 - `-h`, `--help` Prints help and usage information.
34 - `-v`, `--verbose` Output more logging information. 34 - `-v`, `--verbose` Output more logging information.
35 - `-j`, `--[no-]json` Outputs to JSON. Files are outputted to YAML by default. 35 - `-j`, `--[no-]json` Outputs to JSON. Files are outputted to YAML by default.
36 If `--append` is used, it takes the file-format of the previous run stated in
37 library_list.json ignoring the flag.
36 - `--include-private` Flag to include private declarations. 38 - `--include-private` Flag to include private declarations.
37 - `--include-sdk` Flag to parse SDK Library files imported. 39 - `--include-sdk` Flag to parse SDK Library files imported.
38 - `--parse-sdk` Parses the SDK libraries only. (Ignores the path passed in.) 40 - `--parse-sdk` Parses the SDK libraries only. (Ignores the path passed in.)
39 - `--package-root` Sets the package root of the library being analyzed. 41 - `--package-root` Sets the package root of the library being analyzed.
40 - `--append` Appends to the docs folder, library_list.txt, and index.txt. 42 - `--append` Appends to the docs folder, library_list.json, and index.txt.
41 - `--introduction` Adds the provided markdown text file as the introduction 43 - `--introduction` Adds the provided markdown text file as the introduction
42 for the outputted documentation. 44 for the outputted documentation.
43 45
44 46
45 ###### Output Directory 47 ###### Output Directory
46 Documented libraries will be located at bin/docs in either YAML or JSON format 48 Documented libraries will be located at bin/docs in either YAML or JSON format
47 depending on options specified. There will also be a library_list.txt, 49 depending on options specified. There will also be a library_list.json,
48 containing a list of all the libraries inside the docs folder. 50 containing a list of all the libraries inside the docs folder.
49 51
50 To get more information on how to use the outputted documentation with 52 To get more information on how to use the outputted documentation with
51 dartdoc-viewer, please take a look at the 53 dartdoc-viewer, please take a look at the
52 [dartdoc-viewer documentation][dartdoc-viewer]. 54 [dartdoc-viewer documentation][dartdoc-viewer].
53 55
54 #### Uploading to Cloud Storage 56 #### Uploading to Cloud Storage
55 57
56 To push new files to Google Cloud Storage for use by the viewer, use the 58 To push new files to Google Cloud Storage for use by the viewer, use the
57 `gsutil` tool located at third_party/gsutil/gsutil in the Dart repository. 59 `gsutil` tool located at third_party/gsutil/gsutil in the Dart repository.
(...skipping 50 matching lines...) Expand 10 before | Expand all | Expand 10 after
108 (ex. `--options='--include-sdk files'`). 110 (ex. `--options='--include-sdk files'`).
109 2. The `--gae-sdk` option gives the absolute path to the 111 2. The `--gae-sdk` option gives the absolute path to the
110 [Google App Engine SDK][GAE]. 112 [Google App Engine SDK][GAE].
111 113
112 Running `python dartdoc.py --options=<docgen options> --gae-sdk=<path to SDK>` 114 Running `python dartdoc.py --options=<docgen options> --gae-sdk=<path to SDK>`
113 will serve files generated by `docgen.dart` in your browser. 115 will serve files generated by `docgen.dart` in your browser.
114 116
115 [dartdoc-viewer]: https://github.com/dart-lang/dartdoc-viewer "Dartdoc-Viewer" 117 [dartdoc-viewer]: https://github.com/dart-lang/dartdoc-viewer "Dartdoc-Viewer"
116 [GAE]: https://developers.google.com/appengine/downloads#Google_App_Engine_SDK_f or_Python "Google App Engine SDK for Python" 118 [GAE]: https://developers.google.com/appengine/downloads#Google_App_Engine_SDK_f or_Python "Google App Engine SDK for Python"
117 119
OLDNEW
« no previous file with comments | « no previous file | pkg/docgen/bin/docgen.dart » ('j') | pkg/docgen/lib/docgen.dart » ('J')

Powered by Google App Engine
This is Rietveld 408576698