Skip to content

Commit 28b7f8a

Browse files
committed
document --access flag (#88)
1 parent 353a172 commit 28b7f8a

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

about-commandline.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,12 @@ <h2>Table of Contents</h2>
4747
</tr>
4848
</thead>
4949
<tbody>
50+
<tr>
51+
<td><code>-a &lt;value&gt;</code>, <code>--access &lt;value&gt;</code>
52+
</td>
53+
<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>
55+
</tr>
5056
<tr>
5157
<td><code>-c &lt;value&gt;</code>, <code>--configure &lt;value&gt;</code>
5258
</td>
@@ -108,7 +114,7 @@ <h2>Table of Contents</h2>
108114
<tr>
109115
<td><code>-r</code>, <code>--recurse</code>
110116
</td>
111-
<td>Recurse into subdirectories when scanning for source files.</td>
117+
<td>Recurse into subdirectories when scanning for source files and tutorials.</td>
112118
</tr>
113119
<tr>
114120
<td><code>-R</code>, <code>--readme</code>

content/en/about-commandline.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,19 @@ given to JSDoc. The command-line options are:
2121

2222
Option|Description
2323
------|-----------
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.
2425
`-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.
2526
`-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`.
2627
`--debug`|Log information that can help debug issues in JSDoc itself. On Rhino, launches the debugger when passed as the first option.
2728
`-e <value>`, `--encoding <value>`|Assume this encoding when reading all source files. Defaults to `utf8`.
2829
`-h`, `--help`|Display information about JSDoc's command-line options, then exit.
2930
`--match <value>`|Only run tests whose names contain `value`.
3031
`--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.
3233
`-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.
3334
`--pedantic`|Treat errors as fatal errors, and treat warnings as errors. Defaults to `false`.
3435
`-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.
3637
`-R`, `--readme`|The `README.md` file to include in the generated documentation. Defaults to the first `README.md` file found in the source paths.
3738
`-t <value>`, `--template <value>`|The path to the template to use for generating output. Defaults to `templates/default`, JSDoc's built-in default template.
3839
`-T`, `--test`|Run JSDoc's test suite, and print the results to the console.
@@ -45,7 +46,7 @@ Option|Description
4546
[config-file]: about-configuring-jsdoc.html
4647
[including-readme]: about-including-readme.html
4748
[md-file]: http://daringfireball.net/projects/markdown/
48-
[tags-private]: tags-private.html
49+
[private-tag]: tags-private.html
4950
[tutorials]: about-tutorials.html
5051

5152

0 commit comments

Comments
 (0)