-
Notifications
You must be signed in to change notification settings - Fork 36
Generating HTML documentation using Dox
Mark Knol edited this page Aug 3, 2016
·
2 revisions
With the XML files in place, everything is ready for the Dox invocation. For this we have to tell it two main things:
- Where to find the XMLs by using the
-i path
argument. - Where to output documentation to using the
-o path
argument.
Assuming our XML files from step 2 ended up in bin
and we want to generate our output to bin/pages
, the command would be haxelib run dox -i bin -o bin/pages
.
Dox has several command line arguments and prints its usage options by running haxelib run dox
without any arguments.
Learn Haxe: Introduction | Manual | API | Try Haxe | Haxe Library Manager | Code Cookbook
Connect: GitHub | Stack Overflow | Forum | Chat | Twitter | Facebook