An API documentation generator for JavaScript. http://usejsdoc.org (evacuated from NSA/Microsoft Github)

makenotabuggreatagain 1e60adb90c we don't need no CoC		5 anni fa
.github	383bfa5822 add issue and pull-request templates	7 anni fa
lib	932c3572fd Prefer copyFileSync from here over native (#1440)	7 anni fa
plugins	8ac05f56f5 convert Markdown in the summary property (#1149)	7 anni fa
templates	67e19bfc3a hide the signature in the heading for classes with hidden constructors (#1397)	7 anni fa
test	96f8875449 fix test breakage	7 anni fa
.editorconfig	a838f37d52 add editorconfig	10 anni fa
.eslintignore	621f012211 Remove Rhino support	9 anni fa
.eslintrc.json	510e890ae8 make JSDoc work on Node.js <5.10.0 (#1393)	7 anni fa
.gitignore	b56162489d update .gitignore	7 anni fa
.npmignore	82651819f1 update .npmignore	7 anni fa
.travis.yml	280d316fb0 update tested Node.js versions	7 anni fa
Apache_License_2.0.txt	1ad33e0e52 update license info and README files	12 anni fa
CHANGES.md	b21427343c 3.5.5 changelog	7 anni fa
CODE_OF_CONDUCT.md	1e60adb90c we don't need no CoC	5 anni fa
CONTRIBUTING.md	49ad746e49 trailing whitespace cleanup	10 anni fa
LICENSE.md	3b604fb7f9 update LICENSE	7 anni fa
README.md	8f2322f77c add Slack channel to README	7 anni fa
cli.js	77bd47f58a fix cli breakage	7 anni fa
conf.json.EXAMPLE	ebee2014ad look for JSX files by default (#1001)	9 anni fa
gulpfile.js	15b57e52f3 overhaul ESLint config; delint	7 anni fa
jsdoc.js	8b26b6d669 remove author tags, and clean up JSDoc comments without leading asterisks	7 anni fa
package.json	932c3572fd Prefer copyFileSync from here over native (#1440)	7 anni fa

JSDoc 3

An API documentation generator for JavaScript.

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

Installation and Usage

JSDoc supports Node.js 4.2.0 and later. You can install JSDoc globally or in your project's node_modules folder.

To install the latest version on npm globally (may require sudo; learn how to fix this):

npm install -g jsdoc

To install the latest version on npm locally and save it in your package's package.json file:

npm install --save-dev jsdoc

Note: By default, npm adds your package using the caret operator in front of the version number (for example, ^3.5.2). We recommend using the tilde operator instead (for example, ~3.5.2), which limits updates to the most recent patch-level version. See this Stack Overflow answer for more information about the caret and tilde operators.

To install the latest development version locally, without updating your project's package.json file:

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 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

Other Tools

For More Information

Documentation is available at Use JSDoc.
Contribute to the docs at jsdoc3/jsdoc3.github.com.
Join JSDoc's Slack channel.
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.

README.md