A documentation generator for Dart.
Note: This tool is currently in alpha stage.
dartdoc from the root directory of package.
dartdoc produces HTML files as documentation for the
.dart files it finds in the package. The documentation is output to the
dartdoc with the following command line arguments:
The documentation for the SDK will be generated in the
docs folder of the current directory.
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.
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
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:
|0.28.2||Feb 14, 2019|
|0.28.1+2||Feb 5, 2019|
|0.28.1+1||Feb 4, 2019|
|0.28.1||Feb 4, 2019|
|0.28.0||Jan 14, 2019|
|0.27.0||Jan 3, 2019|
|0.26.1||Dec 13, 2018|
|0.26.0||Dec 4, 2018|
|0.25.0||Nov 19, 2018|
|0.24.1||Oct 18, 2018|