| commit | bf92a7ee5993eb29def1ea2961b1c9b7205261a8 | [log] [tgz] |
|---|---|---|
| author | Seth Ladd <sethladd@google.com> | Wed Jul 15 16:15:25 2015 -0700 |
| committer | Seth Ladd <sethladd@google.com> | Wed Jul 15 16:15:25 2015 -0700 |
| tree | de4f6e17afe96da1a1c99d7e126818258af81302 | |
| parent | 04663afc2dd3afcf078784eae30ba158f975f598 [diff] |
don't publish via grinder, just preflight
A documentation generator for Dart. This tool creates static HTML files generated from Dart source code.
Run pub global activate dartdoc to install dartdoc.
Run dartdoc from the root directory of package. By default, the documentation is generated to the doc/api/ directory.
Ready for testing, but has many known issues.
docgen / dartdocgen / dartdoc-viewer?This tool intends to replace our existing set of API documentation tools. We'll take the best ideas and implementations from our existing doc tools and fold them into dartdoc.
Yes! Start by using the tool and filing issues and requests. If you want to contribute, check out the issue tracker and see if there‘s an issue that you’re passionate about. If you want to add a new feature that's not yet in the issue tracker, start by opening an issue. Thanks!
You can see the latest API of dartdoc - generated by dartdoc - here.
If you want to generate documentation for the SDK, run dartdoc with the following command line arguments:
--sdk-docs--dart-sdk /pathTo/dart-sdk (optional)Please file reports on the GitHub Issue Tracker.
You can view our license here.