Using Haxedoc to generate documentation for my project

Question

I wrote my html5 game api with haxe and now I want to auto-generate the documentation from the comments in the code. However, I have no idea how to even get started on this. I want to try to use haxedoc but the only documentation I have is on this website and it's not very helpful at all: http://haxe.org/doc/haxedoc

When I run this command: haxe -xml output.xml build.hxml

it says build.hxml does not exist.

How do I get haxedoc to go through my project and generate the documentation? Specific steps are much appreciated.

Answer 1

You can create a .hxml to use for the documentation. How to create a .hxml is documented here http://haxe.org/doc/compiler#example