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

dartdoc

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

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

Last release 1 months ago
10 Aug 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
211 releases · first in 2015

Release timeline

211 releases since 2015

2015201720192021

Releases

1.0.15 Aug 2021
Fix several issues with new type hierarchy. (#2714, #2721)
Fix several issues with new type hierarchy. (#2714, #2721)

Allow code in "diff" language to be syntax highlighted. (#2718)
Open source →
1.0.029 Jun 2021Breaking
BREAKING CHANGE: Enable the enhanced lookups by default. Some formerly invalid doc references will no longer be ignored and now generate warnings, and…
BREAKING CHANGE: Enable the enhanced lookups by default. Some formerly invalid doc references will no longer be ignored and now generate warnings, and some ambiguous references may change where they point to. As a fallback, allow a --no-enhanced-reference-lookup but this will be removed soon so please file bugs if you need to use this. (#2705)

Use the Mustachio AOT compiler for default templates. (#2677)

Unhide the --format option so users can discover the markdown support (#2703)

Internal refactors of tool/dartdoc code. (#2686, 2669)

Many changes to improve compliance on the new lookup code. (#2709, #2707, #2706, #2703, #2702, #2700, #2691, #2687, #2684, #2682, #2673, #2672, #2671)

Update favicon to match dart.dev. (#2681)

Runtime and AOT renderer fixes for Mustachio. (#2697, #2674, #2676, #2670, #2697)

Fix several problems with head analyzer. (#2680, #2687)

The favicon has been updated to match dart.dev. (#2681)

A variety of internal refactoring changes.

One column per quarter.

0.45.07 Jun 2021Breaking

BREAKING CHANGE: Custom templates using some obscure getters of modelType may no longer function (returnElement and others not used in standard templa…

BREAKING CHANGE: Custom templates using some obscure getters of modelType may no longer function (returnElement and others not used in standard templates). (#2665)
BREAKING CHANGE: Implicit Future detection, where an asynchronous function without a declared return type had its return type listed as Future, is no more. Those functions now show a dynamic return type. (#2665)
Fix a problem with enum field location calculations. (#2660, #2659)
Support for AOT compilation of templates added to Mustachio, but not yet enabled. (#2664, #2651)
Some additional new lookup code implementation and testing.

Open source →

0.44.024 May 2021Breaking

BREAKING CHANGE: Add support for generic metadata rendering in typedefs. (#2649, #2654). This changes how typedefs are rendered so that they all appea…

BREAKING CHANGE: Add support for generic metadata rendering in typedefs. (#2649, #2654). This changes how typedefs are rendered so that they all appear as new generic typedefs. This means that typedefs can no longer share the _callable templates and have their own implementations.
Add query strings to static assets to ensure they refresh in browsers on changes. (#2646)
Change the comment reference unparser to use analyzer AST tokens instead of file access. (#2642)

Open source →

0.43.012 May 2021Breaking

BREAKING CHANGE: hasDisplayedCategories replaced with hasCategoryNames.

Add experimental lookup code for comment references eventually destined to replace most of lib/src/markdown_processor.dart. Most of this work is disabled by default but does impact internal APIs. (#2637, #2634, #2630, #2622)
Fix duplicate nullability suffix in some cases with markdown output. (#2632)
Update analyzer requirement to 1.5.0 and fix/allow experimental features in 2.14. (#2625, #2618)
Improvement to browser search, making browser find prioritize the main text area. (#2621)
BREAKING CHANGE: hasDisplayedCategories replaced with hasCategoryNames. (#2614)
Fix the public mixins link in the category sidebar. (#2613)
Do not show late fields as 'read/write'. (#2608)
Print version information when an exception is encountered. (#2607)
A number of minor, internal cleanups.

Open source →

0.42.05 Apr 2021Breaking

BREAKING CHANGE: Refactor of dartdoc features and annotations. Use hasFeatures in templates in place of checking featuresAsString as a boolean (#2600)…

Add some tests and verify basic support for triple-shift, and check to be sure that using the function as type parameter feature does not crash dartdoc (#2518, #2517, #2603).
BREAKING CHANGE: Refactor of dartdoc features and annotations. Use hasFeatures in templates in place of checking featuresAsString as a boolean (#2600), and linkedNameWithParameters for getting rendered annotations (#2605).
Implement generic type parameters on annotations. (#2600, #2516).
No longer depend on mustache. (#2596)
BREAKING CHANGE: Replace mustache with mustachio. Use asCallable instead of hasCallable in templates to handle casts correctly. (#2564)

Open source →

0.41.029 Mar 2021Breaking

BREAKING CHANGE: Refactors to better support new type handling. With #2573 and changes building on it, linkedReturnType must be changed to either mode…

Write out doc files for static methods on extensions. (#2588, #2591)
Fix a crash where dartdoc tried to create a duplicate field in the event a static const extension member is declared. (#2585)
Implementation of generic type aliases. (#2584, #2575, #2558)
BREAKING CHANGE: Refactors to better support new type handling. With #2573 and changes building on it, linkedReturnType must be changed to either modelType or modelType.returnType in templates. (#2583, #2573)
Add an option for setting arguments for tool compilation. (#2576)
Make signature of categoriesWithPublicLibraries more accurate. (#2571)
Improve analysis performance by avoiding hints/lints when resolving files. (#2566)
Additional implementation for Mustachio. (#2568, #2555, #2554, #2549, #2547, #2546)
Update highlight.js to include plaintext support and optionally, warn if the user does not specify a language on code blocks. (#2560, #2559, #2593)
Fix invalid json generation on an empty categories list. (#2550)
Many minor internal cleanups related to new lints and ecosystem changes.

Open source →

0.40.025 Feb 2021

More implementation added for Mustachio (#2481, #2482, #2488, #2491, #2497,

More implementation added for Mustachio (#2481, #2482, #2488, #2491, #2497, #2498, #2512, #2515, #2519, #2523, #2525)
originalMember is now an optional parameter to ModelElement(). #2507
Use custom handling for search, deleting jquery/typeahead libraries. (#2486, #2483)
Small change to dartdoc exit/error text output. (#2489)
Fixed problem with stdout corruption in tool output due to null-safety warnings. (#2493)
Connect interface types across intermediate classes. (#2495, #2485)
Update analyzer to 1.0.0 (#2524) This version of dartdoc requires Dart 2.12 as a result.
Many minor internal cleanups updating code to newer Dart style and idioms.

Open source →

0.39.014 Jan 2021Breaking

Breaking change: Removed bootstrap CSS files.

More implementation added for Mustachio. (#2452, #2458, #2467)
Use = to document values for named parameters. (#2453, #2087)
Add a link to the null safety feature indicator. (#2455)
Fixed a problem where searching by URL failed in SDK docs. (#2470)
Fix a regression where members were not being marked as inherited in sidebars (#2473, #2472).
Breaking change: Removed bootstrap CSS files. (#2460)
Breaking change: Removed the URI.js library. (#2471)
Update Highlight.js to 10.5.0, including better support for highlighting non-nullable code. (#2474)

Open source →

0.38.08 Dec 2020Breaking

Breaking change: Refactor sidebar handling to improve performance. Sidebar templates are now required to exist in custom sets, though you do not have…

Correctly handle intermediate abstract classes containing external implementations. (#2449, #2251)
More implementation added for Mustachio. (#2448, #2447, #2442)
Change analyzer minor version, updating to 0.41. (#2445)
Breaking change: Refactor sidebar handling to improve performance. Sidebar templates are now required to exist in custom sets, though you do not have to use them. See referred PR. (#2444)
Breaking change: Complete extraction of sorted methods used by templates. This moves sorting of elements closer to the presentation layer but requires renaming references in custom templates. See sed script example in referred PR. (#2438)
Fix missing null checks for YAML data. (#2441, #2378)
Give the correct exception for missing FLUTTER_ROOT even where pub get has already run. (#2440, #2407)
Internal change, prefer analyzer's InterfaceType.allSupertypes. (#2439)

Open source →

0.37.019 Nov 2020Breaking

Breaking change: Correct null dereference exception on unusual import URIs through change to PackageGraph.allLibraries. (#2429, #2426)

Change scope for the dartdoc warning configuration to the library being documented rather than where the symbol was originally defined. (#2432, #2428)
Breaking change: Correct null dereference exception on unusual import URIs through change to PackageGraph.allLibraries. (#2429, #2426)
Adding (as yet unused) code for mustachio, a builder for mustache templates. (#2417, #2421, #2427, #2430, #2434).
Corrected a problem with tests erroneously passing in the grinder on latest SDK. (#2422, #2423, #2424)

Open source →

0.36.23 Nov 2020

Tag Null safety only where the code is actually null safe. (#2411, #2403)

Tag Null safety only where the code is actually null safe. (#2411, #2403)
Infrastructure and minor cleanups. (#2414, #2413, #2412)

Open source →

0.36.122 Oct 2020

Fix NPE in Accessor.computeDocumentationComment when encountering static fields in extension methods (#2402, #2404)

Fix NPE in Accessor.computeDocumentationComment when encountering static fields in extension methods (#2402, #2404)

Open source →

0.36.020 Oct 2020Breaking

Breaking change Behavior of --exclude-packages is changed so that packages so excluded will never be treated as "remote". This version is now incompat…

Fix problem with linking to non-canonical elements via documentation references. (#2397, #2389)
Allow for markdown 3.0.0. (#2394)
Breaking change Behavior of --exclude-packages is changed so that packages so excluded will never be treated as "remote". This version is now incompatible with old workarounds for #1431 (and those workarounds are no longer needed). Also removes PackageGraph.packageDocumentedFor. (#2387, #2382, #1431)
Enable NNBD support by default in dartdoc. If a package is non-nullable, it will now be documented that way (with null safety tags). No change in behavior for packages that have not been migrated. (#2384)
Breaking change Adjust interfaces for mustache and remove constant templates, including removing TemplateData.packageGraph. (#2375, #2373, #2379)
Internal type changes for upcoming analyzer 0.41 (#2380, #2392)
Breaking change Remove typeParameters setter for ModelFunctionTyped and change Typedef inheritance (#2376)

Open source →

0.35.06 Oct 2020Breaking

Breaking change: The DartdocOption constructor interface has changed so it uses an enum instead of individual isFile and isDir.

Update Dart analyzer version to 0.40+ and update minimum Dart version to 2.10. (#2372)
Add a nodoc option in dartdoc_options.yaml to prevent all symbols declared in a file from ever being documented, similar to using @nodoc (#2369, #2368, #2266, #2355)
Some template interface refactors preparing for mustache changes to drop use of dart:mirrors. (#2371, #2370)
Add an feature to allow declaring a DartdocOption's value to be a glob. (#2365)
- Breaking change: The DartdocOption constructor interface has changed so it uses an enum instead of individual isFile and isDir.
Emit a warning rather than throwing a fatal error for a package with no libraries. (#2360, #2327)
Fix several problems with implementation chain display when there are intermediate private classes (#2358, #2290, #2094, #2354, #1623)
Fix a deadlock in MultiFutureTracker. (#2351)
Cache exclude values and known parts. (#2347)

Open source →

0.34.015 Sept 2020Breaking

Breaking change: Move io_utils listDir to be a private method in PackageBuilder.

PackageConfigProvider, MockSdk, etc for improved unit testing (#2332)
- The new PackageConfigProvider class abstracts over PackageConfig from package_config. PhysicalPackageConfigProvider uses the real one; MemoryPackageConfigProvider is used in tests.
- The new isSdkLibraryDocumented abstracts over SdkLibrary's isDocumented, because it throws unimplemented for MockSdkLibrary.
- Remove ResourceProviderExtensions.defaultSdkDir. Now this is a property of PackageMetaProvider.
- Breaking change: Move io_utils listDir to be a private method in PackageBuilder.
- Breaking change: Add parameter to PubPackageBuilder constructor for a PackageConfigProvider.
- Breaking change: Add two parameters to the PackageMetaProvider constructor, one for the default SDK directory, and one for the DartSdk.
- Deprecate package.dart's substituteNameVersion.
- Shorten doc comments here and there to 80 columns.
- Move any tests which use testing/test_package_small to be unit tests; delete the package in testing/.
- Move some tests for properties of package which use the ginormous testing package to unit tests
Add a warning when an unknown directive is parsed in a comment. (#2340)

Open source →

0.33.011 Sept 2020Breaking

Breaking change: Many classes have a new ResourceProvider resourceProvider field: DartdocFileWriter, SnapshotCache, DartToolDefinition, ToolConfigurat…

Remove a use of resource loading (#2337)
Remove some unused dependencies (#2334)
Use the terminal width for the line length (#2333)
Disambiguate between named constructor and field (#2331)
Rename some fields which erroneously reference "default" constructors. (#2330)
Support abstract fields (#2329)
Allow ? and ! to trail in doc comment references (#2328)
Use first element in a MultiplyDefinedElement (#2326)
Update all (approximately) i/o operations to use ResourceProvider (#2315):
- Breaking change: Many classes have a new ResourceProvider resourceProvider field: DartdocFileWriter, SnapshotCache, DartToolDefinition, ToolConfiguration, DartdocOption, PackageMetaProvider, PackageMeta, ToolTempFileTracker.
- Breaking change: Each of SnapshotCache and ToolTempFileTracker has a static instance field which took no arguments; now that they need a ResourceProvider, it was unwieldy to pass a ResourceProvider to get the instance each time, so a new method, createInstance creates the instance.
Remove wbr tags around block-displayed elements (#2320)
Warn when the defining library cannot be found (#2319)
Improve error when FLUTTER_ROOT is missing. (#2316)
Remove dependency on deprecated resource package. (#2314)
Link const annotations to their docs (#2313)
Breaking change: Remove FileContents class. (#2312)

Open source →

0.32.418 Aug 2020Deprecated

Deprecate the public method Canonicalization.scoreElementWithLibrary.

Fix paragraph spacing in enum values. (#2286)
Escape HTML in parameter default values (#2288)
Preserve newline following {@endtemplate}. (#2289)
Privatize some of the public interface (#2291, #2292, ##2293, #2307)
- Deprecate the public method Canonicalization.scoreElementWithLibrary.
- Deprecate the public getters ScoredCandidate.reasons and ScoredCandidate.element, method ScoredCandidate.alterScore.
- Deprecate the setters Category.package, and Category.config, and the public method Category.fileType.
- Deprecate the unused methods Category.linkedName and Category.categoryLabel.
- Deprecate the setters Class.mixins and Class.supertype and method Class.isInheritedFrom.
- Change Library.fromLibraryResult to be a factory constructor.
- Deprecate the public methods Library.getDefinedElements, Library.getLibraryName, and getter Library.allOriginalModelElementNames.
- Deprecate the public top-level fields in io_utils.dart: libraryNameRegexp, partOfRegexp, newLinePartOfRegexp
- Deprecate the public top-level field in categorization.dart: categoryRegexp
- Deprecate the public top-level fields in model_element.dart: needsPrecacheRegExp, htmlInjectRegExp, macroRegExp
- Deprecate the public top-level field in source_linker.dart: uriTemplateRegexp
Add more types to public APIs (#2285)
Remove dartdoc's dep on package:quiver (#2305)

Open source →

0.32.36 Aug 2020

Allow injected HTML in a macro which is output by a tool (#2274).

Allow injected HTML in a macro which is output by a tool (#2274).
Add packageName to index.json entries (#2271).
Bump markdown to 2.1.5 (#2267).
Reduce the time to generate docs. Using an example Flutter package, the time required to generate docs was reduced from 67 seconds to 46 seconds, a 31% reduction (#2255, #2259, #2260, #2267).
Don't HTML-escape source code blocks in Markdown output (#2253).
Don't crash when documenting an export with '//' in the path (#2254).
Improve null safety support (#2269).

Open source →

0.32.128 May 2020

Allow documenting code with null safety (#2210, #2221).

Allow documenting code with null safety (#2210, #2221).
Refactors moving toward mono-repo support (#2219).

Open source →

0.32.020 May 2020

Fix type exception in 2.9 dev versions of dart (#2214).

Fix type exception in 2.9 dev versions of dart (#2214).
BREAKING : Refactor Container class, changing the names of many getters for templates. Users with custom templates may need to update their templates (#2206, #2208).
Refactors moving toward mono-repo support (#2204, #2203).
Fix crash with newer analyzers and unnamed extension methods (#2197).
Use flutter pub get when appropriate instead of dart pub get (#2190).

Open source →

0.31.021 Apr 2020

--link-to-remote is now the default.

--link-to-remote is now the default. (#2147)
--show-progress is now the default on interactive terminals, and has improved quality of output. (#2147)
Excessive notifications for "parsing" have been squelched from stdout. (#2141, #2147)
Fixed a bug where explicitly requested private members in a comment reference could result in broken link generation. (#2147)
Dartdoc now generates documentation for itself cleanly (#2147)

Open source →

0.30.415 Apr 2020

Fix regression in canonicalization from extension methods. (#2099).

Fix regression in canonicalization from extension methods. (#2099).
Do not throw if a const constructor's staticElement can not be resolved (#2176, #2143).
Hide non-local embedded SDKs, preventing Flutter's sky_engine from being documented by default with Flutter packages (#1949, #2175).
Fix a problem with reentrance on TopLevelVariable doc caching. (#2173, #2143)
A batch of tweaks for the new markdown output templates (#2162)

Open source →

0.30.327 Mar 2020

Add support for Never type from analyzer (#2167, #2170).

Add support for Never type from analyzer (#2167, #2170).
First markdown renderers landed (#2152) and dartdoc can sometimes generate markdown, but it is not ready for prime-time yet.

Open source →

0.30.25 Mar 2020

Fix the broken search box with --use-base-href in Flutter (#2158).

Fix the broken search box with --use-base-href in Flutter (#2158).
More internal changes preparing for markdown output (#2145, #2150, #2151, #2153).

Open source →

0.30.118 Feb 2020

A more complete fix for the broken search box. (#2125, #2124)

A more complete fix for the broken search box. (#2125, #2124)
Fix the "--rel-canonical-prefix" flag post base href. (#2126, #2122)
Tool change: grind serve-pub-package can now serve packages depending on flutter for debugging purposes (#2130)
More internal changes preparing for markdown output (#2138, #2140, #2132, #2121, #2115)
Fix a crash when using --no-generate-docs (#2139)

Open source →

0.30.0+19 Jan 2020

Fix a broken search box on pages in subdirectories (#2117, #2118)

Fix a broken search box on pages in subdirectories (#2117, #2118)

Open source →

0.30.09 Jan 2020Breaking

BREAKING CHANGE: no longer use in generated documentation, instead use real relative links. This may break manually constructed links that rely on bas…

BREAKING CHANGE: no longer use <base href> in generated documentation, instead use real relative links. This may break manually constructed links that rely on base href, or could impact post-processing of dartdoc HTML. Most users should not notice. A hidden flag can for now restore the old behavior, but will be removed soon. (#2098, #2096)
More refactors to prepare for markdown rendering. (#2100, #2114)
Fix crashes with extensions on special types. (#2112, #2102)
Add a new error type for multiple-file overwrite problems. (#2111, #2110)
Allow FunctionTypes to work in applicability checks for extensions. (#2109, #2101)
Refactor to use Element.declaration over Member.baseMember. (#2106)

Open source →

0.29.317 Dec 2019Deprecated

Internal changes to stop using newly deprecated analyzer interfaces (#2091, #2093).

More refactoring changes to rendering (#2085, #2086).
Internal changes to stop using newly deprecated analyzer interfaces (#2091, #2093).

Open source →

0.29.23 Dec 2019

Many refactoring changes to rendering and tests (#2084, #2081, #2080, #2078, #2077, #2076, #2068, #2067).

Many refactoring changes to rendering and tests (#2084, #2081, #2080, #2078, #2077, #2076, #2068, #2067).
Add 'required' for required named parameters with NNBD enabled (#2075).
Rewrite parameter handling and fix problems with brackets (#2075, #2059, #2052, #2082).
Add 'late' as a feature for final variables with NNBD enabled (#2071).
Add presubmit grinder and dartfmt check for dartdoc development (#2070).
Initial implementation of NNBD support (with --enable-experiment flag) (#2069).

Open source →

0.29.18 Nov 2019

Fix edge cases on extension discovery (#2062).

Fix edge cases on extension discovery (#2062).
Make sure that enum documentation contains unique IDs for animations (#2060).

Open source →

0.29.01 Nov 2019

Internal change to our use of FunctionTypeAliasElement for the analyzer (#2051).

Internal change to our use of FunctionTypeAliasElement for the analyzer (#2051).
Analyzer version to 0.29+ (#2049).
Refactor element discovery and fix extension discovery to work with imports (#2050).
Bugfix for corrupt location reporting in many cases (#2043).
Add a list of extensions to applicable class pages (#2053).

Open source →

0.28.814 Oct 2019

Use analyzer line number library, fixing crash on empty file (#2034, #1938).

Use analyzer line number library, fixing crash on empty file (#2034, #1938).
Fix crash on resolving comment references inside extension methods (#2040, #2033).

Open source →

0.28.77 Oct 2019

Remove obsolete references to Element.type and ElementHandle (#2028, #2031).

Remove obsolete references to Element.type and ElementHandle (#2028, #2031).
Fix problem with return values for typedefs with analyzer 0.38.5 (#2036).

Open source →

0.28.625 Sept 2019

Support for 0.38.3 version of package:analyzer.

Support for 0.38.3 version of package:analyzer.
Support generating docs for extension methods (#2001).

Open source →

0.28.526 Aug 2019

Support the latest version of package:analyzer.

Support the latest version of package:analyzer.
Fix hyperlinks to overriden methods (#1994).
Option in dartdoc_options.yaml to exclude version in footer info (#1982).

Open source →

0.28.410 Jul 2019Breaking

Breaking change Change the default for allow-tools command line flag to false.

Breaking change Change the default for allow-tools command line flag to false.
Fix some lints.
Update to support a future version of analyzer.

Open source →

0.28.3+15 Apr 2019

Fix scroll physics and behavior for Safari on iOS.

Fix scroll physics and behavior for Safari on iOS.

Open source →

0.28.3+216 Apr 2019

Support the latest version of package:html.

Support the latest version of package:html.
Use latest version of the markdown package.

Open source →

0.28.33 Apr 2019

Support a new {@youtube} directive in documentation comments to embed YouTube videos.

Support a new {@youtube} directive in documentation comments to embed YouTube videos.

Open source →

0.28.214 Feb 2019

Add empty CSS classes in spans around the names of entities so Dashing can pick them up. (flutter/flutter#27654, #1929)

Add empty CSS classes in spans around the names of entities so Dashing can pick them up. (flutter/flutter#27654, #1929)
Test fixups for experiments (#1932, #1931, #1929).
Make precaching work for borrowed documentation, fixing cases where @tool directives were not being substituted correctly in generated docs (#1930, #1934).

Open source →

0.28.1+14 Feb 2019

Make hamburger menu appear in Chrome 72.

Make hamburger menu appear in Chrome 72.

Open source →

0.28.1+25 Feb 2019

Fix alignment of search box text in Safari (#1926).

Fix alignment of search box text in Safari (#1926).

Open source →

0.28.14 Feb 2019

Reenable three-pane scrolling in Chrome 72 (#1922, #1921)

Reenable three-pane scrolling in Chrome 72 (#1922, #1921)
A new version of the highlightjs pack supports syntax highlighting for SCSS. (#1906, #1907)
Allow manually-specified links to source code, appearing as a small icon near the top of each element's page (#1913, #1454, #1892)
Dartdoc can be used just to generate warnings by passing --no-generate-docs (#1909, #1537).
Dartdoc's default CSS now more closely resembles dartlang.org, with some miscellaneous alignment tweaks, Roboto font, and use of :hover to highlight links (#1916, #1372)
Viewport parameters for mobile now prevent "stuck page" syndrome (#1916, #1911). Overscroll is now permitted for mobile.
Fix a problem where we don't render greater than symbols in the header for Chrome 72 (#1919, #1918)
Dartdoc now remembers scroll positions for all three columns while navigating (#1917, #1288, #1372, #779, #1870)
Update analyzer package to 0.35.0 and several internal test/coverage infrastructure fixes.

Open source →

0.28.014 Jan 2019Breaking

Breaking change to warning handling. Many new command line options and dartdoc_options.yaml settings can constrain and configure how warnings are inte…

Fix a crash when a Dart library doesn't have the .dart suffix (#1897)
Fix a crash when a Dart file is loaded with an unresolvable prefix import in analyzer (#1896)
Do not execute tools to generate documentation for non-canonical elements that have canonical counterparts. This eliminates "duplicate" tool runs that serve no purpose for generated docs or macro loading. (#1898)
Fix a minor problem where invalid command line parameters could generate an ugly exception (#1895)
Remove internal copy of mustache4dart and depend on the mustache package. Many minor changes to templating as a result. (#1894)
Breaking change to warning handling. Many new command line options and dartdoc_options.yaml settings can constrain and configure how warnings are interpreted by dartdoc, and whether they are fatal. The old --show-warnings flag has been removed. (#1891, #1343, #1412, #1480)
Fix a crash when loading README.md files that have invalid UTF-8. (#1890, #1889)
Early implementation of experiment flags for Dart tools, based on the analyzer (#1884)

Open source →

0.27.03 Jan 2019

Several dartdoc project infrastructure changes, including coverage support. (#1869, #1878, #1879, #1881, #1882)

Several dartdoc project infrastructure changes, including coverage support. (#1869, #1878, #1879, #1881, #1882)
Fixed many issues that made mobile/small screen usage of dartdoc impossible. Mobile users should now be able to do basic browsing and searching in API docs. (#1873, #908, #1048, #1348, #1469)
Support import prefix resolution in dartdoc. (#1875, #1402).

Open source →

0.26.113 Dec 2018

Fix bug that accidentally caused dartdoc to create (and overwrite with) multiple snapshots in parallel for a single tool (#1861, #1862)

Fix bug that accidentally caused dartdoc to create (and overwrite with) multiple snapshots in parallel for a single tool (#1861, #1862)
Refactor comment reference handling for performance and readability (#1863)
Simplify temp file creation and reduce the amount of filesystem churn for tools (#1865)
Reenable testing for flutter plugin doc generation (This requires a Flutter SDK with flutter/flutter#25243 to work with tools enabled). Flutter plugin doc generation now requires your flutter installation to have 'flutter update-packages' run on it before it will work.

Open source →

0.26.04 Dec 2018

Launch helper tools and construct PackageGraphs asynchronously

Remove crossdart support (#1856)
Launch helper tools and construct PackageGraphs asynchronously (#1849)
Refactor Dartdoc to avoid use of analyzer's computeNode, and prevent it from holding on to fully resolved ASTs from analyzer (#1851, #1857, #1858)
Dartdoc no longer attempts to report analysis errors but assumes they will be non-fatal and carries on (#1845)
Add command line flag to allow disabling tools (#1853)

Open source →

0.25.019 Nov 2018

Fix crash if a code reference ambiguously referred to a parameter of an optional function parameter (#1835, #1841)

Fix crash if a code reference ambiguously referred to a parameter of an optional function parameter (#1835, #1841)
Allow annotations that return the dynamic type (#1834, #1840)
Better error messages in the case of a package with no documentable libraries (#1832)
Fix a problem where the reexport tagger could trigger stack overflow if a library exported itself (#1832, #1838)
Performance-related refactorings to return some of the performance lost with macro templates in private libraries (#1828, #1829, #1831, #1837)
Fix several Flutter problems (#1819)
- Fix assertion failure if macros are defined in packages with no public libraries
- Allow declaring macro templates in private libraries
- Avoid circular dependency in finding special objects
- Populate reference cache with child elements of mixins (fixes ~45 links inside Flutter)
Added support for automatic snapshotting of external tools (i.e. for {@tool} directives) written in Dart. (#1820)
Changes to reduce use of internal APIs in analyzer (#1817, #1825)
Template text now appears where it is defined in addition to where it is referenced (#1812)
Change placeholder string in search box to 'Search API Docs'
Fix some instances where macros were not being resolved correctly (#1811)
Macro templates now appear where they are defined in addition to where they are referenced (#1810)

Open source →

0.24.118 Oct 2018

Added more metadata (element name, project name, etc.) to external tool invocations.

Added more metadata (element name, project name, etc.) to external tool invocations. (#1801)
Fixed a bug where not specifying --show-warnings caused dartdoc to report success even when errors were present. (#1805)

Open source →

0.24.016 Oct 2018

Add 'override' to feature list for members which override a superclass

Add 'override' to feature list for members which override a superclass (#981)
Support many options via dartdoc_options.yaml (#1674)
Allow insertion of raw HTML into dartdoc, via flag (#1793)
Stop using old supermixin syntax in dartdoc (#1772)

Open source →

0.23.19 Oct 2018

Make mixins appear under their own category, even if they are reexported

Make mixins appear under their own category, even if they are reexported (#1785)

Open source →

0.23.05 Oct 2018

Document covariant parameters and fields

Document covariant parameters and fields (#1782)
Implement new-style mixin support for Dart 2.1 (#1765, #1752, #1778, #1779)
Remove direct dependency on front_end package (#1780)
Travis/testing and grinder script changes (#1777, #1771)
Captions on class pages now use nouns consistently (#1767)
Minor changes to categories style (#1761)

Open source →

0.22.02 Oct 2018

Fix incompatibility with head analyzer (endsWith exception).

Documentation updates. (#1760)
Fix incompatibility with head analyzer (endsWith exception). (#1768)
Added the ability to run external tools on a section of documentation and replace it with the output of the tool.

Open source →

0.21.121 Sept 2018

Fix a problem where category ordering specified in categories option was not obeyed. Reintroduce categoryOrder option to solve this problem.

Fix a problem where category ordering specified in categories option was not obeyed. Reintroduce categoryOrder option to solve this problem.

Open source →

0.21.018 Sept 2018

Expand categories to all top level items as well as libraries. (#1681, #1353)

Expand categories to all top level items as well as libraries. (#1681, #1353)
The categoryOrder option in dartdoc_options.yaml and the command line is replaced with a more generic "categories" option. See README.md.

Open source →

0.20.428 Aug 2018

Hide pragma declarations from generated docs

Hide pragma declarations from generated docs (#1726)
Fix problems with lists in markdown not being handled correctly (#172)
Properly escape types inside comment references (#1740)
Generate a custom page, __404error.html, for use as an error page (#1704)
Generate an error on unresolved exports instead of crashing (#1745)
Generate anchors for headers in markdown (#1749)

Open source →

0.20.37 Aug 2018

Update dependencies and fork mustache4dart into dartdoc so dartdoc can resolve dependencies on Dart 2.0 stable.

Update dependencies and fork mustache4dart into dartdoc so dartdoc can resolve dependencies on Dart 2.0 stable.

Open source →

0.20.225 Jul 2018

Fix crash building Angular docs and problems involving special objects (#1728, #1554)

Fix void problems (#1724)
Fix crash building Angular docs and problems involving special objects (#1728, #1554)
Run pub upgrade to get packages ready for 69.2.

Open source →

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 →

Your coding agent can read these notes before it upgrades. Set up the MCP server →