Skip to content
Haxe documentation generator.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode Update the eval-debugger launch config Apr 8, 2019
src/dox Let Travis test a few more targets Apr 8, 2019
test Fix Travis + update formatting Feb 5, 2019
themes/default Fix some Java target compatibility issues Apr 8, 2019
.gitignore Add a .vscode config May 10, 2017
.travis.yml Activate PHP on Travis Apr 8, 2019
README.md Let's not recommend installing a 2 year old version Apr 17, 2019
RunTravis.hx Test the JVM target on Travis May 11, 2019
gen-test.hxml Remove -D xmldoc (obsolete) May 16, 2019
haxelib.hxml 1.0.0 Jun 18, 2014
haxelib.json Fix version number, add more contributors May 5, 2018
pages.hxml
run.hxml Add --interp for running dox via eval May 5, 2018
run.n Fix exit code handling Apr 8, 2019
runBase.hxml Null safety + other cleanup Feb 19, 2019
test.hxml Add test.hxml for easier testing Feb 19, 2016

README.md

Dox

Build Status

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

image

Installation

Install the library via haxelib:

haxelib git dox https://github.com/HaxeFoundation/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 docs/doc.xml -D doc-gen.
  2. Invoke haxelib run dox -i docs, 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

You can’t perform that action at this time.