2
2
3
3
### Table of Contents
4
4
5
- - [ lint] [ 1 ]
6
- - [ Parameters] [ 2 ]
7
- - [ Examples] [ 3 ]
8
- - [ build] [ 4 ]
9
- - [ Parameters] [ 5 ]
10
- - [ Examples] [ 6 ]
11
- - [ formats] [ 7 ]
12
- - [ formats.html] [ 8 ]
13
- - [ Parameters] [ 9 ]
14
- - [ Examples] [ 10 ]
15
- - [ formats.markdown] [ 11 ]
16
- - [ Parameters] [ 12 ]
17
- - [ Examples] [ 13 ]
18
- - [ formats.json] [ 14 ]
19
- - [ Parameters] [ 15 ]
20
- - [ Examples] [ 16 ]
5
+ * [ lint] [ 1 ]
6
+ * [ Parameters] [ 2 ]
7
+ * [ Examples] [ 3 ]
8
+ * [ build] [ 4 ]
9
+ * [ Parameters] [ 5 ]
10
+ * [ Examples] [ 6 ]
11
+ * [ formats] [ 7 ]
12
+ * [ formats.html] [ 8 ]
13
+ * [ Parameters] [ 9 ]
14
+ * [ Examples] [ 10 ]
15
+ * [ formats.markdown] [ 11 ]
16
+ * [ Parameters] [ 12 ]
17
+ * [ Examples] [ 13 ]
18
+ * [ formats.json] [ 14 ]
19
+ * [ Parameters] [ 15 ]
20
+ * [ Examples] [ 16 ]
21
21
22
22
## lint
23
23
@@ -27,19 +27,19 @@ of lint information intended for human-readable output.
27
27
28
28
### Parameters
29
29
30
- - ` indexes ` ** ([ Array] [ 17 ] & lt ; [ string] [ 18 ] > | [ string] [ 18 ] )** files to process
31
- - ` args ` ** [ Object] [ 19 ] ** args
30
+ * ` indexes ` ** ([ Array] [ 17 ] < [ string] [ 18 ] > | [ string] [ 18 ] )** files to process
31
+ * ` args ` ** [ Object] [ 19 ] ** args
32
32
33
- - ` args.external ` ** [ Array] [ 17 ] & lt ; [ string] [ 18 ] >** a string regex / glob match pattern
33
+ * ` args.external ` ** [ Array] [ 17 ] < [ string] [ 18 ] >** a string regex / glob match pattern
34
34
that defines what external modules will be whitelisted and included in the
35
35
generated documentation.
36
- - ` args.shallow ` ** [ boolean] [ 20 ] ** whether to avoid dependency parsing
36
+ * ` args.shallow ` ** [ boolean] [ 20 ] ** whether to avoid dependency parsing
37
37
even in JavaScript code. (optional, default ` false ` )
38
- - ` args.inferPrivate ` ** [ string] [ 18 ] ?** a valid regular expression string
38
+ * ` args.inferPrivate ` ** [ string] [ 18 ] ?** a valid regular expression string
39
39
to infer whether a code element should be private, given its naming structure.
40
40
For instance, you can specify ` inferPrivate: '^_' ` to automatically treat
41
41
methods named like ` _myMethod ` as private.
42
- - ` args.extension ` ** ([ string] [ 18 ] \ | [ Array] [ 17 ] & lt ; [ string] [ 18 ] >)?** treat additional file extensions
42
+ * ` args.extension ` ** ([ string] [ 18 ] | [ Array] [ 17 ] < [ string] [ 18 ] >)?** treat additional file extensions
43
43
as JavaScript, extending the default set of ` js ` , ` es6 ` , and ` jsx ` .
44
44
45
45
### Examples
@@ -64,27 +64,27 @@ comments, given a root file as a path.
64
64
65
65
### Parameters
66
66
67
- - ` indexes ` ** ([ Array] [ 17 ] & lt ; [ string] [ 18 ] > | [ string] [ 18 ] )** files to process
68
- - ` args ` ** [ Object] [ 19 ] ** args
67
+ * ` indexes ` ** ([ Array] [ 17 ] < [ string] [ 18 ] > | [ string] [ 18 ] )** files to process
68
+ * ` args ` ** [ Object] [ 19 ] ** args
69
69
70
- - ` args.external ` ** [ Array] [ 17 ] & lt ; [ string] [ 18 ] >** a string regex / glob match pattern
70
+ * ` args.external ` ** [ Array] [ 17 ] < [ string] [ 18 ] >** a string regex / glob match pattern
71
71
that defines what external modules will be whitelisted and included in the
72
72
generated documentation.
73
- - ` args.shallow ` ** [ boolean] [ 20 ] ** whether to avoid dependency parsing
73
+ * ` args.shallow ` ** [ boolean] [ 20 ] ** whether to avoid dependency parsing
74
74
even in JavaScript code. (optional, default ` false ` )
75
- - ` args.order ` ** [ Array] [ 17 ] & lt ; ([ string] [ 18 ] \ | [ Object] [ 19 ] )>** optional array that
75
+ * ` args.order ` ** [ Array] [ 17 ] < ([ string] [ 18 ] | [ Object] [ 19 ] )>** optional array that
76
76
defines sorting order of documentation (optional, default ` [] ` )
77
- - ` args.access ` ** [ Array] [ 17 ] & lt ; [ string] [ 18 ] >** an array of access levels
77
+ * ` args.access ` ** [ Array] [ 17 ] < [ string] [ 18 ] >** an array of access levels
78
78
to output in documentation (optional, default ` [] ` )
79
- - ` args.hljs ` ** [ Object] [ 19 ] ?** hljs optional args
79
+ * ` args.hljs ` ** [ Object] [ 19 ] ?** hljs optional args
80
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
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
84
84
to infer whether a code element should be private, given its naming structure.
85
85
For instance, you can specify ` inferPrivate: '^_' ` to automatically treat
86
86
methods named like ` _myMethod ` as private.
87
- - ` args.extension ` ** ([ string] [ 18 ] \ | [ Array] [ 17 ] & lt ; [ string] [ 18 ] >)?** treat additional file extensions
87
+ * ` args.extension ` ** ([ string] [ 18 ] | [ Array] [ 17 ] < [ string] [ 18 ] >)?** treat additional file extensions
88
88
as JavaScript, extending the default set of ` js ` , ` es6 ` , and ` jsx ` .
89
89
90
90
### Examples
@@ -117,10 +117,10 @@ Formats documentation as HTML.
117
117
118
118
### Parameters
119
119
120
- - ` comments ` ** [ Array] [ 17 ] & lt ; [ Comment] [ 22 ] >** parsed comments
121
- - ` config ` ** [ Object] [ 19 ] ** Options that can customize the output
120
+ * ` comments ` ** [ Array] [ 17 ] < [ Comment] [ 22 ] >** parsed comments
121
+ * ` config ` ** [ Object] [ 19 ] ** Options that can customize the output
122
122
123
- - ` config.theme ` ** [ string] [ 18 ] ** Name of a module used for an HTML theme. (optional, default ` 'default_theme' ` )
123
+ * ` config.theme ` ** [ string] [ 18 ] ** Name of a module used for an HTML theme. (optional, default ` 'default_theme' ` )
124
124
125
125
### Examples
126
126
@@ -136,7 +136,7 @@ documentation.build(['index.js'])
136
136
});
137
137
```
138
138
139
- Returns ** [ Promise] [ 21 ] & lt ; [ Array] [ 17 ] & lt ; [ Object] [ 19 ] >>** Promise with results
139
+ Returns ** [ Promise] [ 21 ] < [ Array] [ 17 ] < [ Object] [ 19 ] >>** Promise with results
140
140
141
141
## formats.markdown
142
142
@@ -145,8 +145,8 @@ Formats documentation as
145
145
146
146
### Parameters
147
147
148
- - ` comments ` ** [ Array] [ 17 ] & lt ; [ Object] [ 19 ] >** parsed comments
149
- - ` args ` ** [ Object] [ 19 ] ** Options that can customize the output
148
+ * ` comments ` ** [ Array] [ 17 ] < [ Object] [ 19 ] >** parsed comments
149
+ * ` args ` ** [ Object] [ 19 ] ** Options that can customize the output
150
150
151
151
### Examples
152
152
@@ -162,15 +162,15 @@ documentation.build(['index.js'])
162
162
});
163
163
```
164
164
165
- Returns ** [ Promise] [ 21 ] & lt ; [ string] [ 18 ] >** a promise of the eventual value
165
+ Returns ** [ Promise] [ 21 ] < [ string] [ 18 ] >** a promise of the eventual value
166
166
167
167
## formats.json
168
168
169
169
Formats documentation as a JSON string.
170
170
171
171
### Parameters
172
172
173
- - ` comments ` ** [ Array] [ 17 ] & lt ; [ Comment] [ 22 ] >** parsed comments
173
+ * ` comments ` ** [ Array] [ 17 ] < [ Comment] [ 22 ] >** parsed comments
174
174
175
175
### Examples
176
176
@@ -186,7 +186,7 @@ documentation.build(['index.js'])
186
186
});
187
187
```
188
188
189
- Returns ** [ Promise] [ 21 ] & lt ; [ string] [ 18 ] >**
189
+ Returns ** [ Promise] [ 21 ] < [ string] [ 18 ] >**
190
190
191
191
[ 1 ] : #lint
192
192
0 commit comments