You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<td>Only display symbols with the given <code>access</code> property: <code>private</code>, <code>protected</code>, <code>public</code>, or <code>undefined</code>,
54
+
or <code>all</code> for all access levels. By default, all except <code>private</code> symbols are shown.</td>
Copy file name to clipboardExpand all lines: content/en/about-commandline.md
+4-3Lines changed: 4 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -21,18 +21,19 @@ given to JSDoc. The command-line options are:
21
21
22
22
Option|Description
23
23
------|-----------
24
+
`-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.
24
25
`-c <value>`, `--configure <value>`|The path to a JSDoc [configuration file][config-file]. Defaults to `conf.json` or `conf.json.EXAMPLE` in the directory where JSDoc is installed.
25
26
`-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`.
26
27
`--debug`|Log information that can help debug issues in JSDoc itself. On Rhino, launches the debugger when passed as the first option.
27
28
`-e <value>`, `--encoding <value>`|Assume this encoding when reading all source files. Defaults to `utf8`.
28
29
`-h`, `--help`|Display information about JSDoc's command-line options, then exit.
29
30
`--match <value>`|Only run tests whose names contain `value`.
30
31
`--nocolor`|When running tests, do not use color in the console output. On Windows, this option is enabled by default.
31
-
`-p`, `--private`|Include symbols marked with the [`@private` tag][tags-private] in the generated documentation. By default, private symbols are not included.
32
+
`-p`, `--private`|Include symbols marked with the [`@private` tag][private-tag] in the generated documentation. By default, private symbols are not included.
32
33
`-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.
33
34
`--pedantic`|Treat errors as fatal errors, and treat warnings as errors. Defaults to `false`.
34
35
`-q <value>`, `--query <value>`|A query string to parse and store in the global variable `env.opts.query`. Example: `foo=bar&baz=true`.
35
-
`-r`, `--recurse`|Recurse into subdirectories when scanning for source files.
36
+
`-r`, `--recurse`|Recurse into subdirectories when scanning for source files and tutorials.
36
37
`-R`, `--readme`|The `README.md` file to include in the generated documentation. Defaults to the first `README.md` file found in the source paths.
37
38
`-t <value>`, `--template <value>`|The path to the template to use for generating output. Defaults to `templates/default`, JSDoc's built-in default template.
38
39
`-T`, `--test`|Run JSDoc's test suite, and print the results to the console.
0 commit comments