search

prezi / spaghetti

Type-safe APIs for compile-to-JavaScript modules
http://prezi.github.io/spaghetti/
Other
32 stars 5 forks source link

Spaghettidoc tool #138

Open lptr opened 10 years ago

lptr commented 10 years ago

Something similar to Javadoc to generate HTML from the Spaghetti definition.

encse commented 10 years ago

+1

The PDOM guys already generate some kind of documentation from their API.

Then we can add a Jenkins job that generates the doc and pushes to github pages. That would be great I think.

encse commented 10 years ago

MobilEngine is using oxygen + dita and generates webhelp http://www.oxygenxml.com/xml_editor/webhelp.html. We could generate the necessary dita files from spaghetti, and run oxygen's xslt to generate the output.

Or we can also generate the input for dox which is a haxe documetnation tool, actually used by the PDOM team. It eats the output of the haxe compiler with the xml target. The dox tool is kind of limited, and it is not documented. It seems from the source that it supports javadoc keywords and markdown. The master/head understands some markdown stuff indeed, but I couldn't get the javadoc keywords (@param etc) work.