Haxe CSS JavaScript

README.md

Dox

A Haxe documentation generator used by many popular projects such as:

image

Installation

Install the library via haxelib:

haxelib install dox 

Usage

Note: Dox requires Haxe 3.1 or higher due to some minor changes in abstract rtti xml generation. You'll also need an up-to-date haxelib (requires support for classPath in haxelib.json)

  1. Compile all relevant code with Haxe using haxe -xml dir.
  2. Invoke haxelib run dox -i dir, where dir points to the .xml file(s) generated by step 1.

📋 For more details, custom theme creation and options check out the Dox wiki