dartdoc 8.3.3 copy "dartdoc: ^8.3.3" to clipboard
dartdoc: ^8.3.3 copied to clipboard

Published 54 days ago • verified publishertools.dart.devDart 3 compatible
SDKDartFlutter
PlatformAndroidiOSLinuxmacOSWindows
→

Metadata

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

More...

223
likes
150/ 160
pub points
541k
downloads

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

Passed report section
Follow Dart file conventions
30 / 30trigger folding of the section

Passed check 10/10 points: Provide a valid pubspec.yaml

Passed check 5/5 points: Provide a valid README.md

Passed check 5/5 points: Provide a valid CHANGELOG.md

Passed check 10/10 points: Use an OSI-approved license

Detected license: BSD-3-Clause.

Passed report section
Provide documentation
20 / 20trigger folding of the section

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

154 out of 341 API elements (45.2 %) 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.

Passed check 10/10 points: Package has an example

Failed report section
Platform support
20 / 20trigger folding of the section

Passed check 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/stat.dart that imports:
  • dart:io

Failed check 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/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/stat.dart that imports:
  • dart:io

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.

Partially passed report section
Pass static analysis
40 / 50trigger folding of the section

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

Found 29 issues. Showing the first 2:

INFO: 'AugmentableElement' is deprecated and shouldn't be used. This is an internal class, do not use it.

lib/src/model/canonicalization.dart:97:32

   ╷
97 │         } else if (ancestor is AugmentableElement) {
   │                                ^^^^^^^^^^^^^^^^^^
   ╵

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

INFO: 'enclosingElement2' is deprecated and shouldn't be used. ElementImpl should have never implemented Element2.

lib/src/model/canonicalization.dart:106:47

    ╷
106 │           ancestor = (ancestor.wrappedElement.enclosingElement2
    │                                               ^^^^^^^^^^^^^^^^^
    ╵

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

Passed report section
Support up-to-date dependencies
40 / 40trigger folding of the section

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

Package Constraint Compatible Latest Notes
analyzer ^7.3.0 7.4.1 7.4.1
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.6 3.0.6
glob ^2.1.1 2.1.3 2.1.3
html ^0.15.3 0.15.5+1 0.15.5+1
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.16.0 1.16.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 Notes
_fe_analyzer_shared - 82.0.0 82.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.1.1 1.1.1

To reproduce run dart pub outdated --no-dev-dependencies --up-to-date --no-dependency-overrides.

Passed check 10/10 points: Package supports latest stable Dart and Flutter SDKs

Passed check 20/20 points: Compatible with dependency constraint lower bounds

pub downgrade does not expose any static analysis error.

Analyzed with Pana 0.22.20, Dart 3.7.2.

Check the analysis log for details.

Weekly downloads

Display as:
By versions:

← Metadata

223
likes
150
points
541k
downloads

Publisher

verified publishertools.dart.dev

Weekly Downloads

Metadata

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

Repository (GitHub)
Contributing

Documentation

API reference

License

BSD-3-Clause (license)

Dependencies

analyzer, args, collection, crypto, glob, html, logging, markdown, meta, package_config, path, pub_semver, source_span, yaml

More

Packages that depend on dartdoc

Back