commit | d9535d0019c9ec5dd92045085d828863502d64af | [log] [tgz] |
---|---|---|
author | Keerti Parthasarathy <keertip@users.noreply.github.com> | Wed Jun 03 09:42:59 2015 -0700 |
committer | Keerti Parthasarathy <keertip@users.noreply.github.com> | Wed Jun 03 09:42:59 2015 -0700 |
tree | ca25430120f6250c28a8f2e81b716172e44fff66 | |
parent | d3fa95f03fa5a98fce5c05056cdd79c3e5f9292f [diff] | |
parent | e9981b991959440ad8995c385e642aca14ef28cc [diff] |
Merge pull request #550 from keertip/windows use path separator in tests
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 geterated to the doc/api/
directory.
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!
If you want to generatr documentation for the SDK, run dartdoc
with the following command line arguments:
--dart-sdk /pathTo/dart-sdk
(optional)--sdk-docs
Please file reports on the GitHub Issue Tracker.
You can view our license here.