jQuery compatible JavaScript documentation generator

javascript jquery documentation-generation jsdoc
clyfe picture clyfe · Dec 21, 2010 · Viewed 8.8k times · Source

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:

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?

Answer

Gaurav Jassal picture Gaurav Jassal · Aug 9, 2012

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/

Related questions

How do I redirect to another webpage?

How can I redirect the user from one page to another using jQuery or pure JavaScript?

Read More
Why does my JavaScript code receive a "No 'Access-Control-Allow-Origin' header is present on the requested resource" error, while Postman does not?

Mod note: This question is about why Postman is not subject to CORS restrictions in the same way an XMLHttpRequest is. This question is not about how to fix a "No 'Access-Control-Allow-Origin'..." error. Please stop posting: CORS configurations for every …

Read More
How do I check whether a checkbox is checked in jQuery?

I need to check the checked property of a checkbox and perform an action based on the checked property using jQuery. For example, if the age checkbox is checked, then I need to show a textbox to enter age, else …

Read More