Generating documentation for haxe generated js


(Ronan) #1

While dox is a nice tool to generate api documentation for Haxe users, I am looking for a tool that can generate api documentation oriented towards javascript users

Does anybody know any ?

To people having their lib used by javascript user, what is your strategy to deal with documentation ?

(Jens Fischer) #2

What does that mean exactly?

(Ronan) #3

Currently the doc is generated with haxe “speak” :

  • constructor is named “new”
  • classes are grouped in "packages
  • type name are CamelCase following Haxe convention

These are not big differences but can be confusing for a js developers

(Jens Fischer) #4

Dox has templates that are quite customizable, you could give that a try: