dartdoc

API documentation tool for Dart.

BSD-3-CLAUSE License

Stars
472
Committers
68

Bot releases are hidden (Show)

dartdoc - v8.0.7 Latest Release

Published by kallentu 7 months ago

  • Generate documentation for static members of enums. (#3697)
  • Display an extension's extended type in a few places. (#3708)
  • Minimal support for documenting a package with macro applications. (#3687)
  • Deprecate the --nodoc option. (#3690)
  • Deprecate the --resources-dir option. (#3696)
  • Deprecate the --include-externals option. (#3694)
  • Remove the warning regarding unresolved exports; these are handled by the analyzer. (#3711)
dartdoc - v8.0.6

Published by kallentu 7 months ago

  • Add troubleshooting information when the sidebars failed to load. (#3643)
  • Deprecate the --templates-dir option. (#3667)
  • In the "implementers" section of a class/mixin, include extension types that "implement" said class/mixin. (#3658)
  • Add the "implementers" section to the extension type page. (#3682)
  • Display the exact type of an extension type's representation, not any erasure of an extension type. (#3685)
  • Reduce the time to document with a few improvements. (#3659, #3660)
  • Correct the "constant initializer" view of some enums. (#3669)
  • Render generic type parameters in function-typed parameters. (#3670)
  • Stop warning on a missing constructor; dartdoc expects code to be valid. (#3674)
  • Do not require the FLUTTER_ROOT env variable when documenting a package that requires Flutter. (#3688)
dartdoc - v8.0.5

Published by kallentu 9 months ago

  • Require analyzer: ^6.4.1.
dartdoc - v8.0.2

Published by kallentu 10 months ago

  • Remove @hideConstantImplementations fully. (#3593)
  • Remove Class assert for ClassTypedef. (#3595)
dartdoc - v8.0.1

Published by kallentu 11 months ago

  • The deprecated public APIs will be removed in the next major release.
  • Deprecate options.dart. (#3591)
  • Deprecate public exports in lib/dartdoc.dart. (#3589)
dartdoc - v8.0.0

Published by kallentu 11 months ago

  • Apply @hideConstantImplementations by default. (#3576)
  • Remove unused parameter in zone thing (#3581)
  • Add some progress bars for time-intensive tasks (#3579)
  • Privatize almost all elements in package_builder. (#3580)
  • Privatize several members on PackageGraph (#3578)
  • Correct looping bug in library discovery (#3574)
  • Remove image directive. (#3568)
  • Privatize packageName, name, libraryName, and specialFileUri in SpecialClass. (#3569)
  • Privatize PackageMeta.pathContext. (#3572)
  • Remove samples directive. (#3567)
  • Remove api directive. (#3566)
  • Improve display text for libraries. (#3552)
  • Remove ElementType.canHaveParameters. (#3563)
  • Privatize `ElementType`` subclass constructors (#3560)
  • InheritingContainer: hasPublicInheritedMethods, inheritedFields, publicInheritedFields, publicInheritedMethods are only visible for testing. (#3559)
  • Display inherited elements for extension types. (#3556)
  • Remove DefinedElementType.element and DefinedElementType.isParameterType. (#3558)
  • Make TypeImplementing.directInterfaces private. (#3555)
  • Display extension type super interfaces. (#3554)
  • Display extension type constructors. (#3550)
dartdoc - v6.3.0

Published by jcollins-g over 1 year ago

  • Add a hideImplementations directive to disable showing constant implementations alongside one-line docs on class pages (#3398)
  • Update highlight.js to 11.8.0 for Dart 3 syntax highlight support. (#3416)
  • Split sidebars out into separate HTML files (#3384)
  • Update several required dependency versions, switch to Dart language version 3.0, and several internal refactors. (various)
dartdoc - v6.2.2

Published by jcollins-g over 1 year ago

  • Add chips to class pages for class modifiers. (#3401)
  • Fix a case where dartdoc was not properly handling extension
    method resolution. (#3393)
dartdoc - v6.2.1

Published by jcollins-g over 1 year ago

  • Do not show induced modifiers from analyzer in class headers.
    (#3371)
  • Drop support for final, interface, and sealed mixins. (#3369)
  • Display an error message instead of crashing on wrong data type
    in dartdoc_options.yaml. (#3372)
dartdoc - v6.2.0

Published by jcollins-g over 1 year ago

  • Add basic support for Dart 3.0 features, including records and class
    modifiers. (#3340, #3354)
  • Stop generating a null-safety badge for elements in a null-safe library.
    (#3295)
  • Use a sun icon for switching to the light theme. (#3309)
  • Standardize the search icon style to a new SVG. (#3302)
  • Remove CSS classes no longer used in dartdoc generated content. (#3302)
  • Fix an issue where we created a temporary directory when performing a dry run.
    (#3333)
dartdoc - v4.1.0

Published by jcollins-g almost 3 years ago

  • 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)
dartdoc - v4.0.0

Published by jcollins-g about 3 years ago

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)
dartdoc - v3.1.0

Published by jcollins-g about 3 years ago

  • 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)
dartdoc - v3.0.0

Published by jcollins-g about 3 years ago

  • 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.
dartdoc - v2.0.0

Published by jcollins-g about 3 years ago

  • 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)
dartdoc - v1.0.2

Published by jcollins-g about 3 years ago

  • 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)
dartdoc - v1.0.1

Published by jcollins-g about 3 years ago

  • Fix several issues with new type hierarchy. (#2714, #2721)
  • Allow code in "diff" language to be syntax highlighted. (#2718)
dartdoc - v1.0.0

Published by jcollins-g over 3 years ago

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.
dartdoc - v0.45.0

Published by jcollins-g over 3 years ago

  • 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.
dartdoc - v0.44.0

Published by jcollins-g over 3 years ago

  • 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)
Package Rankings
Top 1.54% on Pub.dev
Badges
Extracted from project README
Build Status OpenSSF Scorecard
Related Projects