Skip to content

Commit 780ab1c

Browse files
committed
document 3.3.0 changes to command-line options (#64)
1 parent b17504a commit 780ab1c

File tree

2 files changed

+27
-9
lines changed

2 files changed

+27
-9
lines changed

about-commandline.html

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,11 @@ <h2>Table of Contents</h2>
5858
<td>The path to the output folder for the generated documentation. For JSDoc&#39;s built-in Haruki template, use <code>console</code> to dump data to the console.
5959
Defaults to <code>./out</code>.</td>
6060
</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>
65+
</tr>
6166
<tr>
6267
<td><code>-e &lt;value&gt;</code>, <code>--encoding &lt;value&gt;</code>
6368
</td>
@@ -68,12 +73,6 @@ <h2>Table of Contents</h2>
6873
</td>
6974
<td>Display information about JSDoc&#39;s command-line options, then exit.</td>
7075
</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>
7776
<tr>
7877
<td><code>--match &lt;value&gt;</code>
7978
</td>
@@ -90,6 +89,17 @@ <h2>Table of Contents</h2>
9089
<td>Include symbols marked with the <a href="tags-private.html"><code>@private</code> tag</a> in the generated documentation. By default, private symbols are
9190
not included.</td>
9291
</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>
102+
</tr>
93103
<tr>
94104
<td><code>-q &lt;value&gt;</code>, <code>--query &lt;value&gt;</code>
95105
</td>
@@ -100,6 +110,11 @@ <h2>Table of Contents</h2>
100110
</td>
101111
<td>Recurse into subdirectories when scanning for source files.</td>
102112
</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>
117+
</tr>
103118
<tr>
104119
<td><code>-t &lt;value&gt;</code>, <code>--template &lt;value&gt;</code>
105120
</td>
@@ -123,7 +138,7 @@ <h2>Table of Contents</h2>
123138
<tr>
124139
<td><code>--verbose</code>
125140
</td>
126-
<td>When running tests, write the test names and descriptions to the console.</td>
141+
<td>Log detailed information to the console as JSDoc runs. Defaults to <code>false</code>.</td>
127142
</tr>
128143
<tr>
129144
<td><code>-X</code>, <code>--explain</code>

content/en/about-commandline.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,22 @@ Option|Description
2323
------|-----------
2424
`-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.
2525
`-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.
2627
`-e <value>`, `--encoding <value>`|Assume this encoding when reading all source files. Defaults to `utf8`.
2728
`-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.
2929
`--match <value>`|Only run tests whose names contain `value`.
3030
`--nocolor`|When running tests, do not use color in the console output. On Windows, this option is enabled by default.
3131
`-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`.
3234
`-q <value>`, `--query <value>`|A query string to parse and store in the global variable `env.opts.query`. Example: `foo=bar&baz=true`.
3335
`-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.
3437
`-t <value>`, `--template <value>`|The path to the template to use for generating output. Defaults to `templates/default`, JSDoc's built-in default template.
3538
`-T`, `--test`|Run JSDoc's test suite, and print the results to the console.
3639
`-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.
3740
`-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`.
3942
`-X`, `--explain`|Dump all doclets to the console in JSON format, then exit.
4043

4144

0 commit comments

Comments
 (0)