Analyze your Dart project for public elements missing documentation.
git clone https://github.com/adamhammes-wf/docs_analyzer.git cd docs_analyzer pub get pub run docs_analyzer <project_path>
docs_analyzer <project_path> Run docs_analyzer on the project located at <project_path> docs_analyzer Run docs_analyzer on the current directory docs_analyzer --help Show this screen
Add this to your package's pubspec.yaml file:
dependencies: docs_analyzer: "^0.2.0"
You can install packages from the command line:
$ pub get
$ flutter packages get
Alternatively, your editor might support
pub get or
Check the docs for your editor to learn more.
Now in your Dart code, you can use:
|0.2.0||Aug 11, 2016|
|0.1.0||Jul 7, 2016||failed|
We analyzed this package on Apr 23, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Detected platforms: Flutter, other
Changelog entries help clients to follow the progress in your code.
The description is too short.
Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.
Package is pre-v1 release.
While there is nothing inherently wrong with versions of
0.*.*, it usually means that the author is still experimenting with the general direction API.
Maintain an example.
Create a short demo in the
example/directory to show how to use this package. Common file name patterns include:
example.dartor you could also use
Fix analysis and formatting issues.
Analysis or formatting checks reported 3 hints.
|Dart SDK||>=1.17.1 <2.0.0|