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

Published 2 years ago • verified publishertools.dart.devDart 3 compatible• Latest: 8.3.0
SDKDartFlutter
PlatformAndroidiOSLinuxmacOSWindows
outdated
→

Metadata

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

More...

208
likes
140/ 160
pub points
94%
popularity

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

OK
Follow Dart file conventions
30 / 30trigger folding of the section

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.

OK
Provide documentation
20 / 20trigger folding of the section

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

471 out of 1295 API elements (36.4 %) have documentation comments.

Some symbols that are missing documentation: dartdoc.Accessor.characterLocation, dartdoc.Accessor.definingCombo, dartdoc.Accessor.element, dartdoc.Accessor.enclosingElement, dartdoc.Accessor.filePath.

10/10 points: Package has an example

failed
Platform support
20 / 20trigger folding of the section

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:dartdoc/src/dartdoc_options.dart that imports:
  • package:dartdoc/src/warnings.dart that imports:
  • package:dartdoc/src/model/model.dart that imports:
  • package:dartdoc/src/model/typedef.dart that imports:
  • package:dartdoc/src/render/typedef_renderer.dart that imports:
  • package:dartdoc/src/model/type_parameter.dart that imports:
  • package:dartdoc/src/model/comment_referable.dart that imports:
  • package:dartdoc/src/model/nameable.dart that imports:
  • package:dartdoc/src/model/locatable.dart that imports:
  • package:analyzer/dart/element/element.dart that imports:
  • package:analyzer/src/task/api/model.dart that imports:
  • package:analyzer/src/generated/source.dart that imports:
  • package:analyzer/src/generated/engine.dart that imports:
  • package:analyzer/error/listener.dart that imports:
  • package:analyzer/error/error.dart that imports:
  • package:analyzer/src/generated/parser.dart that imports:
  • package:analyzer/src/fasta/ast_builder.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/bundle_reader.dart that imports:
  • package:analyzer/src/summary2/linked_element_factory.dart that imports:
  • package:analyzer/src/dart/resolver/scope.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/dart/element/well_bounded.dart that imports:
  • package:analyzer/src/dart/element/type_algebra.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/variance_builder.dart that imports:
  • package:analyzer/src/summary2/function_type_builder.dart that imports:
  • package:analyzer/src/dart/ast/extensions.dart that imports:
  • package:analyzer/src/dart/ast/ast.dart that imports:
  • package:analyzer/src/generated/resolver.dart that imports:
  • package:analyzer/src/generated/static_type_analyzer.dart that imports:
  • package:analyzer/src/dart/resolver/invocation_inference_helper.dart that imports:
  • package:analyzer/src/dart/resolver/invocation_inferrer.dart that imports:
  • package:analyzer/src/dart/element/member.dart that imports:
  • package:analyzer/dart/analysis/session.dart that imports:
  • package:analyzer/file_system/file_system.dart that imports:
  • package:analyzer/src/file_system/file_system.dart that imports:
  • package:analyzer/src/util/uri.dart that imports:
  • package:analyzer/src/summary/package_bundle_reader.dart that imports:
  • dart:io

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:dartdoc/src/dartdoc_options.dart that imports:
  • package:dartdoc/src/warnings.dart that imports:
  • package:dartdoc/src/model/model.dart that imports:
  • package:dartdoc/src/model/typedef.dart that imports:
  • package:dartdoc/src/render/typedef_renderer.dart that imports:
  • package:dartdoc/src/model/type_parameter.dart that imports:
  • package:dartdoc/src/model/comment_referable.dart that imports:
  • package:dartdoc/src/model/nameable.dart that imports:
  • package:dartdoc/src/model/locatable.dart that imports:
  • package:analyzer/dart/element/element.dart that imports:
  • package:analyzer/src/task/api/model.dart that imports:
  • package:analyzer/src/generated/source.dart that imports:
  • package:analyzer/src/generated/engine.dart that imports:
  • package:analyzer/error/listener.dart that imports:
  • package:analyzer/error/error.dart that imports:
  • package:analyzer/src/generated/parser.dart that imports:
  • package:analyzer/src/fasta/ast_builder.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/bundle_reader.dart that imports:
  • package:analyzer/src/summary2/linked_element_factory.dart that imports:
  • package:analyzer/src/dart/resolver/scope.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/dart/element/well_bounded.dart that imports:
  • package:analyzer/src/dart/element/type_algebra.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/variance_builder.dart that imports:
  • package:analyzer/src/summary2/function_type_builder.dart that imports:
  • package:analyzer/src/dart/ast/extensions.dart that imports:
  • package:analyzer/src/dart/ast/ast.dart that imports:
  • package:analyzer/src/generated/resolver.dart that imports:
  • package:analyzer/src/generated/static_type_analyzer.dart that imports:
  • package:analyzer/src/dart/resolver/invocation_inference_helper.dart that imports:
  • package:analyzer/src/dart/resolver/invocation_inferrer.dart that imports:
  • package:analyzer/src/dart/element/member.dart that imports:
  • package:analyzer/dart/analysis/session.dart that imports:
  • package:analyzer/file_system/file_system.dart that imports:
  • package:analyzer/src/file_system/file_system.dart that imports:
  • package:analyzer/src/util/uri.dart that imports:
  • package:analyzer/src/summary/package_bundle_reader.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.

partial
Pass static analysis
40 / 50trigger folding of the section

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

Found 5 issues. Showing the first 2:

INFO: Unnecessary override.

lib/src/generator/template_data.dart:221:13

    ╷
221 │   Class get clazz => super.clazz;
    │             ^^^^^
    ╵

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

INFO: 'whereNotNull' is deprecated and shouldn't be used. Use .nonNulls instead.

lib/src/model/categorization.dart:99:63

   ╷
99 │     ...?categoryNames?.map((n) => package?.nameToCategory[n]).whereNotNull()
   │                                                               ^^^^^^^^^^^^
   ╵

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

failed
Support up-to-date dependencies
30 / 40trigger folding of the section

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

Package Constraint Compatible Latest
analyzer ^3.4.0 3.4.1 6.11.0
args ^2.3.0 2.6.0 2.6.0
charcode ^1.3.1 1.3.1 1.3.1
cli_util ^0.3.5 0.3.5 0.4.2
collection ^1.15.0 1.19.1 1.19.1
crypto ^3.0.1 3.0.6 3.0.6
glob ^2.0.1 2.1.2 2.1.2
html ^0.15.0 0.15.5 0.15.5
logging ^1.0.2 1.3.0 1.3.0
markdown >=4.0.0 <6.0.0 5.0.0 7.2.2
meta ^1.7.0 1.16.0 1.16.0
package_config ^2.0.2 2.1.0 2.1.0
path ^1.8.0 1.9.1 1.9.1
pub_semver ^2.1.0 2.1.4 2.1.4
source_span ^1.8.1 1.10.0 1.10.0
yaml ^3.1.0 3.1.2 3.1.2
Transitive dependencies
Package Constraint Compatible Latest
_fe_analyzer_shared - 38.0.0 76.0.0
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
string_scanner - 1.4.0 1.4.0
term_glyph - 1.2.1 1.2.1
typed_data - 1.4.0 1.4.0
watcher - 1.1.0 1.1.0

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

Found 3 issues. Showing the first 2:

The constraint `^3.4.0` on analyzer does not support the stable version `4.0.0`.

Try running dart pub upgrade --major-versions analyzer to update the constraint.

The constraint `^0.3.5` on cli_util does not support the stable version `0.4.0`.

Try running dart pub upgrade --major-versions cli_util to update the constraint.

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

20/20 points: Compatible with dependency constraint lower bounds

pub downgrade does not expose any static analysis error.

Analyzed with Pana 0.22.15, Dart 3.5.4.

Check the analysis log for details.

← Metadata

208
likes
140
pub points
94%
popularity

Publisher

verified publishertools.dart.dev

Metadata

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

Repository (GitHub)
View/report issues
Contributing

Documentation

API reference

License

BSD-3-Clause (license)

Dependencies

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

More

Packages that depend on dartdoc

Back