Tw1ddle/geometrize-haxe

View on GitHub
dox/README.md

Summary

Maintainability
Test Coverage
# Geometrize Haxe Dox

Documentation generation for Geometrize Haxe.

This project generates the Geometrize Haxe documentation using [dox](https://github.com/HaxeFoundation/dox), the Haxe documentation generator.

## Usage

Run ```generate_docs.sh``` and open ```index.html``` under the ```generated_docs``` folder to see the generated documentation.

## Notes
When bumping the library version number, remember to update the ```--version``` parameter in ```generate_docs.sh``` to match.