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
Copy file name to clipboardExpand all lines: about-commandline.html
+22-7Lines changed: 22 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -58,6 +58,11 @@ <h2>Table of Contents</h2>
58
58
<td>The path to the output folder for the generated documentation. For JSDoc's built-in Haruki template, use <code>console</code> to dump data to the console.
59
59
Defaults to <code>./out</code>.</td>
60
60
</tr>
61
+
<tr>
62
+
<td><code>--debug</code>
63
+
</td>
64
+
<td>Log information that can help debug issues in JSDoc itself. On Rhino, launches the debugger when passed as the first option.</td>
<td>Display information about JSDoc's command-line options, then exit.</td>
70
75
</tr>
71
-
<tr>
72
-
<td><code>-l</code>, <code>--lenient</code>
73
-
</td>
74
-
<td>Try to generate documentation even if an error occurs (for example, if a tag is missing a required value). By default, if an error occurs, JSDoc exits
75
-
immediately.</td>
76
-
</tr>
77
76
<tr>
78
77
<td><code>--match <value></code>
79
78
</td>
@@ -90,6 +89,17 @@ <h2>Table of Contents</h2>
90
89
<td>Include symbols marked with the <ahref="tags-private.html"><code>@private</code> tag</a> in the generated documentation. By default, private symbols are
91
90
not included.</td>
92
91
</tr>
92
+
<tr>
93
+
<td><code>-P</code>, <code>--package</code>
94
+
</td>
95
+
<td>The <code>package.json</code> file that contains the project name, version, and other details. Defaults to the first <code>package.json</code> file found
96
+
in the source paths.</td>
97
+
</tr>
98
+
<tr>
99
+
<td><code>--pedantic</code>
100
+
</td>
101
+
<td>Treat errors as fatal errors, and treat warnings as errors. Defaults to <code>false</code>.</td>
<td>Recurse into subdirectories when scanning for source files.</td>
102
112
</tr>
113
+
<tr>
114
+
<td><code>-R</code>, <code>--readme</code>
115
+
</td>
116
+
<td>The <code>README.md</code> file to include in the generated documentation. Defaults to the first <code>README.md</code> file found in the source paths.</td>
Copy file name to clipboardExpand all lines: content/en/about-commandline.md
+5-2Lines changed: 5 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -23,19 +23,22 @@ Option|Description
23
23
------|-----------
24
24
`-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
25
`-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
+
`--debug`|Log information that can help debug issues in JSDoc itself. On Rhino, launches the debugger when passed as the first option.
26
27
`-e <value>`, `--encoding <value>`|Assume this encoding when reading all source files. Defaults to `utf8`.
27
28
`-h`, `--help`|Display information about JSDoc's command-line options, then exit.
28
-
`-l`, `--lenient`|Try to generate documentation even if an error occurs (for example, if a tag is missing a required value). By default, if an error occurs, JSDoc exits immediately.
29
29
`--match <value>`|Only run tests whose names contain `value`.
30
30
`--nocolor`|When running tests, do not use color in the console output. On Windows, this option is enabled by default.
31
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`, `--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
+
`--pedantic`|Treat errors as fatal errors, and treat warnings as errors. Defaults to `false`.
32
34
`-q <value>`, `--query <value>`|A query string to parse and store in the global variable `env.opts.query`. Example: `foo=bar&baz=true`.
33
35
`-r`, `--recurse`|Recurse into subdirectories when scanning for source files.
36
+
`-R`, `--readme`|The `README.md` file to include in the generated documentation. Defaults to the first `README.md` file found in the source paths.
34
37
`-t <value>`, `--template <value>`|The path to the template to use for generating output. Defaults to `templates/default`, JSDoc's built-in default template.
35
38
`-T`, `--test`|Run JSDoc's test suite, and print the results to the console.
36
39
`-u <value>`, `--tutorials <value>`|Directory in which JSDoc should search for tutorials. If omitted, no tutorial pages will be generated. See the [tutorial instructions][tutorials] for more information.
37
40
`-v`, `--version`|Displays JSDoc's version number, then exits.
38
-
`--verbose`|When running tests, write the test names and descriptions to the console.
41
+
`--verbose`|Log detailed information to the console as JSDoc runs. Defaults to `false`.
39
42
`-X`, `--explain`|Dump all doclets to the console in JSON format, then exit.
0 commit comments