- -a <value> , --access <value>
- |
+ -a <value> , --access <value> |
Only display symbols with the given access property: private , protected , public , or undefined ,
or all for all access levels. By default, all except private symbols are shown. |
- -c <value> , --configure <value>
- |
+ -c <value> , --configure <value> |
The path to a JSDoc configuration file. Defaults to conf.json or conf.json.EXAMPLE in the directory where JSDoc is installed. |
- -d <value> , --destination <value>
- |
+ -d <value> , --destination <value> |
The path to the output folder for the generated documentation. For JSDoc's built-in Haruki template, use console to dump data to the console.
Defaults to ./out . |
- --debug
- |
+ --debug |
Log information that can help debug issues in JSDoc itself. |
- -e <value> , --encoding <value>
- |
+ -e <value> , --encoding <value> |
Assume this encoding when reading all source files. Defaults to utf8 . |
- -h , --help
- |
+ -h , --help |
Display information about JSDoc's command-line options, then exit. |
- --match <value>
- |
+ --match <value> |
Only run tests whose names contain value . |
- --nocolor
- |
+ --nocolor |
When running tests, do not use color in the console output. On Windows, this option is enabled by default. |
- -p , --private
- |
+ -p , --private |
Include symbols marked with the @private tag in the generated documentation. By default, private symbols are
not included. |
- -P , --package
- |
+ -P , --package |
The package.json file that contains the project name, version, and other details. Defaults to the first package.json file found
in the source paths. |
- --pedantic
- |
+ --pedantic |
Treat errors as fatal errors, and treat warnings as errors. Defaults to false . |
- -q <value> , --query <value>
- |
+ -q <value> , --query <value> |
A query string to parse and store in the global variable env.opts.query . Example: foo=bar&baz=true . |
- -r , --recurse
- |
+ -r , --recurse |
Recurse into subdirectories when scanning for source files and tutorials. |
- -R , --readme
- |
+ -R , --readme |
The README.md file to include in the generated documentation. Defaults to the first README.md file found in the source paths. |
- -t <value> , --template <value>
- |
+ -t <value> , --template <value> |
The path to the template to use for generating output. Defaults to templates/default , JSDoc's built-in default template. |
- -T , --test
- |
+ -T , --test |
Run JSDoc's test suite, and print the results to the console. |
- -u <value> , --tutorials <value>
- |
+ -u <value> , --tutorials <value> |
Directory in which JSDoc should search for tutorials. If omitted, no tutorial pages will be generated. See the tutorial instructions for more information. |
- -v , --version
- |
+ -v , --version |
Displays JSDoc's version number, then exits. |
- --verbose
- |
+ --verbose |
Log detailed information to the console as JSDoc runs. Defaults to false . |
- -X , --explain
- |
+ -X , --explain |
Dump all doclets to the console in JSON format, then exit. |
@@ -157,21 +140,18 @@