Skip to content

Releases: dart-lang/dartdoc

v4.1.0

25 Oct 19:00
520e649
Compare
Choose a tag to compare
  • Move to analyzer 2.7.0. (#2845)
  • The library interface is now explicitly marked as experimental via meta.
  • Experimental feature: HTML output from markdown rendering, {@tool} and
    {@inject-html} is sanitized when hidden option --sanitize-html is passed.
  • Refactor of ModelElement and ElementType constructors. Technically breaking
    but known users of the API do not attempt to construct these types by hand.
    (#2828, #2829)
  • Move to recommended set of hints in linter and correct some small errors
    in regexps. (#2833)

v4.0.0

04 Oct 19:02
c2f284f
Compare
Choose a tag to compare

4.0.0

  • BREAKING CHANGE: Refactors to support NNBD and adapt to new analyzer
    changes are technically semver breaking. If you make extensive use of
    the documentationComment getter on ModelElement or other deep
    structural elements in dartdoc or custom templates, they could break
    dependent code. (#2819, #2818, #2817, #2806, #2798)
  • BREAKING CHANGE: Remove a large number of long-standing deprecated
    symbols in dartdoc. (#2821)
  • Fix a problem where certain comment reference strings could
    crash the parser. (#2813, #2808)
  • Fix an assert in canonicalization for enums. (#2812)

v3.1.0

20 Sep 19:04
e5ebb7a
Compare
Choose a tag to compare
  • This version supports the Dart language feature constructor tearoffs,
    pending completion by other tools.
  • Allow embedded type parameters in comment references. (#2772)
  • Add testing for constructor tearoff constant rendering. (#2780)
  • Do not crash on package not found, instead provide a more useful
    explanation for users. (#2781, #2778)
  • --allow-warnings-in-packages no longer also applies to errors.
    The --allow-errors-in-packages flag should now work as intended.
    (#2785)
  • Some additional deprecations preparing for NNBD. (#2784)

v3.0.0

07 Sep 17:02
7fd237d
Compare
Choose a tag to compare
  • BREAKING CHANGE: Refactor of Class, Enum, and Mixin types result in some
    deleted interfaces in templates and a change in class hierarchy. (#2770)
  • The experimental 'constructor-tearoffs' feature has been partially
    implemented in dartdoc and should work in simple cases. (#2655, #2770,
    #2768, #2766, #2763).
  • BREAKING CHANGE: The old lookup code has been deleted, along with the
    --no-enhanced-reference-lookup flag. (#2765)
  • Deprecated uses of pub have been removed. (#2764)
  • Some internal refactors to support NNBD migration.

v2.0.0

23 Aug 17:16
a4ca86f
Compare
Choose a tag to compare
  • BREAKING CHANGE: changes to dartdoc options API
    to prepare for NNBD migration (#2745, #2744).
  • Fix unbound type reference in extension method comment
    reference creating a null dereference (#2741, #2740)
  • Update to analyzer 2.0. (#2734)
  • Fix comment references on generic typedefs in new
    lookup code. (#2755, #2756)

v1.0.2

09 Aug 17:02
5f39ec6
Compare
Choose a tag to compare
  • Fix where extensions header in library sidebar linked to the
    wrong place. (#2717)
  • Fix concurrency issues in tool execution and parallelize
    optimally for the number of cores in the system. (#2730)
  • Display message if tool snapshotting fails. (#2731)

v1.0.1

09 Aug 17:01
26bde83
Compare
Choose a tag to compare
  • Fix several issues with new type hierarchy. (#2714, #2721)
  • Allow code in "diff" language to be syntax highlighted. (#2718)

v1.0.0

29 Jun 16:01
b86cddc
Compare
Choose a tag to compare

1.0.0

  • 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. 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.

v0.45.0

07 Jun 16:10
b733d49
Compare
Choose a tag to compare
  • 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.

v0.44.0

24 May 19:56
3057136
Compare
Choose a tag to compare
  • 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)