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

Unified 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 side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | pkg/docgen/bin/docgen.dart » ('j') | pkg/docgen/lib/docgen.dart » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: pkg/docgen/README.md
diff --git a/pkg/docgen/README.md b/pkg/docgen/README.md
index 24ba58a17f85c922140bdb6f63af1bc49ae0e59e..66d0a4639d7a681d20f63c87758265e2c5fb4c67 100644
--- a/pkg/docgen/README.md
+++ b/pkg/docgen/README.md
@@ -32,19 +32,21 @@ Run `dart docgen.dart [OPTIONS] <path to directory or file>`
- `-h`, `--help` Prints help and usage information.
- `-v`, `--verbose` Output more logging information.
-- `-j`, `--[no-]json` Outputs to JSON. Files are outputted to YAML by default.
+- `-j`, `--[no-]json` Outputs to JSON. Files are outputted to YAML by default.
+If `--append` is used, it takes the file-format of the previous run stated in
+library_list.json ignoring the flag.
- `--include-private` Flag to include private declarations.
- `--include-sdk` Flag to parse SDK Library files imported.
- `--parse-sdk` Parses the SDK libraries only. (Ignores the path passed in.)
- `--package-root` Sets the package root of the library being analyzed.
-- `--append` Appends to the docs folder, library_list.txt, and index.txt.
+- `--append` Appends to the docs folder, library_list.json, and index.txt.
- `--introduction` Adds the provided markdown text file as the introduction
for the outputted documentation.
###### Output Directory
Documented libraries will be located at bin/docs in either YAML or JSON format
-depending on options specified. There will also be a library_list.txt,
+depending on options specified. There will also be a library_list.json,
containing a list of all the libraries inside the docs folder.
To get more information on how to use the outputted documentation with
« 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