https://github.com/markknol/haxe-doc-stats
Are we documented yet? Code documentation coverage metrics for Haxe
https://github.com/markknol/haxe-doc-stats
documentation documentation-coverage haxe metrics statistics tool
Last synced: about 2 months ago
JSON representation
Are we documented yet? Code documentation coverage metrics for Haxe
- Host: GitHub
- URL: https://github.com/markknol/haxe-doc-stats
- Owner: markknol
- Created: 2016-06-21T20:26:14.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-06-16T10:22:13.000Z (almost 5 years ago)
- Last Synced: 2025-01-25T05:11:28.856Z (4 months ago)
- Topics: documentation, documentation-coverage, haxe, metrics, statistics, tool
- Language: Haxe
- Homepage:
- Size: 6.14 MB
- Stars: 17
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Haxe doc stats
> ### Are we documented yet?
Display how much your Haxe project is documented.
This generator uses Neko to generate a static page with stats about your Haxe project code documentation coverage. The tool is created to get more information about the Haxe Standard Library API documentation, but can be used for any project.
- Displays documentation amounts for types and its members (global and detailed per package)
- Packages can be expanded to see what is undocumented
## Preview
To see the stats of the Haxe Standard Library:
## How to use
Add `-xml xml/output.xml` to your project build configuration (hxml or compilation flags).
This will produce a .xml file in your project with documentation info which you'll need for this tool.
Put it in a folder and run the following command:
```
neko DocStats.n xml/
```
This will produce a `index.html` file in the _xml/_ folder.
---
For more specific use, there are more parameters:
```
neko DocStats.n arg0 arg1 arg2 arg3
[arg0] path to xml directory. default: 'xml/'
[arg1] path to output file. default: 'xml/index.html'
[arg2] path to template html-file. default: 'layout.html'
[arg3] path to log-file. default: 'xml/log.txt
```
## Details
These are the rules/definitions used by this statistics:
* "Types" can be classes, typedefs, abstracts, enums, interfaces.
* "Members" are fields, functions, statics, enum constructors.
* Everything that is private/override or has metadata `@:dox(hide)` or `@:noCompletion` gets skipped.
* The quality of the documentation is not measured.
* The colors work like this:
* higher than 75% is good
* lower than 10% is bad
## More
* The more documentation your project has, the better.
* Use [Dox](https://github.com/HaxeFoundation/dox) to generate API documentation for your project.