Skip to content
An automatic documentation generator for JavaScript.
Pull request Compare This branch is 1601 commits behind jsdoc3:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
build
examples
modules
templates
test
LICENSE.md
README.md
build.xml
changes.md
config.json
main.js
package.json

README.md

JSDoc 3

This is pre-release software, under active development. It is not intended for general use.

Install

To build the jsdoc jar that runs JSDoc 3, use the ant build tool.

$ cd JSDoc
$ ant

This will create a file name jsdoc.jar in the project base directory.

To test that the installed app is working, execute the following:

$ java -jar jsdoc.jar -T

Usage

This example assumes your working directory is the JSDoc project base directory...

$ java -jar jsdoc.jar -d stdout yourSourceCode.js

For help regarding the supported commandline options use -h.

$ java -jar jsdoc.jar -h

See

Project Wiki: http://code.google.com/p/jsdoc/w/list

License

JSDoc 3 is copyright (c) 2010 Michael Mathews micmath@gmail.com

See file "LICENSE.md" in this distribution for more details about terms of use.

Something went wrong with that request. Please try again.