pkg/docgen/README.md - Issue 23038005: added the introduction option to the readme, and fixed the spacing on the help message for introduc…

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

Issue 23038005: added the introduction option to the readme, and fixed the spacing on the help message for introduc… (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') | no next file with comments »

OLD	NEW
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 20 matching lines...) Expand all Loading...
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 - `--include-private` Flag to include private declarations.	36 - `--include-private` Flag to include private declarations.

37 - `--include-sdk` Flag to parse SDK Library files imported.	37 - `--include-sdk` Flag to parse SDK Library files imported.

38 - `--parse-sdk` Parses the SDK libraries only. (Ignores the path passed in.)	38 - `--parse-sdk` Parses the SDK libraries only. (Ignores the path passed in.)

39 - `--package-root` Sets the package root of the library being analyzed.	39 - `--package-root` Sets the package root of the library being analyzed.

40 - `--append` Appends to the docs folder, library_list.txt, and index.txt.	40 - `--append` Appends to the docs folder, library_list.txt, and index.txt.

	41 - `--introduction` Adds the provided markdown text file as the introduction

	42 for the outputted documentation.

	43

41	44

42 ###### Output Directory	45 ###### Output Directory

43 Documented libraries will be located at bin/docs in either YAML or JSON format	46 Documented libraries will be located at bin/docs in either YAML or JSON format

44 depending on options specified. There will also be a library_list.txt,	47 depending on options specified. There will also be a library_list.txt,

45 containing a list of all the libraries inside the docs folder.	48 containing a list of all the libraries inside the docs folder.

46	49

47 To get more information on how to use the outputted documentation with	50 To get more information on how to use the outputted documentation with

48 dartdoc-viewer, please take a look at the	51 dartdoc-viewer, please take a look at the

49 [dartdoc-viewer documentation][dartdoc-viewer].	52 [dartdoc-viewer documentation][dartdoc-viewer].

50	53

(...skipping 54 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
105 (ex. `--options='--include-sdk files'`).	108 (ex. `--options='--include-sdk files'`).

106 2. The `--gae-sdk` option gives the absolute path to the	109 2. The `--gae-sdk` option gives the absolute path to the

107 [Google App Engine SDK][GAE].	110 [Google App Engine SDK][GAE].

108	111

109 Running `python dartdoc.py --options=<docgen options> --gae-sdk=<path to SDK>`	112 Running `python dartdoc.py --options=<docgen options> --gae-sdk=<path to SDK>`

110 will serve files generated by `docgen.dart` in your browser.	113 will serve files generated by `docgen.dart` in your browser.

111	114

112 [dartdoc-viewer]: https://github.com/dart-lang/dartdoc-viewer "Dartdoc-Viewer"	115 [dartdoc-viewer]: https://github.com/dart-lang/dartdoc-viewer "Dartdoc-Viewer"

113 [GAE]: https://developers.google.com/appengine/downloads#Google_App_Engine_SDK_f or_Python "Google App Engine SDK for Python"	116 [GAE]: https://developers.google.com/appengine/downloads#Google_App_Engine_SDK_f or_Python "Google App Engine SDK for Python"

114	117

OLD	NEW