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

Published 2 years ago • verified publishertools.dart.dev• Latest: 9.0.4
SDKDartFlutter
PlatformAndroidiOSLinuxmacOSWindows
outdated
→

Metadata

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

More...

130/ 160
pub points
58.6k
downloads

We analyzed this package 2 days ago, and awarded it 130 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

151 out of 358 API elements (42.2 %) have documentation comments.

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

Passed check 10/10 points: Package has an example

Passed 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: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/generated/utilities_dart.dart that imports:
  • package:analyzer/src/dart/element/element.dart that imports:
  • package:analyzer/src/summary2/macro.dart that imports:
  • package:analyzer/src/summary2/kernel_compilation_service.dart that imports:
  • package:_fe_analyzer_shared/src/macros/compiler/request_channel.dart that imports:
  • dart:io
Failed report section
Pass static analysis
30 / 50trigger folding of the section

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

Found 10 issues. Showing the first 2:

WARNING: 'ExtensionTypeElement' is experimental and could be removed or changed at any time.

lib/src/model/extension_type.dart:13:9

   ╷
13 │   final ExtensionTypeElement element;
   │         ^^^^^^^^^^^^^^^^^^^^
   ╵

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

WARNING: 'extensionTypes' is experimental and could be removed or changed at any time.

lib/src/model/library.dart:90:28

   ╷
90 │         ...compilationUnit.extensionTypes,
   │                            ^^^^^^^^^^^^^^
   ╵

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

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

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

Package Constraint Compatible Latest Notes
analyzer ^6.3.0 6.4.1 12.0.0
args ^2.4.1 2.7.0 2.7.0
cli_util ^0.4.0 0.4.2 0.4.2
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.1.0 7.3.1 7.3.1
meta ^1.9.1 1.18.2 1.18.2
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.2 1.10.2
yaml ^3.1.2 3.1.3 3.1.3
Transitive dependencies
Package Constraint Compatible Latest Notes
_fe_analyzer_shared - 67.0.0 98.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.1 1.2.1

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

The constraint `^6.3.0` on analyzer does not support the stable version `7.0.0`.

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

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.23.11, Dart 3.11.2.

Check the analysis log for details.

Weekly downloads

Display as:
By versions:

← Metadata

237
likes
130
points
58.6k
downloads

Documentation

API reference

Publisher

verified publishertools.dart.dev

Weekly Downloads

Metadata

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

Repository (GitHub)
View/report issues
Contributing

License

BSD-3-Clause (license)

Dependencies

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

More

Packages that depend on dartdoc

Back