Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spaghettidoc tool #138

Open
lptr opened this issue Sep 15, 2014 · 2 comments
Open

Spaghettidoc tool #138

lptr opened this issue Sep 15, 2014 · 2 comments

Comments

@lptr
Copy link
Contributor

lptr commented Sep 15, 2014

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

@encse
Copy link
Contributor

encse commented Sep 26, 2014

+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
Copy link
Contributor

encse commented Sep 29, 2014

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants