[haXe] haXe Wiki

[Nicolas Cannasse]

peter gerstmann wrote:
> 
> hello,
> 
> i would like to help with the API documentation, but how are you 
> planning to do it / what can i do?
> 
> my thought would be to add API comments to the .hx files in the /flash 
> and /std directories, and then use natural docs to generate the API 
> documentation.
> 
> would that mean i'd need to modify the files in cvs? is that something i 
> can do? is there a different method you had in mind? (pardon my noobie-ism)
> 
> thanks,
> -p

Hello Peter,

Right now the following API are available :

- the "flash" directory have flash APIs, they are already fully 
documented on the MM livedocs website. I'm not sure that we should make 
documentation for thoses.

- the "std" directory contain the standard APIs which should be 
documented. For example the Array class is little different from the one 
used in Flash.

Right now there is no "haxeDoc" tool but this will be a standard feature 
of the compiler for 1.0 : basicly, you will be able to output an XML 
containing all compiled classes and enums with all variable/methods 
types. This will also include the /** ... **/ comments that were placed 
before the variable/method if any.

Of course you'll have to add another tool for processing this XML into 
nice syntax colored HTML.

As for now, I'm looking for someone that will write the JavaScript 
"extern" (browser) classes with documentation. It might be a lot of work 
and it would be nice to get some good existing reference. Any links ?

Nicolas