Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

jQuery compatible JavaScript documentation generator

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.


Why Doesn't jQuery use JSDoc?

like image 502
clyfe Avatar asked Dec 21 '10 10:12

clyfe


1 Answers

I would rate jsduck from Sencha on top. I have used it on many projects. Simple to use

https://github.com/senchalabs/jsduck

A single command will generate docs like this http://docs.sencha.com/touch/2-0/

like image 50
Gaurav Jassal Avatar answered Sep 24 '22 13:09

Gaurav Jassal