Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
An API documentation generator for JavaScript.
Failed to load latest commit information.
lib/jsdoc ignore SpreadElement nodes (#555)
node fix Windows path issues and static-file copying (#785)
node_modules update Espree and LICENSE file
plugins turn `env` global into a module, and use the module instead of the gl…
rhino turn `env` global into a module, and use the module instead of the gl…
templates turn `env` global into a module, and use the module instead of the gl…
test fix build breakage on Rhino parser
.editorconfig add editorconfig
.eslintignore enable lint-checking for tests; delint/cleanup tests
.eslintrc update ESLint config
.gitignore switch from Esprima to Espree (#555)
.npmignore switch from Grunt to gulp
.travis.yml switch from Grunt to gulp
Apache_License_2.0.txt update license info and README files
CHANGES.md update changelog
CONTRIBUTING.md trailing whitespace cleanup
LICENSE.md update Espree and LICENSE file
README.md move font stuff to the correct README
cli.js modify `dumper.dump()` to support multiple arguments; only define the…
conf.json.EXAMPLE remove jsVersion config property (#390)
gulpfile.js change ID for pure JS parser to 'js'; remove half-baked ability to us…
jsdoc remove URI-conversion and dirname-specification cruft
jsdoc.cmd fix "module not found" errors on Windows (#533)
jsdoc.js modify `dumper.dump()` to support multiple arguments; only define the…
package.json update Espree and LICENSE file

README.md

JSDoc 3

Build Status

An API documentation generator for JavaScript.

Want to contribute to JSDoc? Please read CONTRIBUTING.md.

Installation and Usage

You can run JSDoc on either Node.js or Mozilla Rhino.

Node.js

Native support for Node.js is available in JSDoc 3.3.0 and later. JSDoc supports Node.js 0.10 and later.

Installing JSDoc for Node.js

You can install JSDoc in your project's node_modules folder, or you can install it globally.

To install the latest alpha version:

npm install jsdoc@"<=3.3.0"

To install the latest development version:

npm install git+https://github.com/jsdoc3/jsdoc.git

Running JSDoc with Node.js

If you installed JSDoc locally, the JSDoc command-line tool is available in ./node_modules/.bin. To generate documentation for the file yourJavaScriptFile.js:

./node_modules/.bin/jsdoc yourJavaScriptFile.js

Or if you installed JSDoc globally, simply run the jsdoc command:

jsdoc yourJavaScriptFile.js

By default, the generated documentation is saved in a directory named out. You can use the --destination (-d) option to specify another directory.

Run jsdoc --help for a complete list of command-line options.

Mozilla Rhino

All versions of JSDoc 3 run on a customized version of Mozilla Rhino, which requires Java. You can run JSDoc 3 on Java 1.6 and later.

Installing JSDoc for Mozilla Rhino

To install JSDoc, download a .zip file for the latest development version or a previous release.

You can also use git to clone the JSDoc repository:

git clone git+https://github.com/jsdoc3/jsdoc.git

The JSDoc repository includes a customized version of Mozilla Rhino. Make sure your Java classpath does not include any other versions of Rhino. (On OS X, you may need to remove the file ~/Library/Java/Extensions/js.jar.)

Note: In JSDoc 3.3.0 and later, if you need to run JSDoc on Mozilla Rhino, do not install JSDoc with npm. Use one of the methods described above.

Running JSDoc with Mozilla Rhino

On OS X, Linux, and other POSIX systems, to generate documentation for the file yourJavaScriptFile.js:

./jsdoc yourJavaScriptFile.js

Or on Windows:

jsdoc yourJavaScriptFile.js

By default, the generated documentation is saved in a directory named out. You can use the --destination (-d) option to specify another directory.

Run jsdoc --help for a complete list of command-line options.

Templates and Build Tools

The JSDoc community has created numerous templates and other tools to help you generate and customize your documentation. Here are just a few:

Templates

Build Tools

For More Information

License

JSDoc 3 is copyright (c) 2011-2014 Michael Mathews micmath@gmail.com and the contributors to JSDoc.

JSDoc 3 is free software, licensed under the Apache License, Version 2.0. See the file LICENSE.md in this distribution for more details.

Something went wrong with that request. Please try again.