dartdoc 8.3.1
dartdoc: ^8.3.1 copied to clipboard

Published 7 days ago •

tools.dart.devDart 3 compatible

SDKDart Flutter

PlatformAndroid iOS Linux macOS Windows

213

→

Metadata

A non-interactive HTML documentation generator for Dart source code.

More...

213

likes

160/ 160

pub points

862k

downloads

We analyzed this package 4 days ago, and awarded it 160 pub points (of a possible 160):

Follow Dart file conventions

30 / 30

10/10 points: Provide a valid `pubspec.yaml`

5/5 points: Provide a valid `README.md`

5/5 points: Provide a valid `CHANGELOG.md`

10/10 points: Use an OSI-approved license

Detected license: BSD-3-Clause.

Provide documentation

20 / 20

10/10 points: 20% or more of the public API has dartdoc comments

153 out of 319 API elements (48.0 %) have documentation comments.

Some symbols that are missing documentation: dartdoc.CategoryConfiguration.empty, dartdoc.CategoryConfiguration.fromYamlMap, dartdoc.ConstructedModelElementsKey, dartdoc.ConstructedModelElementsKey.ConstructedModelElementsKey, dartdoc.ConstructedModelElementsKey.element.

10/10 points: Package has an example

Platform support

20 / 20

20/20 points: Supports 5 of 6 possible platforms (iOS, Android, Web, Windows, macOS, Linux)

✓ Android
✓ iOS
✓ Windows
✓ Linux
✓ macOS

These platforms are not supported:

Package not compatible with platform Web

Because:

package:dartdoc/dartdoc.dart that imports:
package:dartdoc/src/package_meta.dart that imports:
package:analyzer/src/generated/sdk.dart that imports:
package:analyzer/dart/ast/visitor.dart that imports:
package:analyzer/dart/ast/ast.dart that imports:
package:analyzer/src/dart/ast/ast.dart that imports:
package:analyzer/src/utilities/extensions/element.dart that imports:
package:analyzer/src/dart/element/member.dart that imports:
package:analyzer/src/generated/utilities_dart.dart that imports:
package:analyzer/src/dart/element/element.dart that imports:
package:analyzer/src/summary2/reference.dart that imports:
package:analyzer/dart/element/element2.dart that imports:
package:analyzer/src/dart/resolver/scope.dart that imports:
package:analyzer/src/generated/engine.dart that imports:
package:analyzer/error/listener.dart that imports:
package:analyzer/src/dart/element/type.dart that imports:
package:analyzer/src/dart/element/type_system.dart that imports:
package:analyzer/src/generated/inference_log.dart that imports:
package:analyzer/src/generated/resolver.dart that imports:
package:analyzer/src/util/ast_data_extractor.dart that imports:
package:analyzer/dart/element/element.dart that imports:
package:analyzer/src/dart/constant/evaluation.dart that imports:
package:analyzer/src/dart/element/type_algebra.dart that imports:
package:analyzer/src/summary2/record_type_builder.dart that imports:
package:analyzer/src/dart/element/type_visitor.dart that imports:
package:analyzer/src/summary2/named_type_builder.dart that imports:
package:analyzer/src/summary2/link.dart that imports:
package:analyzer/src/summary2/top_level_inference.dart that imports:
package:analyzer/src/summary2/library_builder.dart that imports:
package:analyzer/src/summary2/macro_application.dart that imports:
package:analyzer/src/summary2/macro_declarations.dart that imports:
package:analyzer/src/summary2/linked_element_factory.dart that imports:
package:analyzer/src/summary2/macro.dart that imports:
package:macros/src/executor/process_executor.dart that imports:
package:_macros/src/executor/process_executor.dart that imports:
package:_macros/src/executor/executor_base.dart that imports:
dart:isolate

0/0 points: WASM compatibility

Package not compatible with runtime wasm

Because:

package:dartdoc/dartdoc.dart that imports:
package:dartdoc/src/package_meta.dart that imports:
package:analyzer/src/generated/sdk.dart that imports:
package:analyzer/dart/ast/visitor.dart that imports:
package:analyzer/dart/ast/ast.dart that imports:
package:analyzer/src/dart/ast/ast.dart that imports:
package:analyzer/src/utilities/extensions/element.dart that imports:
package:analyzer/src/dart/element/member.dart that imports:
package:analyzer/src/generated/utilities_dart.dart that imports:
package:analyzer/src/dart/element/element.dart that imports:
package:analyzer/src/summary2/reference.dart that imports:
package:analyzer/dart/element/element2.dart that imports:
package:analyzer/src/dart/resolver/scope.dart that imports:
package:analyzer/src/generated/engine.dart that imports:
package:analyzer/error/listener.dart that imports:
package:analyzer/src/dart/element/type.dart that imports:
package:analyzer/src/dart/element/type_system.dart that imports:
package:analyzer/src/generated/inference_log.dart that imports:
package:analyzer/src/generated/resolver.dart that imports:
package:analyzer/src/util/ast_data_extractor.dart that imports:
package:analyzer/dart/element/element.dart that imports:
package:analyzer/src/dart/constant/evaluation.dart that imports:
package:analyzer/src/dart/element/type_algebra.dart that imports:
package:analyzer/src/summary2/record_type_builder.dart that imports:
package:analyzer/src/dart/element/type_visitor.dart that imports:
package:analyzer/src/summary2/named_type_builder.dart that imports:
package:analyzer/src/summary2/link.dart that imports:
package:analyzer/src/summary2/top_level_inference.dart that imports:
package:analyzer/src/summary2/library_builder.dart that imports:
package:analyzer/src/summary2/macro_application.dart that imports:
package:analyzer/src/summary2/macro_declarations.dart that imports:
package:analyzer/src/summary2/linked_element_factory.dart that imports:
package:analyzer/src/summary2/macro.dart that imports:
package:macros/src/executor/process_executor.dart that imports:
package:_macros/src/executor/process_executor.dart that imports:
package:_macros/src/executor/executor_base.dart that imports:
dart:isolate

This package is not compatible with runtime wasm, and will not be rewarded full points in a future version of the scoring model.

See https://dart.dev/web/wasm for details.

Pass static analysis

50 / 50

50/50 points: code has no errors, warnings, lints, or formatting issues

Support up-to-date dependencies

40 / 40

10/10 points: All of the package dependencies are supported in the latest version

Package	Constraint	Compatible	Latest
`analyzer`	`^6.10.0`	6.11.0	7.1.0
`args`	`^2.4.1`	2.6.0	2.6.0
`collection`	`^1.17.0`	1.19.1	1.19.1
`crypto`	`^3.0.3`	3.0.6	3.0.6
`glob`	`^2.1.1`	2.1.2	2.1.2
`html`	`^0.15.3`	0.15.5	0.15.5
`logging`	`^1.1.1`	1.3.0	1.3.0
`markdown`	`^7.2.1`	7.2.2	7.2.2
`meta`	`^1.9.1`	1.16.0	1.16.0
`package_config`	`^2.1.0`	2.1.1	2.1.1
`path`	`^1.8.3`	1.9.1	1.9.1
`pub_semver`	`^2.1.4`	2.1.5	2.1.5
`source_span`	`^1.10.0`	1.10.1	1.10.1
`yaml`	`^3.1.2`	3.1.3	3.1.3

Transitive dependencies

Package	Constraint	Compatible	Latest
`_fe_analyzer_shared`	-	76.0.0	78.0.0
`_macros`	-	0.3.3	0.3.3
`async`	-	2.12.0	2.12.0
`convert`	-	3.1.2	3.1.2
`csslib`	-	1.0.2	1.0.2
`file`	-	7.0.1	7.0.1
`macros`	-	0.1.3-main.0	0.1.3-main.0
`string_scanner`	-	1.4.1	1.4.1
`term_glyph`	-	1.2.2	1.2.2
`typed_data`	-	1.4.0	1.4.0
`watcher`	-	1.1.1	1.1.1