dartdoc

API documentation tool for Dart.

BSD-3-CLAUSE License

Stars
472
Committers
68

Bot releases are hidden (Show)

dartdoc - v0.43.0

Published by jcollins-g over 3 years ago

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

Published by jcollins-g over 3 years ago

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

Published by jcollins-g over 3 years ago

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

Published by jcollins-g over 3 years ago

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

Published by jcollins-g almost 4 years ago

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

Published by jcollins-g almost 4 years ago

  • 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. (#2443)
  • 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)
dartdoc - v0.37.0

Published by jcollins-g almost 4 years ago

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

Published by jcollins-g almost 4 years ago

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

Published by jcollins-g almost 4 years ago

  • Fix NPE in Accessor.computeDocumentationComment when encountering
    static fields in extension methods (#2402, #2404)
dartdoc - v0.36.0

Published by jcollins-g almost 4 years ago

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

Published by jcollins-g about 4 years ago

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

Published by jcollins-g about 4 years ago

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

Published by jcollins-g about 4 years ago

Retconned release to catch github up to pub.

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

Published by jcollins-g about 4 years ago

Retconned release to catch github up to pub.

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

Published by jcollins-g about 4 years ago

Retconned release to catch github up to pub.

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

Published by scheglov over 4 years ago

  • Require analyzer ^0.39.12.
  • Use overrideKnownFeaturesAsync for testing.
dartdoc - v0.32.1

Published by jcollins-g over 4 years ago

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

Published by jcollins-g over 4 years ago

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

Published by jcollins-g over 4 years ago

  • --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)
  • Dartdoc can now generate links to new version format SDKs
    without crashing. (#2186)
dartdoc - v0.30.4

Published by jcollins-g over 4 years ago

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