A documentation generator for Dart. This tool creates static HTML files generated from Dart source code.
pub global activate dartdoc to install
dartdoc from the root directory of package. By default, the documentation
is generated to the
Ready for testing, but has known issues.
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
Can I help?
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!
What does the output look like?
You can see the latest API of
dartdoc - generated by
Generating documentation for Dart SDK
If you want to generate documentation for the SDK, run
dartdoc with the
following command line arguments:
Issues and bugs
Please file reports on the GitHub Issue Tracker.
You can view our license here.