publish 0.9.7+6 (#1256)

4 files changed
tree: 1995f4882ac6a3c6ff81ee31f1afc8cf6d2117a1
  1. bin/
  2. lib/
  3. test/
  4. testing/
  5. tool/
  6. .analysis_options
  7. .gitattributes
  8. .gitignore
  9. .project
  10. .travis.yml
  11. appveyor.yml
  12. AUTHORS
  13. CHANGELOG.md
  14. CONTRIBUTING.md
  15. LICENSE
  16. pubspec.lock
  17. pubspec.yaml
  18. README.md
README.md

dartdoc

Build Status

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 (for dart:* libraries) and astashov/dartdocs.org (for libraries in pub packages).

Installing dartdoc

From the Dart SDK

Download the Dart SDK; if not already added, add the SDK's bin directory to your PATH.

From pub.dartlang.org

You can install the latest version of dartdoc with pub:

$ pub global activate dartdoc

Note: to ensure that this version is run when you type dartdoc on the command line, make sure that ~/.pub-cache/bin is on your PATH, and before the path to the Dart SDK.

Generating docs

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.

Viewing docs

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.

Link structure

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.

Writing docs

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.

Excluding from documentation

dartdoc will not generate documentation for a Dart element and its children that has the <nodoc> tag in the documentation comment.

Issues and bugs

Please file reports on the GitHub Issue Tracker.

License

Please see the dartdoc license.