dartdoc 8.3.4
dartdoc: ^8.3.4 copied to clipboard

Published 6 months ago •

tools.dart.dev• Latest: 9.0.0

SDKDart Flutter

PlatformAndroid iOS Linux macOS Windows

233

→

Metadata

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

More...

233

likes

140/ 160

pub points

512k

downloads

We analyzed this package 2 days ago, and awarded it 140 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 340 API elements (45.0 %) have documentation comments.

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

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/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/element2.dart that imports:
package:analyzer/src/dart/resolver/scope.dart that imports:
package:analyzer/src/generated/engine.dart that imports:
package:analyzer/src/dart/analysis/analysis_options.dart that imports:
package:analyzer/src/task/options.dart that imports:
package:analyzer/src/plugin/options.dart that imports:
package:analyzer/error/listener.dart that imports:
package:analyzer/src/dart/element/extensions.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/export.dart that imports:
package:analyzer/src/summary2/library_builder.dart that imports:
package:analyzer/src/summary2/types_builder.dart that imports:
package:analyzer/src/summary2/type_builder.dart that imports:
package:analyzer/dart/element/type.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/instance_member_inferrer.dart that imports:
package:analyzer/src/dart/element/inheritance_manager3.dart that imports:
package:analyzer/src/fine/requirements.dart that imports:
package:analyzer/src/summary2/linked_element_factory.dart that imports:
package:analyzer/src/summary2/bundle_reader.dart that imports:
package:analyzer/src/fine/library_manifest.dart that imports:
package:analyzer/src/dart/analysis/file_state.dart that imports:
package:analyzer/src/workspace/workspace.dart that imports:
package:analyzer/src/workspace/blaze.dart that imports:
package:analyzer/src/workspace/blaze_watcher.dart that imports:
package:watcher/watcher.dart that imports:
package:watcher/src/file_watcher/polling.dart that imports:
package:watcher/src/polling.dart that imports:
dart:io

Pass static analysis

40 / 50

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

Found 23 issues. Showing the first 2:

INFO: 'identifier' is deprecated and shouldn't be used. Use uri instead.

lib/src/model/canonicalization.dart:92:39

   ╷
92 │         components.insert(0, ancestor.identifier);
   │                                       ^^^^^^^^^^
   ╵

To reproduce make sure you are using the lints_core and run dart analyze lib/src/model/canonicalization.dart

INFO: 'identifier' is deprecated and shouldn't be used. Use uri instead.

lib/src/model/model_element.dart:415:43

    ╷
415 │     if (element case LibraryElement2(:var identifier, :var firstFragment)) {
    │                                           ^^^^^^^^^^
    ╵

To reproduce make sure you are using the lints_core and run dart analyze lib/src/model/model_element.dart

Support up-to-date dependencies

30 / 40

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

Package	Constraint	Compatible	Latest
`analyzer`	`^7.4.4`	7.7.1	9.0.0
`args`	`^2.4.1`	2.7.0	2.7.0
`collection`	`^1.17.0`	1.19.1	1.19.1
`crypto`	`^3.0.3`	3.0.7	3.0.7
`glob`	`^2.1.1`	2.1.3	2.1.3
`html`	`^0.15.3`	0.15.6	0.15.6
`logging`	`^1.1.1`	1.3.0	1.3.0
`markdown`	`^7.2.1`	7.3.0	7.3.0
`meta`	`^1.9.1`	1.17.0	1.17.0
`package_config`	`^2.1.0`	2.2.0	2.2.0
`path`	`^1.8.3`	1.9.1	1.9.1
`pub_semver`	`^2.1.4`	2.2.0	2.2.0
`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`	-	85.0.0	92.0.0
`async`	-	2.13.0	2.13.0
`convert`	-	3.1.2	3.1.2
`csslib`	-	1.0.2	1.0.2
`file`	-	7.0.1	7.0.1
`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.2.0	1.2.0