Skip to content

Commit f0c3227

Browse files
irgendwrtmcw
irgendwr
authored and
tmcw
committed
docs(readme, usage): updated help command/message (documentationjs#994)
1 parent 4bb2047 commit f0c3227

File tree

2 files changed

+50
-46
lines changed

2 files changed

+50
-46
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ $ npm install -g documentation
4747

4848
This installs a command called `documentation` in your path, that you can
4949
point at [JSDoc](http://usejsdoc.org/)-annotated source code to generate
50-
human-readable documentation. First run `documentation` with the `-h`
50+
human-readable documentation. First run `documentation` with the `--help`
5151
option for help:
5252

5353
```sh

‎docs/USAGE.md

Lines changed: 49 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -7,56 +7,60 @@ $ npm install -g documentation
77
```
88

99
`documentation` then installs a command called `documentation`. Run it with
10-
`-h` to get help.
10+
`--help` or `--help <command>` to get help.
1111

12-
```sh
13-
Usage: documentation <command> [options]
14-
15-
Commands:
16-
build build documentation
17-
serve generate, update, and display HTML documentation
18-
lint check for common style and uniformity mistakes
19-
readme inject documentation into your README.md
12+
```
13+
$ documentation --help build
2014
2115
Options:
22-
--help Show help [boolean]
23-
--version Show version number [boolean]
24-
--shallow shallow mode turns off dependency resolution, only
25-
processing the specified files (or the main script
26-
specified in package.json) [boolean] [default: false]
27-
--config, -c configuration file. an array defining explicit sort order
28-
--external a string / glob match pattern that defines which external
29-
modules will be whitelisted and included in the generated
30-
documentation. [default: null]
31-
--extension, -e only input source files matching this extension will be
32-
parsed, this option can be used multiple times.
33-
--private, -p generate documentation tagged as private
16+
--version Show version number [boolean]
17+
--help Show help [boolean]
18+
--theme, -t specify a theme: this must be a valid theme module
19+
--project-name project name. by default, inferred from
20+
package.json
21+
--project-version project version. by default, inferred from
22+
package.json
23+
--project-homepage project homepage. by default, inferred from
24+
package.json
25+
--watch, -w watch input files and rebuild documentation when
26+
they change [boolean]
27+
--markdown-toc include a table of contents in markdown output
28+
[boolean] [default: true]
29+
--shallow shallow mode turns off dependency resolution, only
30+
processing the specified files (or the main script
31+
specified in package.json)
3432
[boolean] [default: false]
35-
--access, -a Include only comments with a given access level, out of
36-
private, protected, public, undefined. By default,
37-
public, protected, and undefined access levels are
38-
included
39-
[choices: "public", "private", "protected", "undefined"]
40-
--github, -g infer links to github in documentation [boolean]
41-
--infer-private Infer private access based on the name. This is a regular
42-
expression that is used to match the name [string]
43-
--document-exported Generate documentation for all exported bindings and
44-
members even if there is no JSDoc for them
33+
--config, -c configuration file. an array defining explicit sort
34+
order [string]
35+
--no-package, --np dont find and use package.json for project-
36+
configuration option defaults
4537
[boolean] [default: false]
46-
--sort-order The order to sort the documentation
38+
--external a string / glob match pattern that defines which
39+
external modules will be whitelisted and included
40+
in the generated documentation. [default: null]
41+
--require-extension, --re additional extensions to include in require() and
42+
import's search algorithm.For instance, adding .es5
43+
would allow require("adder") to find "adder.es5"
44+
--parse-extension, --pe additional extensions to parse as source code.
45+
--private, -p generate documentation tagged as private
46+
[boolean] [default: false]
47+
--access, -a Include only comments with a given access level,
48+
out of private, protected, public, undefined. By
49+
default, public, protected, and undefined access
50+
levels are included
51+
[array] [choices: "public", "private", "protected", "undefined"]
52+
--github, -g infer links to github in documentation [boolean]
53+
--infer-private Infer private access based on the name. This is a
54+
regular expression that is used to match the name
55+
[string]
56+
--document-exported Generate documentation for all exported bindings
57+
and members even if there is no JSDoc for them
58+
[boolean] [default: false]
59+
--sort-order The order to sort the documentation
4760
[choices: "source", "alpha"] [default: "source"]
48-
--theme, -t specify a theme: this must be a valid theme module
49-
--name project name. by default, inferred from package.json
50-
--watch, -w watch input files and rebuild documentation when they
51-
change [boolean]
52-
--project-version project version. by default, inferred from package.json
53-
--output, -o output location. omit for stdout, otherwise is a filename
54-
for single-file outputs and a directory name for
55-
multi-file outputs like html [default: "stdout"]
61+
--output, -o output location. omit for stdout, otherwise is a
62+
filename for single-file outputs and a directory
63+
name for multi-file outputs like html
64+
[default: "stdout"]
5665
--format, -f [choices: "json", "md", "remark", "html"] [default: "json"]
57-
58-
Examples:
59-
documentation build foo.js -f md > parse documentation in a file and
60-
API.md generate API documentation as
61-
Markdown
6266
```

0 commit comments

Comments
 (0)