dartdoc 0.0.2+1 
dartdoc: ^0.0.2+1 copied to clipboard
tools.dart.devA documentation generator for Dart.
dartdoc #
A documentation generator for Dart. This tool creates static HTML files generated from Dart source code.
Installing dartdoc #
Run pub global activate dartdoc to install dartdoc.
Running dartdoc #
Run dartdoc from the root directory of package. By default, the documentation
is geterated to the doc/api/ directory.
FAQ #
What about 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.
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!
Generating documentation for Dart SDK
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
Issues and bugs #
Please file reports on the GitHub Issue Tracker.
License #
You can view our license here.
Metadata
Publisher
Metadata
A documentation generator for Dart.
Repository (GitHub)
View/report issues
License
unknown (LICENSE)
Dependencies
analyzer, args, cli_util, html, http, intl, logging, markdown, mustache4dart, path, pub_cache, quiver, yaml
