A documentation generator for Dart. This tool produces static HTML files, produced from Dart source code.
Note: This tool is currently in alpha stage.
pub global activate dartdoc to install the
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.
dartdoc with the following command line arguments:
sdk-readme is found in the SDK source repo. Specifically,
In the future, this file might be included in an SDK distribution (see https://code.google.com/p/dart/issues/detail?id=23203).
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. The following command will bump the build version
You can view our license here.
You can install the package from the command line:
$ pub global activate dartdoc
The package has the following executables:
Add this to your package's pubspec.yaml file:
dependencies: dartdoc: ^0.0.1+10
You can install packages from the command line:
$ pub get
Alternatively, your editor might support
Check the docs for your editor to learn more.
Now in your Dart code, you can use: