commit | 0de75405f995547ce10fabee3bcbcd43cc18651d | [log] [tgz] |
---|---|---|
author | Keerti Parthasarathy <keertip@users.noreply.github.com> | Mon May 18 17:33:40 2015 -0700 |
committer | Keerti Parthasarathy <keertip@users.noreply.github.com> | Mon May 18 17:33:40 2015 -0700 |
tree | 2cbab142c0467e37358e4fedcc6fe1c33df4d576 | |
parent | 2aa09bc04efb5f61b198504c9191d3fdb0655b7b [diff] | |
parent | b9056e6bbf26697a992c37f721764f999178be17 [diff] |
Merge pull request #497 from keertip/docs generate docs in doc/api
A documentation generator for Dart. This tool produces static HTML files, produced from Dart source code.
Note: This tool is currently in alpha stage.
Run pub global activate dartdoc
to install the dartdoc
tool.
Run dartdoc
from the root directory of package. By default, the documentation is output to the docs
directory. You can use --output
to specify the output directory.
Run dartdoc
with the following command line arguments:
--dart-sdk /pathTo/dart-sdk
--sdk-docs
This new 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 this tool.
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!
Please file reports on the GitHub Issue Tracker.
It's easy to publish to pub. To bump the build version and run pub publish
, run the following:
pub global activate grinder grind publish
You can view our license here.