commit | 1b1ee38b50b4d6658d46c8b5961916362aa35779 | [log] [tgz] |
---|---|---|
author | jcollins-g <jcollins@google.com> | Tue Jun 20 13:46:51 2017 -0700 |
committer | GitHub <noreply@github.com> | Tue Jun 20 13:46:51 2017 -0700 |
tree | e47fb771c02381979f26c86f786fac60aa02c7f4 | |
parent | 6fd2365f8753edc56fcbf12b9eb3304d4ff386d5 [diff] |
Fix broken package and stop grinder from doing this to us again (#1464) * Fix broken package and stop grinder from doing this to us again * update version * Change to minor update
Use dartdoc
to generate HTML documentaton for your Dart package.
For information about contributing to the dartdoc project, see the contributor docs.
For issues/details related to hosted Dart API docs, see dart-lang/api.dartlang.org.
bin
directory to your PATH
Run dartdoc
from the root directory of package. For example:
$ dartdoc Generating documentation for 'server_code_lab' into <path-to-server-code-lab>/server_code_lab/doc/api/ parsing lib/client/piratesapi.dart... parsing lib/common/messages.dart... parsing lib/common/utils.dart... parsing lib/server/piratesapi.dart... Parsed 4 files in 8.1 seconds. generating docs for library pirate.messages from messages.dart... generating docs for library pirate.server from piratesapi.dart... generating docs for library pirate.utils from utils.dart... generating docs for library server_code_lab.piratesApi.client from piratesapi.dart... Documented 4 libraries in 9.6 seconds. Success! Docs generated into <path-to-server-code-lab>/server_code_lab/doc/api/index.html
By default, the documentation is generated to the doc/api
directory as static HTML files.
Run dartdoc -h
to see the available command-line options.
You can view the generated docs directly from the file system, but if you want to use the search function, you must load them with an HTTP server.
An easy way to run an HTTP server locally is to use the dhttpd
package. For example:
$ pub global activate dhttpd $ dhttpd --path doc/api
Navigate to http://localhost:8080
in your browser; the search function should now work.
dartdoc produces static files with a predictable link structure.
index.html # homepage index.json # machine-readable index library-name/ # : is turned into a - e.g. dart:core => dart-core ClassName-class.html # "homepage" for a class (and enum) ClassName/ ClassName.html # constructor ClassName.namedConstructor.html # named constructor method.html property.html CONSTANT.html property.html top-level-function.html
File names are case-sensitive.
Check out the Effective Dart: Documentation guide.
The guide covers formatting, linking, markup, and general best practices when authoring doc comments for Dart with dartdoc
.
dartdoc
will not generate documentation for a Dart element and its children that have the @nodoc
tag in the documentation comment.
You can specify “macros”, i.e. reusable pieces of documentation. For that, first specify a template anywhere in the comments, like:
/// {@template template_name} /// Some shared docs /// {@endtemplate}
and then you can insert it via {@macro template_name}
, like
/// Some comment /// {@macro template_name} /// More comments
If --auto-include-dependencies
flag is provided, dartdoc tries to automatically add all the used libraries, even from other packages, to the list of the documented libraries.
Please file reports on the GitHub Issue Tracker. Issues are labeled with priority based on how much impact to the ecosystem the issue addresses and the number of generated pages that show the anomaly (widespread vs. not widespread).
Some examples of likely triage priorities:
P0
P1
P2
P3
Please see the dartdoc license.