Dart doc coverage #

The Dart doc coverage tool examines a Dart library (or package), judging the comments of the public API. Dart doc coverage examines exactly the comments that will appear at dartdocs.org (e.g. path's docs)

0% means that a library or class has 0 comments on any methods, variables, etc.
100% means that a library or class has a comment for every method, variable, etc., and that each comment is formatted properly, according to some opinions.

Currently, Dart doc coverage examines the comments of:

libraries
classes
typedefs
errors
library-level functions
library-level variables
class-level methods (constructors, getters, setters, methods, operators)
class-level variables

In general, the formatting of comments is expected to follow the Guidelines for Dart Doc Comments. Specifically, the Dart doc coverage tool checks the following rules:

Rules #

The following should have a comment: classes, methods, getters, setters, operators, constructors, and variables.
The first paragraph of any comment should be a one-sentence description.
A method comment should have at least two paragraphs. A variable comment can have just one.
A comment should end with a period.

License #

Apache v2

Contributing #

Contributions welcome! Please read the contribution guidelines.

Disclaimer #

This is not an official Google product.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  doc_coverage: ^0.1.5

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:doc_coverage/doc_coverage_cli.dart';
import 'package:doc_coverage/doc_coverage_common.dart';
import 'package:doc_coverage/doc_coverage_frontend.dart';

Version	Uploaded	Documentation	Archive
0.1.5	May 6, 2015
0.1.4	Apr 20, 2015
0.1.3	Apr 19, 2015
0.1.2	Apr 14, 2015
0.1.1	Apr 3, 2015
0.1.0	Apr 3, 2015

Popularity: Describes how popular the package is relative to other packages. [more]	0
Health: Code health derived from static analysis. [more]	--
Maintenance: Reflects how tidy and up-to-date the package is. [more]	--
Overall: Weighted score of the above. [more]	0

Learn more about scoring.

The package version is not analyzed, because it does not support Dart 2. Until this is resolved, the package will receive a health and maintenance score of 0.

Analysis issues and suggestions

Support Dart 2 in pubspec.yaml.

The SDK constraint in pubspec.yaml doesn't allow the Dart 2.0.0 release. For information about upgrading it to be Dart 2 compatible, please see https://www.dartlang.org/dart-2#migration.

Maintenance issues and suggestions

Make sure dartdoc successfully runs on your package's source files. (-10 points)

Dependencies were not resolved.

Dart pub

doc_coverage 0.1.5