Skip to content

Commit 2bf1119

Browse files
committed
chore: check in updates from npm run build on master
1 parent 66ae8ad commit 2bf1119

File tree

1 file changed

+41
-72
lines changed

1 file changed

+41
-72
lines changed

Diff for: docs/NODE_API.md

+41-72
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,12 @@
99
* [Parameters][5]
1010
* [Examples][6]
1111
* [formats][7]
12-
* [formats.html][8]
12+
* [formats.markdown][8]
1313
* [Parameters][9]
1414
* [Examples][10]
15-
* [formats.markdown][11]
15+
* [formats.json][11]
1616
* [Parameters][12]
1717
* [Examples][13]
18-
* [formats.json][14]
19-
* [Parameters][15]
20-
* [Examples][16]
2118

2219
## lint
2320

@@ -27,19 +24,19 @@ of lint information intended for human-readable output.
2724

2825
### Parameters
2926

30-
* `indexes` **([Array][17]<[string][18]> | [string][18])** files to process
31-
* `args` **[Object][19]** args
27+
* `indexes` **([Array][14]<[string][15]> | [string][15])** files to process
28+
* `args` **[Object][16]** args
3229

33-
* `args.external` **[Array][17]<[string][18]>** a string regex / glob match pattern
30+
* `args.external` **[Array][14]<[string][15]>** a string regex / glob match pattern
3431
that defines what external modules will be whitelisted and included in the
3532
generated documentation.
36-
* `args.shallow` **[boolean][20]** whether to avoid dependency parsing
37-
even in JavaScript code. (optional, default `false`)
38-
* `args.inferPrivate` **[string][18]?** a valid regular expression string
33+
* `args.shallow` **[boolean][17]** whether to avoid dependency parsing
34+
even in JavaScript code.&#x20;(optional, default `false`)
35+
* `args.inferPrivate` **[string][15]?** a valid regular expression string
3936
to infer whether a code element should be private, given its naming structure.
4037
For instance, you can specify `inferPrivate: '^_'` to automatically treat
4138
methods named like `_myMethod` as private.
42-
* `args.extension` **([string][18] | [Array][17]<[string][18]>)?** treat additional file extensions
39+
* `args.extension` **([string][15] | [Array][14]<[string][15]>)?** treat additional file extensions
4340
as JavaScript, extending the default set of `js`, `es6`, and `jsx`.
4441

4542
### Examples
@@ -55,7 +52,7 @@ documentation.lint('file.js').then(lintOutput => {
5552
});
5653
```
5754

58-
Returns **[Promise][21]** promise with lint results
55+
Returns **[Promise][18]** promise with lint results
5956

6057
## build
6158

@@ -64,27 +61,27 @@ comments, given a root file as a path.
6461

6562
### Parameters
6663

67-
* `indexes` **([Array][17]<[string][18]> | [string][18])** files to process
68-
* `args` **[Object][19]** args
64+
* `indexes` **([Array][14]<[string][15]> | [string][15])** files to process
65+
* `args` **[Object][16]** args
6966

70-
* `args.external` **[Array][17]<[string][18]>** a string regex / glob match pattern
67+
* `args.external` **[Array][14]<[string][15]>** a string regex / glob match pattern
7168
that defines what external modules will be whitelisted and included in the
7269
generated documentation.
73-
* `args.shallow` **[boolean][20]** whether to avoid dependency parsing
74-
even in JavaScript code. (optional, default `false`)
75-
* `args.order` **[Array][17]<([string][18] | [Object][19])>** optional array that
76-
defines sorting order of documentation (optional, default `[]`)
77-
* `args.access` **[Array][17]<[string][18]>** an array of access levels
78-
to output in documentation (optional, default `[]`)
79-
* `args.hljs` **[Object][19]?** hljs optional args
80-
81-
* `args.hljs.highlightAuto` **[boolean][20]** hljs automatically detect language (optional, default `false`)
82-
* `args.hljs.languages` **[Array][17]?** languages for hljs to choose from
83-
* `args.inferPrivate` **[string][18]?** a valid regular expression string
70+
* `args.shallow` **[boolean][17]** whether to avoid dependency parsing
71+
even in JavaScript code.&#x20;(optional, default `false`)
72+
* `args.order` **[Array][14]<([string][15] | [Object][16])>** optional array that
73+
defines sorting order of documentation&#x20;(optional, default `[]`)
74+
* `args.access` **[Array][14]<[string][15]>** an array of access levels
75+
to output in documentation&#x20;(optional, default `[]`)
76+
* `args.hljs` **[Object][16]?** hljs optional args
77+
78+
* `args.hljs.highlightAuto` **[boolean][17]** hljs automatically detect language&#x20;(optional, default `false`)
79+
* `args.hljs.languages` **[Array][14]?** languages for hljs to choose from
80+
* `args.inferPrivate` **[string][15]?** a valid regular expression string
8481
to infer whether a code element should be private, given its naming structure.
8582
For instance, you can specify `inferPrivate: '^_'` to automatically treat
8683
methods named like `_myMethod` as private.
87-
* `args.extension` **([string][18] | [Array][17]<[string][18]>)?** treat additional file extensions
84+
* `args.extension` **([string][15] | [Array][14]<[string][15]>)?** treat additional file extensions
8885
as JavaScript, extending the default set of `js`, `es6`, and `jsx`.
8986

9087
### Examples
@@ -102,7 +99,7 @@ documentation.build(['index.js'], {
10299
});
103100
```
104101

105-
Returns **[Promise][21]** results
102+
Returns **[Promise][18]** results
106103

107104
## formats
108105

@@ -111,37 +108,15 @@ and config as input and return Promises with results,
111108
like stringified JSON, markdown strings, or Vinyl objects for HTML
112109
output.
113110

114-
## formats.html
115-
116-
Formats documentation as HTML.
117-
118-
### Parameters
119-
120-
* `comments` **[Array][17]<[Comment][22]>** parsed comments
121-
* `config` **[Object][19]** Options that can customize the output
122-
123-
* `config.theme` **[string][18]** Name of a module used for an HTML theme. (optional, default `'default_theme'`)
124-
125-
### Examples
126-
127-
```javascript
128-
var documentation = require('documentation');
129-
130-
documentation.build(['index.js'])
131-
.then(documentation.formats.html);
132-
```
133-
134-
Returns **[Promise][21]<[Array][17]<[Object][19]>>** Promise with results
135-
136111
## formats.markdown
137112

138113
Formats documentation as
139-
[Markdown][23].
114+
[Markdown][19].
140115

141116
### Parameters
142117

143-
* `comments` **[Array][17]<[Object][19]>** parsed comments
144-
* `args` **[Object][19]** Options that can customize the output
118+
* `comments` **[Array][14]<[Object][16]>** parsed comments
119+
* `args` **[Object][16]** Options that can customize the output
145120

146121
### Examples
147122

@@ -157,15 +132,15 @@ documentation.build(['index.js'])
157132
});
158133
```
159134

160-
Returns **[Promise][21]<[string][18]>** a promise of the eventual value
135+
Returns **[Promise][18]<[string][15]>** a promise of the eventual value
161136

162137
## formats.json
163138

164139
Formats documentation as a JSON string.
165140

166141
### Parameters
167142

168-
* `comments` **[Array][17]<[Comment][22]>** parsed comments
143+
* `comments` **[Array][14]<[Comment][20]>** parsed comments
169144

170145
### Examples
171146

@@ -181,7 +156,7 @@ documentation.build(['index.js'])
181156
});
182157
```
183158

184-
Returns **[Promise][21]<[string][18]>**
159+
Returns **[Promise][18]<[string][15]>**&#x20;
185160

186161
[1]: #lint
187162

@@ -197,34 +172,28 @@ Returns **[Promise][21]<[string][18]>**
197172

198173
[7]: #formats
199174

200-
[8]: #formatshtml
175+
[8]: #formatsmarkdown
201176

202177
[9]: #parameters-2
203178

204179
[10]: #examples-2
205180

206-
[11]: #formatsmarkdown
181+
[11]: #formatsjson
207182

208183
[12]: #parameters-3
209184

210185
[13]: #examples-3
211186

212-
[14]: #formatsjson
213-
214-
[15]: #parameters-4
215-
216-
[16]: #examples-4
217-
218-
[17]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
187+
[14]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
219188

220-
[18]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
189+
[15]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
221190

222-
[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
191+
[16]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
223192

224-
[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
193+
[17]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
225194

226-
[21]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
195+
[18]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
227196

228-
[22]: https://developer.mozilla.org/docs/Web/API/Comment/Comment
197+
[19]: https://daringfireball.net/projects/markdown/
229198

230-
[23]: https://daringfireball.net/projects/markdown/
199+
[20]: https://developer.mozilla.org/docs/Web/API/Comment/Comment

0 commit comments

Comments
 (0)