NAME
jsdoc2 - Automatic documentation generation tool for JavaScript
SYNOPSIS
jsdoc2 [OPTIONS] [<SRC_DIR>] [<SRC_FILE>] [...]
jsdoc2 --help
USAGE
A valid command line to run jsdoc2 might look like this:
jsdoc2 -a -t=templates/jsdoc mycode.js
DESCRIPTION
This manual page documents briefly the jsdoc2 command.
This manual page was written for the Debian distribution because the original program does not have a manual page.
jsdoc2 is an automatic documentation generation tool for JavaScript. It is written in JavaScript and is run from a command line (or terminal) and uses NodeJS.
Using this tool you can automatically turn JavaDoc-like comments in your JavaScript source code into published output files, such as HTML or XML.
OPTIONS
- -a, --allfunctions
-
Include all functions, even undocumented ones.
- -c, --conf
-
Load a configuration file.
- -d=PATH, --directory=PATH
-
Output to this directory (defaults to "out").
-D="myVar:My value", --define="myVar:My value"
Multiple. Define a variable, available in JsDoc as JSDOC.opt.D.myVar.
- -e=ENCODING, --encoding=ENCODING
-
Use this encoding to read and write files.
- -E=REGEX, --exclude=REGEX
-
Multiple. Exclude files based on the supplied regex.
- -h, --help
-
Show summary of options.
- -m, --multiples
-
Don't warn about symbols being documented more than once.
- -n, --nocode
-
Ignore all code, only document comments with @name tags.
- -o=PATH, --out=PATH
-
Print log messages to a file (defaults to stdout).
- -p, --private
-
Include symbols tagged as private, underscored and inner symbols.
- -q, --quiet
-
Do not output any messages, not even warnings.
- -r=DEPTH, --recurse=DEPTH
-
Descend into src directories.
- -s, --suppress
-
Suppress source code output.
- -S, --securemodules
-
Use Secure Modules mode to parse source code.
- -t=PATH, --template=PATH
-
Required. Use this template to format the output.
- -T, --test
-
Run all unit tests and exit.
- -u, --unique
-
Force file names to be unique, but not based on symbol names.
- -v, --verbose
-
Provide verbose feedback about what is happening.
- -x=<EXT>[,EXT]..., --ext=<EXT>[,EXT]...
-
Scan source files with the given extension/s (defaults to js).
AUTHOR
Georges Khaznadar <[email protected]>
Wrote this manpage for the Debian system.
COPYRIGHT
Copyright © 2024 georgesk
This manual page was written for the Debian system (and may be used by others).
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or (at your option) any later version published by the Free Software Foundation.
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.