jQuery compatible JavaScript documentation generator
Posted
by
clyfe
on Stack Overflow
See other posts from Stack Overflow
or by clyfe
Published on 2010-12-21T10:20:31Z
Indexed on
2010/12/21
10:54 UTC
Read the original article
Hit count: 289
I need to choose a documentation generator (similar to jdoc in java or rdoc in ruby) for my javascript project that (built with jquery, underscore and backbone)
Candidates:
- jsdoc toolkit
- pdoc
- natural docs
- docco
- YUI doc
- doctool http://jquery.bassistance.de/docTool/docTool.html
- other ?
Requirements
- should work with jquery, underscore and backbone. that means object-literal methods etc
- I really like pdoc but its too centered around prototype, poorly documented, and I don't want to make extra files (sections?) to make it work (not sure about this)
- docco is nice but I want structured output (as in menu + class/func structure like jdoc)
- must be command line/makefile compatible (not web pastie)
Tips, tricks, tutorials, success stories, advice greatly welcomed.
© Stack Overflow or respective owner