Package Exports

jsdoc/cli
jsdoc/cli.js
jsdoc/jsdoc
jsdoc/jsdoc.js
jsdoc/lib/jsdoc/app
jsdoc/lib/jsdoc/app.js
jsdoc/lib/jsdoc/augment
jsdoc/lib/jsdoc/borrow
jsdoc/lib/jsdoc/config
jsdoc/lib/jsdoc/env
jsdoc/lib/jsdoc/fs
jsdoc/lib/jsdoc/name
jsdoc/lib/jsdoc/path
jsdoc/lib/jsdoc/plugins
jsdoc/lib/jsdoc/src/filter
jsdoc/lib/jsdoc/src/handlers
jsdoc/lib/jsdoc/src/parser
jsdoc/lib/jsdoc/src/scanner
jsdoc/lib/jsdoc/template
jsdoc/lib/jsdoc/util/dumper
jsdoc/lib/jsdoc/util/error
jsdoc/lib/jsdoc/util/logger
jsdoc/lib/jsdoc/util/runtime
jsdoc/lib/jsdoc/util/templateHelper
jsdoc/package
jsdoc/package.json
jsdoc/plugins/markdown

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (jsdoc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

JSDoc 3

An API documentation generator for JavaScript.

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

Installation and Usage

JSDoc supports Node.js 0.10 and later. You can install JSDoc in your project's node_modules folder, or you can install it globally.

To install the latest version available on NPM:

npm install jsdoc

To install the latest development version:

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

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.

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

Documentation is available at Use JSDoc.
Contribute to the docs at jsdoc3/jsdoc3.github.com.
Ask for help on the JSDoc Users mailing list.
Post questions tagged jsdoc to Stack Overflow.

License

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