[haXe] Using haxedoc

[Danny Wilson]

On Tue, 26 Jun 2007 21:45:39 +0200, Erik VanBruken <iamkenzo at gmail.com>  
wrote:

> Hi list,
>
> I don't understand how to use haxedoc efficiently.
>
> 1) First I'd like to try and generate the doc for all the classes
> available to haxe, just like the online documentation API.
> [...]
The all.hxml also makes a all.xml or something, which has all platforms in  
it :)
Use that one.


> 3) I'd like to generate the documentation for the chat tutorial.
> [...]
> How to only generate
> doc that is relevant to the application only?
>
I dont know which classes/packages are in the chat tutorial, but you can  
use -f to filter with haxedoc, for example:

haxedoc myapp.xml -f package1 -f ClassName -f AnotherClass

If your app is in a single package you only need -f for the packagename :-)

>
> 4) Each time I have to copy the template.xml file to the folder in
> which I am generating the documentation, I'd like it to look for the
> file that is located in C:\Program
> FIles\motion-twin\haxe\...\tempalte.xml how to do that? My environment
> variables are well set, and I can issue haxedoc in the command line
> from any directory.
>

Well you usually want to change the template for your specific app ( like  
http://decube.net/haxormap/doc ). I don't know another solution but  
copying...