pub.dev · #1174 most downloaded on pub.dev

dartdoc

9.0.10109K downloads/modart-lang/dartdoc ↗New releases in your daily digest, changelog included.

A non-interactive HTML documentation generator for Dart source code.

Last release today
07 Oct 2026
Ships fairly regularly
a new release about every 2 months
Nearly every release is documented
notes for 60 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
12 years old
212 releases · first in 2015

Release timeline

212 releases since 2015

2015201720192021

Releases

0.20.122 Jun 2018
Remove name parameter from @animation parameter handling, with backwards compatibility
Remove name parameter from @animation parameter handling, with backwards compatibility (#1715)

Scrollbar width increased for main body text (#1711)

Make a missing FLUTTER_ROOT environment variable have a better error message (#1714)

Add a missing static resource (#1708)

Add test to make sure that static resource file is automatically rebuilt (#1708)
Open source →
0.20.030 May 2018
include and exclude are now available in dartdoc_options.yaml as supported options (#1700, #1674)
include and exclude are now available in dartdoc_options.yaml as supported options (#1700, #1674)

Support a new {@animation} directive in documentation comments to display videos in a simple player.

Fix Dart 2.0 support (#1668) and expand test coverage to include --help.
Open source →

Update package:markdown to 2.0.0, which includes many improvements – especially to the parsing of links.
Update analyzer to 0.32.0, mustache4dart to 2.1.2, and grinder for 0.8.2 for Dart 2 fixes.
Fix bug where --version printed help instead of the version number. (#1692)
Switch dartdoc_test to an integration test and add basic Dart 2.0 integration tests.
Do not crash on unversioned packages (#1688).

Open source →

0.19.02 May 2018

Build documentation through the Package object

Build documentation through the Package object (#1659)
New flag, --link-to-remote, which will cause Dartdoc to link symbols to their originating pub packages and/or the Flutter or Dart SDKs. (#739)
New configuration refactor and addition of several experimental options in dartdoc_options.yaml (see README).
Update analyzer version to 0.31.2-alpha.2 (#1682).

Open source →

0.18.026 Mar 2018

Rename category_order flag to package_order. (#1634, #1636)

Rename category_order flag to package_order. (#1634, #1636)
Use Google's CDN for jquery. (#1637)
Add the beginning of support for a dartdoc_options.yaml file. (#1638)
Code cleanups and refactoring related to packages (#1639, #1636)
Enable --preview-dart-2 in analyzer (#1630)
Add basic categorization for libraries (#1641)

Open source →

0.17.027 Feb 2018

More correctly deal with indentation inside documentation comments, fixing a set of minor markdown problems relating to indentation (like list handlin

More correctly deal with indentation inside documentation comments, fixing a set of minor markdown problems relating to indentation (like list handling) (#1608, #1507)
Strong mode enabled in dartdoc -- dartdoc will no longer read code that isn't strong-mode clean beginning with this version. (#1561)
Add a negatable flag (default on), --validate-links, to control whether Dartdoc's built-in link checker runs. (#1607)
dartdoc now works in checked mode for Flutter, fixing some edge-case navigation/canonicalization problems. (#1606)
Dartdoc now uses AnalysisDriver to build the element tree. (#1601, #1586)
Grinder now has arbitrary serving of pub packages and can compare warnings from different versions (#1600, #1599)

Open source →

0.15.116 Jan 2018

Add SDK warning comparison to grind script

Add SDK warning comparison to grind script (#1572)
Improve rendering of inline <code> (#1573)
Rename "Source Code" to "Implementation" (#1580)
Make page titles more prominent (#1581)
Detect macros declared in non-public symbols (#1584)
Const value cosmetic improvements with some restored linking (#1585)
Update to latest versions of args, resource, grinder (#1566, #1579)
Update to grinder scripts to serve flutter, SDK, and the test package locally for testing (#1570, #1578)

Open source →

0.15.07 Dec 2017Breaking

Breaking change: Major internal refactoring of public/private, type definitions, templates, and warnings. (#1524, #1539)

Breaking change: Major internal refactoring of public/private, type definitions, templates, and warnings. (#1524, #1539)
Breaking change: Allow mixins that call their super-classes. (#1555)
Breaking change: Anonymous libraries are now laid out on disk differently to avoid conflicts (#1526)
Breaking change: The meaning of --auto-include-dependencies has changed to include all libraries in any package depended on by this package (determined by the .packages file) (#1524)
Breaking change: The meaning of --include and --exclude has changed to require import paths for anonymous libraries, and accept them for other libraries. (#1524)
The Interceptor class from the SDK is now cloaked (#1524)
Type parameters for classes now appear next to them on the library page (#1558)
GFM-style tables are now supported in Dartdoc markdown (#1557, #1453)
Navigation and constructor docs now show generic types in more places (#1556, #1453)
A new parameter, --exclude-packages, now enables dartdoc to hide entire packages from --auto-include-dependencies or other --include options.
Document correct parameters for new-style generic function types (#1472)
Allow super in mixins (#1541)
Source code included with docs highlights again (#1525)
Remove constant value linking via string substitution (#1535)
Update version of mustache4dart and fix minor template errors (#1540)
Eliminate remaining places where dartdoc exposed private interfaces (#1173)
Fix private super classes appearing with dead links (#1476)
Fix resolution of generic types (#1514)
Limit width of code blocks (#1522)
Add a --json flag to providing logging in a machine-readable format. (#1531)
Use the logging package for dartdoc output. (#1518)
Remove cc commons license text from default footer (#1262)

Open source →

0.14.020 Sept 2017

Fix multiple issues with properties and top level variables in cases of split inheritance (#1394, #1116)

Fix multiple issues with properties and top level variables in cases of split inheritance (#1394, #1116)
Fix issue with generation of 'null' value enum fields (#1445)
Fix multiple issues with nodoc handling (#1352, #1337)
Use highlight js for code blocks and fix colors (#1487)
Eliminate excessive stack depth in link checker
Use preferredClass in more cases to disambiguate doc links
Add basic support and tests for MultiplyInheritedExecutableElements (#1478)

Open source →

0.13.020 Jun 2017

Fixed case where inherited members could be linked to the wrong mixin

Fixed case where inherited members could be linked to the wrong mixin (#1434)
Added broken link detection to the search index.
Avoid parsing markdown for ModelElements unless we're actually going to use the docs, speeding up generation overall by ~10% (#1417)
Add annotations to parameter documentation (#1432)
Change dartdoc style to use multiple independent scrolling columns (#1350)
Add scoring for ambiguous canonicalization, and a new comment directive, canonicalFor, to override its decisions (#1455)
Add a hidden flag to drop text in docs imported from the SDK, and use this flag in the integration test to make that test less fragile (#1457)
Add link to package homepage from index (#1460)

Open source →

0.12.023 May 2017

Generation performance improved from 20-65% on large packages (more improvement on packages with lower usage of comment references and complex inherit

Generation performance improved from 20-65% on large packages (more improvement on packages with lower usage of comment references and complex inheritance chains, like angular2).
Improvements to warnings, including indicating referring elements where possible. #1405
Enable support for generic function types. #1321
Update analyzer to 0.30. #1403
Enhancements to css style to better match dartlang.org. #1372 (partial)

Open source →

0.11.04 May 2017

Fix resolution of ambiguous classes where the analyzer can help us. #1397

Fix resolution of ambiguous classes where the analyzer can help us. #1397
Many cleanups to dartdoc stdout/stderr, error messages, and warnings:
- Display fatal errors with 'fatal error' string to distinguish them from ordinary errors
- Upgrades to new Package.warn system.
  - Fully integrated all scattered "warnings" (#1369) and added new ones for the link checker.
  - Allow for setting which warnings are errors in the library.
  - Change location output to something IntelliJ can understand and link to
  - Display location output for all warnings including line number plus column, when available from analyzer (still some bugs in our resolution). It still doesn't do code references quite right but at least gets you to the neighborhood.
  - Add a warn method to ModelElements so they can warn on themselves without help from the Package.
  - Warn correctly and squelch duplicates across doc inheritance and canonicalization almost everywhere.
  - Change --show-warnings to show all warnings, even those that might not be useful yet.
- Display a count of all warnings/errors after document generation.
- Make the progress counter tick slower.
Added a built-in link checker and orphaned file checker, and tied it into Package.warn so that when debugging dartdoc we can breakpoint and discover what about that ModelElement caused us to create the broken link. (#1380)
Fix bug where canonicalEnclosingElement could return a non-canonical Class.
Fix bug where findCanonicalModelElementFor could return a non-canonical Class.
Fix overriddenElement for Accessors to generate using enclosingCombo hint to ModelElement factory.
Fix fullyQualifiedNameWithoutLibrary when periods are part of the library name.
Add an allModelElements for Classes to support comment references.
Make allModelElements for Libraries work using Class.allModelElements recursively.
Squish some bugs related to duplicate logic for instantiating inherited class members.
- Enum and a few other places could still generate duplicate ModelElements for the same thing. This is now fixed.
- EnumField is now handled by ModelElement.from factory, fixing #1239.
- Added hints for EnumField and Accessors (index, enclosingCombo) to offload the buggy logic for figuring this out from callers to ModelElement.from.
Fix broken link generation when a canonical class's defining library isn't canonical.
Partial rewrite of GetterSetterCombo and Fields/TopLevelVariable handling
- Link correctly to generic types for Fields/TopLevelVariables.
- Use right, left, and bidirectional arrows for read-only, write-only, and read-write parameters.
Partial rewrite of comment reference system (#1391, #1285 partial)
- Handle gracefully a variety of things users try in the real world, like prefixing operators with 'operator', embedded newlines in comment references, and cases that shouldn't be considered at all (comment refs that are really array references in sample docs, etc).
- Handle canonicalization correctly for comment references: point to the right places and only to canonical elements.
- In general, warnings related to comment references should be much more useful now. (#1343)
  - Many fewer ambiguous doc reference warnings now and the ones that exist should be more easily understandable and fixable with the new warning message.
  - Understand references to parameters even though we don't do anything useful with them just yet
  - Generics outside square brackets (#1250) are now warned with better context information that takes newlines into account, but there are so many of them in complex packages like Flutter that we still only show those with --show-warnings.
- Cache the traversal of allModelElements.
- Change handling of enum constant linking in codeRefs to work properly, though warnings about that aren't right in some edge cases still.
- Only use analyzer resolving of commentRefs as a last resort since they don't take dartdoc canonicalization into account.
Added a new --footer-text command-line option, to allow adding additional text in the package name and copyright section of the footer.
Reduced stack depth by not recomputing findCanonicalLibraryFor. (#1381)
Workaround for (#1367) forces on enableAssertInitializer.
Work around analyzer-0.29 bug where embedded SDK uri's aren't properly reversed.

Open source →

0.10.017 Apr 2017

fix canonicalization problems and related issues introduced or not addressed in 0.9.11, including:

fix canonicalization problems and related issues introduced or not addressed in 0.9.11, including:
- (#1361), (#1232), (#1239 (partial))- Broken links in enums
- (#1345) and (#1090)- Reexports have wrong links in many places
- (#1341), (#1197 (partial)) - Duplicate docs still in some cases
- (#1334) - Some classes don't list their subclasses
- Inheritable class members had incorrect canonicalization in many cases
- ... and many other unfiled bugs relating to inheritance and duplicate files.
Dartdoc no longer creates documentation for a given identifier more than once. This means dartdoc is 20-30% faster on complex packages.
--auto-include-dependencies is now recursive past one layer (#589) It now drills all the way down and will dive into the SDK and other packages.
Change display of warnings to be more consistent; warnings now always go to stderr and are printed on their own line.
Dartdoc now warns when it is unable to find a canonical object to link to
Dartdoc now warns if a package exports an identifier so that it is ambiguous which one should be treated as canonical
Dartdoc now has a number of asserts in checked mode for issues solved and as-yet-unsolved, including (#1367) or canonicalization problems; try running in checked mode if you see structural problems in generated docs and see if an assert fires.
Dartdoc internals have changed significantly:
- Package now owns the calculation of recursive dependencies with a factory constructor, Package.withAutoincludedDependencies.
- ModelElements and Libraries now have Package-scoped caches.
- ModelElements and their subclasses now must be constructed from a single factory, ModelElements.from
- Package has new methods to assist canonicalization, including findCanonicalLibraryFor and findCanonicalModelElementFor.
- New mixin "Inheritable" helps class members calculate canonicalization for inheritable members
change order of library, class, and enum members on displayed pages (#1323).
change order of categories when using --use-categories, prioritizing this package first, the SDK second, packages with this package's name embedded third, and finally all other packages. A new flag, --category-order, lets you change what order categories appear in. (#1323)
fix broken masthead links in enums (#1225).

Open source →

0.9.133 Apr 2017

fix grind check-links and check-sdk-links

fix grind check-links and check-sdk-links (#1360)
fix multiple issues in annotation/feature list handling (#1268, #1162, #1081)
Added pretty-index-json command line flag.
index.json file entries are now sorted.

Open source →

0.9.1013 Jan 2017

de-emphasize and resort the inherited members

de-emphasize and resort the inherited members (#641)
fix bug with showing parameterized typdefs in return types of properties (#1263)
add macros support, to help reuse documentation (#1264)
de-emphasize reexported symbols in generated docs (#1158)
fix for angular2 docs generation (#1315)
generate warnings for generics not in [] in the documentation (#1250)
Add support for stripping schema from display text for urls defined with brackets (#1147)

Open source →

0.9.927 Dec 2016

resolve non-imported symbols in comments (#1153) - thanks @astashov!

resolve non-imported symbols in comments (#1153) - thanks @astashov!
support @example insertion of .md file fragments (#1105) - thanks @chalin!
go to the first suggestion in the search field on enter (#1149)
rank parent class method higher than its overrides in search suggestions (#896)
fix double props when inherited from parameterized class (#1228)
add showing docs of overridden accessors (#1266)

Open source →

0.9.7+46 Sept 2016

fixed an issue with documenting libraries starting with packages

fixed an issue with documenting libraries starting with packages
upgraded our dependency on html to 0.13.0
upgraded our dependency on package_config and markdown

Open source →

0.9.722 Jul 2016

fix the display of long constants

fix the display of long constants
fixed an issue with duplicate libraries in SDK
show source code for more element types
fix for issue with references in parameters and return type pointing to wrong element with same name
updated to a new verion of the markdown library
fix signatures for functions with typedef params (#1137)
make dartdoc strong-mode clean (#1205)
fix an issue w/ references in dartdoc not being hyperlinked
show 'abstract' for methods that are abstract
show the full value of enums
cleanup bin/dartdoc to use public dartdoc API (#1199)
add contribution instructions

Open source →

0.9.620 Jun 2016

[bug] fix enum indexes (#1176).

[bug] fix enum indexes (#1176).
[enhancement] added support for crossdart. If there is a crossdart.json file in the input dir (which can be generated by Crossdart), it will use that file to add links to crossdart.info in the source code block.

Open source →

0.9.53 May 2016Deprecated

[enhancement] do not document if there is a @nodoc in the doc comment. NOTE: <nodoc> is now deprecated and will be removed in a later version.

[enhancement] support for @example tag to inject sample code into comments. eg. {@example core/ts/bootstrap/bootstrap.dart region='bootstrap'}, where path is path to source in the package examples directory, and region is specified by #docregion and #enddocregion in the file.
[enhancement] do not document if there is a @nodoc in the doc comment. NOTE: <nodoc> is now deprecated and will be removed in a later version.

Open source →

0.9.412 Apr 2016

[enhancement] added a --favicon option to specify a favicon to use for the generated docs

[enhancement] added a --favicon option to specify a favicon to use for the generated docs
[enhancement] added a --use-categories flag to groups libraries into source packages in the overview page and the left-hand side navigation panel

Open source →

0.9.35 Apr 2016

[enhancement] added support for URL-based search. If a query parameter named "search" is passed, the page navigates to the first search result for its

[enhancement] added support for URL-based search. If a query parameter named "search" is passed, the page navigates to the first search result for its value.
[enhancement] added support for passing more than one --header or --footer
[enhancement] added the ability to include libraries referenced by (but not directly inside) the project (--include-external)
[bug] rev the analyzer version used to fix an issue generating docs for Flutter

Open source →

0.9.28 Mar 2016

[bug] do not generate docs for dart:_internal and dart:nativewrappers, when defined in the _embedder.yaml file.

[bug] do not generate docs for dart:_internal and dart:nativewrappers, when defined in the _embedder.yaml file.
[enhancement] print message to run pub if dartdoc does not find any libraries to document.

Open source →

0.9.017 Feb 2016

BREAKING works with Dart SDK 1.14.0 and above

BREAKING works with Dart SDK 1.14.0 and above
[health] use package resource
[enhancement] add support for packages with _embedder.yaml
[bug] fix generating docs when input == '.'
[bug] modify showing constants so that there is no double const shown in value.

Open source →

0.8.49 Dec 2015Deprecated

[bug] Fixed the display of deprecated properties.

[enhancement] Only include generator metadata in the package index.html file.
[bug] Fixed the display of deprecated properties.
[bug] show generics for typedefs
[bug] cleanly unzip docs on Mac
[health] upgrade to latest analyzer package

Open source →

0.8.120 Nov 2015Deprecated

[bug] Show deprecated libraries the same way in both package and library view.

[bug] No longer includes <base> element in the package root.
[bug] Eliminates a number of empty class attributes.
[bug] Show deprecated libraries the same way in both package and library view.
[bug] Process readme.md Markdown with the process that is used in document comments.

Open source →

0.8.09 Nov 2015

[bug] fix annotation shown as raw HTML in constructors

[bug] fix annotation shown as raw HTML in constructors
[bug] fix missing return type when Future
[enhancement] do not show "Not documented." message for members without doc comments
[enhancement] show constructors before properties in right side bar
[enhancement] sort names with embedded integers lexicographically
BREAKING initGenerators is now async. It returns Future<List<Generator>>.
BREAKING markdown_processor.dart and resource_loader.dart are no longer exposed as public libraries. Use of these libraries by third-party code is no longer supported.
BREAKING generator.dart is no longer exposed as a stand-alone library. You can access the Generator class by importing dartdoc.dart.

Open source →

0.7.321 Oct 2015

[bug] Add missing close span in accessor setter template

[bug] Add missing close span in accessor setter template
[enhancement] Print usage if an invalid argument is provided
[enhancement] Improve the output of asynchronous stack traces when an unhandled exception is thrown
[health] removed doc uploads to firebase
[bug] fixed incorrect 'link to Crossdart' links
[health] upgraded packages, modified pubspec.lock

Open source →

0.7.112 Oct 2015

[enhancement] restore the method signature at the top of method/ctor/function/operator pages

[enhancement] restore the method signature at the top of method/ctor/function/operator pages
[enhancement] search using fully qualified names
[enhancement] better messaging when library itself lacks comments
[enhancement] indicate when a class is an abstract class
[enhancement] indicate when a constructor is a factory constructor

Open source →

0.7.030 Sept 2015

[feature] --add-crossdart flag to add links to http://crossdart.info in the source code section

[feature] --add-crossdart flag to add links to http://crossdart.info in the source code section
[bug] show type information for Map with generics
[bug] show methods/properties inherited from Object
[health] remove --url-mappings option, the analyzer picks up SDK extensions from the package
[style] changed how we display constant values

Open source →

0.6.522 Sept 2015

[new] --rel-canonical-prefix to help with SEO for many versions of the same docs

[new] --rel-canonical-prefix to help with SEO for many versions of the same docs
[bug] fixed linking in the SDK docs
[enhancement] do not display comments with actual source code
[enhancement] show source code for constructors
[style] tweaks to the footer
[health] re-enable uploading dartdoc docs to firebase

Open source →