Skip to content

Upgrading dartdoc 8 to 9

Breaking8.3.4 → 9.0.11Breaking4Deprecated2New4Changed15Fixed10Other2

Full comparisonBack to dartdoc
BreakingUpgrade verdict

4 breaking changes.

In plain terms
  • A warning that dartdoc used to show for code blocks without a language is gone.
  • The old setting for choosing a custom templates folder no longer exists.
  • The old setting that controlled nodoc handling is no longer available.
  • The old setting for including external documentation is gone.
Must act Top 5 of 6 that need code or config changes

What you must change

Breaking4
Removes the deprecated missingCodeBlockLanguage warning.
missingCodeBlockLanguage
9.0.0GitHub ReleaseSummarizedView source
Removes the deprecated templates-dir option.
templates-dir
9.0.0GitHub ReleaseSummarizedView source
Removes the deprecated nodoc option.
nodoc
9.0.0GitHub ReleaseSummarizedView source
Removes the deprecated include-external option.
include-external
9.0.0GitHub ReleaseSummarizedView source

Deprecations to plan for

Deprecated2
Deprecates the --use-categories option.
--use-categories
9.0.4GitHub ReleaseSummarizedView source
Deprecates the typeAsHtml warning.
typeAsHtml
9.0.1GitHub ReleaseSummarizedView source