dartdoc 0.3.0

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • --

dartdoc #

A documentation generator for Dart. This tool creates static HTML files generated from Dart source code.

Build Status Build status Coverage Status

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 generated to the doc/api/ directory.

Status #

Ready for testing, but has known issues.

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!

What does the output look like? #

You can see the latest API of dartdoc - generated by dartdoc - here.

Generating documentation for Dart SDK #

If you want to generate documentation for the SDK, run dartdoc with the following command line arguments:

  • --sdk-docs
  • --dart-sdk /pathTo/dart-sdk (optional)

Issues and bugs #

Please file reports on the GitHub Issue Tracker.

License #

You can view our license here.

0.3.0 #

  • new: left nav now animates in on mobile
  • new: white list certain libraries from the command line
  • fix: syntax highlighting of inline code
  • fix: exceptions and errors are not includes in the list of classes

0.2.2 #

  • new: show the source code for methods, functions, and constructors
  • fix: fixed an npe when generating docs for projects without readmes

0.2.1 #

  • fix: documentation for fields was sometimes null

0.2.0 #

  • fix: inconsistent heights in masthead
  • new: alphabetize lists of names
  • fix: fields w/ getters and setters were not displaying docs

0.1.0+5 #

  • show peers in left navigation bar
  • show inherited on a separate line
  • fix links to anchors
  • fix comments for properties

0.1.0+4 #

  • display only named constructor in left nav
  • do not show duplicates in implementors
  • add dart identity to page
  • left nav links to dedicated page for element

0.1.0+3 #

  • added top navigation bar
  • add left navigation section
  • package page lists libraries in left nav
  • bump version of grinder

0.1.0+2 #

  • bump version of pub_cache

0.1.0+1 #

  • remove unused dependencies (http and intl)

0.1.0 #

  • display a left-hand nav for classes and libraries
  • constants now display types in classes and libraries
  • types for properties now show on the left
  • files that act as indexes now use dash instead of underscores in their names
  • display tabs for major in-page sections

0.0.2 #

  • documenation generated in doc/api directory
  • support for readme files in plain text
  • fixed resolving references in library comments
  • generate docs even when output directory exists
  • show inherited operators
  • visually indicate deprecated api

0.0.2+1 #

  • handle packages that don't have a readme
  • fixed linking to references from other libraries in comments
  • resolve [new Constructor] in comments
  • link to exported library in comment references
  • visually show library is deprecated
  • fixed one liner documentation

0.0.2+2 #

  • add a --package-root option
  • resource handler support for package root

0.0.2+3 #

  • do not drop brackets in comments
  • replace ':' in library names with '-'
  • support multiple anonymous libraries
  • show generic information for classes
  • signature of method on same line as name
  • error if command line argument is not recognized
  • fixed href for property accesssor
  • fixed generation of docs for exported libraries

0.0.3 #

  • tweaks to margins, fonts and header
  • mobile ui improvements
  • support user defined library mapping using --url-mapping option
  • warning if library is undocumented
  • fixed linking for parameters

Use this package as an executable

1. Install it

You can install the package from the command line:


$ pub global activate dartdoc

2. Use it

The package has the following executables:


$ dartdoc

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  dartdoc: ^0.3.0

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:dartdoc/dartdoc.dart';
  
Version Uploaded Documentation Archive
0.28.2 Feb 14, 2019 Go to the documentation of dartdoc 0.28.2 Download dartdoc 0.28.2 archive
0.28.1+2 Feb 5, 2019 Go to the documentation of dartdoc 0.28.1+2 Download dartdoc 0.28.1+2 archive
0.28.1+1 Feb 4, 2019 Go to the documentation of dartdoc 0.28.1+1 Download dartdoc 0.28.1+1 archive
0.28.1 Feb 4, 2019 Go to the documentation of dartdoc 0.28.1 Download dartdoc 0.28.1 archive
0.28.0 Jan 14, 2019 Go to the documentation of dartdoc 0.28.0 Download dartdoc 0.28.0 archive
0.27.0 Jan 3, 2019 Go to the documentation of dartdoc 0.27.0 Download dartdoc 0.27.0 archive
0.26.1 Dec 13, 2018 Go to the documentation of dartdoc 0.26.1 Download dartdoc 0.26.1 archive
0.26.0 Dec 4, 2018 Go to the documentation of dartdoc 0.26.0 Download dartdoc 0.26.0 archive
0.25.0 Nov 19, 2018 Go to the documentation of dartdoc 0.25.0 Download dartdoc 0.25.0 archive
0.24.1 Oct 18, 2018 Go to the documentation of dartdoc 0.24.1 Download dartdoc 0.24.1 archive

All 111 versions...

Awaiting analysis to complete.