dartdoc 7.0.2
dartdoc: ^7.0.2 copied to clipboard

Published 6 months ago •

tools.dart.devDart 3 compatible• Latest: 8.0.9

SDKDart Flutter

PlatformAndroid iOS Linux macOS Windows

192

→

Metadata

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

More...

192

likes

130/ 140

pub points

94%

popularity

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

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 339 API elements (45.1 %) have documentation comments.

Some symbols that are missing documentation: dartdoc.CategoryConfiguration.empty, dartdoc.CategoryConfiguration.fromYamlMap, dartdoc.ConvertYamlToType, dartdoc.DartDocResolvedLibrary.element, dartdoc.DartDocResolvedLibrary.units.

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: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: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

Pass static analysis

40 / 50

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

Found 10 issues. Showing the first 2:

INFO: 'variable' is deprecated and shouldn't be used. Use variable2.

lib/src/model/accessor.dart:57:40

   ╷
57 │       modelBuilder.fromElement(element.variable) as GetterSetterCombo;
   │                                        ^^^^^^^^
   ╵

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

INFO: 'variable' is deprecated and shouldn't be used. Use variable2.

lib/src/model/annotation.dart:38:34

   ╷
38 │     PropertyAccessorElement(:var variable) =>
   │                                  ^^^^^^^^
   ╵

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

Support up-to-date dependencies

20 / 20

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

Package	Constraint	Compatible	Latest
`analyzer`	`^6.3.0`	6.5.0	6.5.0
`args`	`^2.4.1`	2.5.0	2.5.0
`cli_util`	`^0.4.0`	0.4.1	0.4.1
`collection`	`^1.17.0`	1.18.0	1.18.0
`crypto`	`^3.0.3`	3.0.3	3.0.3
`glob`	`^2.1.1`	2.1.2	2.1.2
`html`	`^0.15.3`	0.15.4	0.15.4
`logging`	`^1.1.1`	1.2.0	1.2.0
`markdown`	`^7.1.0`	7.2.2	7.2.2
`meta`	`^1.9.1`	1.15.0	1.15.0
`package_config`	`^2.1.0`	2.1.0	2.1.0
`path`	`^1.8.3`	1.9.0	1.9.0
`pub_semver`	`^2.1.4`	2.1.4	2.1.4
`source_span`	`^1.10.0`	1.10.0	1.10.0
`yaml`	`^3.1.2`	3.1.2	3.1.2

Transitive dependencies

Package	Constraint	Compatible	Latest
`_fe_analyzer_shared`	-	68.0.0	68.0.0
`_macros`	-	0.1.0	0.1.0
`async`	-	2.11.0	2.11.0
`convert`	-	3.1.1	3.1.1
`csslib`	-	1.0.0	1.0.0
`file`	-	7.0.0	7.0.0
`macros`	-	0.1.0-main.0	0.1.0-main.5
`string_scanner`	-	1.2.0	1.2.0
`term_glyph`	-	1.2.1	1.2.1
`typed_data`	-	1.3.2	1.3.2
`watcher`	-	1.1.0	1.1.0