Skip to content

Commit

Permalink
chore: check in updates from npm run build on master
Browse files Browse the repository at this point in the history
  • Loading branch information
DavideDaniel committed Nov 19, 2021
1 parent 2ca0f14 commit 8d65e43
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/NODE_API.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ of lint information intended for human-readable output.
that defines what external modules will be whitelisted and included in the
generated documentation.
* `args.shallow` **[boolean][20]** whether to avoid dependency parsing
even in JavaScript code. (optional, default `false`)
even in JavaScript code. (optional, default `false`)
* `args.inferPrivate` **[string][18]?** a valid regular expression string
to infer whether a code element should be private, given its naming structure.
For instance, you can specify `inferPrivate: '^_'` to automatically treat
Expand Down Expand Up @@ -71,14 +71,14 @@ comments, given a root file as a path.
that defines what external modules will be whitelisted and included in the
generated documentation.
* `args.shallow` **[boolean][20]** whether to avoid dependency parsing
even in JavaScript code. (optional, default `false`)
even in JavaScript code. (optional, default `false`)
* `args.order` **[Array][17]<([string][18] | [Object][19])>** optional array that
defines sorting order of documentation (optional, default `[]`)
defines sorting order of documentation&#x20;(optional, default `[]`)
* `args.access` **[Array][17]<[string][18]>** an array of access levels
to output in documentation (optional, default `[]`)
to output in documentation&#x20;(optional, default `[]`)
* `args.hljs` **[Object][19]?** hljs optional args

* `args.hljs.highlightAuto` **[boolean][20]** hljs automatically detect language (optional, default `false`)
* `args.hljs.highlightAuto` **[boolean][20]** hljs automatically detect language&#x20;(optional, default `false`)
* `args.hljs.languages` **[Array][17]?** languages for hljs to choose from
* `args.inferPrivate` **[string][18]?** a valid regular expression string
to infer whether a code element should be private, given its naming structure.
Expand Down Expand Up @@ -120,7 +120,7 @@ Formats documentation as HTML.
* `comments` **[Array][17]<[Comment][22]>** parsed comments
* `config` **[Object][19]** Options that can customize the output

* `config.theme` **[string][18]** Name of a module used for an HTML theme. (optional, default `'default_theme'`)
* `config.theme` **[string][18]** Name of a module used for an HTML theme.&#x20;(optional, default `'default_theme'`)

### Examples

Expand Down Expand Up @@ -181,7 +181,7 @@ documentation.build(['index.js'])
});
```

Returns **[Promise][21]<[string][18]>**
Returns **[Promise][21]<[string][18]>**&#x20;

[1]: #lint

Expand Down

0 comments on commit 8d65e43

Please sign in to comment.