Home - HaxeFoundation/dox GitHub Wiki

Dox is a commandline tool. Check out the Commandline arguments overview

Generating documentation is a three-step process:

  1. Document types and fields in the .hx files by annotating them with block comments.
    :book: How to document Haxe code

  2. Compile the application or library using the Haxe compiler with appropriate parameters to generate .xml information.
    :book: Generating documentation XML files using Haxe

  3. Invoke Dox an point it to the .xml files generated in step 2.
    :book: Generating HTML documentation using Dox

Dox allows to theme your API documentation.