Releases: dart-lang/dartdoc
Releases · dart-lang/dartdoc
v0.35.0
- Update Dart analyzer version to 0.40+ and update minimum Dart version
to 2.10. (#2372) - Add a
nodoc
option indartdoc_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 individualisFile
andisDir
.
- Breaking change: The
- 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)
v0.34.0
- 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 forMockSdkLibrary
. - 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 intesting/
. - Move some tests for properties of package which use the ginormous testing
package to unit tests
- The new PackageConfigProvider class abstracts over PackageConfig from
- Add a warning when an unknown directive is parsed in a comment. (#2340)
v0.33.0
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.
- Breaking change: Many classes have a new ResourceProvider
- 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)
v0.32.4
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
, methodScoredCandidate.alterScore
. - Deprecate the setters
Category.package
, andCategory.config
, and the
public methodCategory.fileType
. - Deprecate the unused methods
Category.linkedName
and
Category.categoryLabel
. - Deprecate the setters
Class.mixins
andClass.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
- Deprecate the public method
- Add more types to public APIs (#2285)
- Remove dartdoc's dep on package:quiver (#2305)
v0.32.3
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).
v0.32.2
v0.32.1
v0.32.0
- 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)
v0.31.0
--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)
v0.30.4
- 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)