@@ -34,7 +34,7 @@ of lint information intended for human-readable output.
34
34
that defines what external modules will be whitelisted and included in the
35
35
generated documentation.
36
36
* ` args.shallow ` ** [ boolean] [ 20 ] ** whether to avoid dependency parsing
37
- even in JavaScript code. (optional, default ` false ` )
37
+ even in JavaScript code.&#x 20 ; (optional, default ` false ` )
38
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
@@ -71,14 +71,14 @@ comments, given a root file as a path.
71
71
that defines what external modules will be whitelisted and included in the
72
72
generated documentation.
73
73
* ` args.shallow ` ** [ boolean] [ 20 ] ** whether to avoid dependency parsing
74
- even in JavaScript code. (optional, default ` false ` )
74
+ even in JavaScript code.&#x 20 ; (optional, default ` false ` )
75
75
* ` args.order ` ** [ Array] [ 17 ] <([ string] [ 18 ] | [ Object] [ 19 ] )>** optional array that
76
- defines sorting order of documentation (optional, default ` [] ` )
76
+ defines sorting order of documentation&#x 20 ; (optional, default ` [] ` )
77
77
* ` args.access ` ** [ Array] [ 17 ] <[ string] [ 18 ] >** an array of access levels
78
- to output in documentation (optional, default ` [] ` )
78
+ to output in documentation&#x 20 ; (optional, default ` [] ` )
79
79
* ` args.hljs ` ** [ Object] [ 19 ] ?** hljs optional args
80
80
81
- * ` args.hljs.highlightAuto ` ** [ boolean] [ 20 ] ** hljs automatically detect language (optional, default ` false ` )
81
+ * ` args.hljs.highlightAuto ` ** [ boolean] [ 20 ] ** hljs automatically detect language&#x 20 ; (optional, default ` false ` )
82
82
* ` args.hljs.languages ` ** [ Array] [ 17 ] ?** languages for hljs to choose from
83
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.
@@ -120,7 +120,7 @@ Formats documentation as HTML.
120
120
* ` comments ` ** [ Array] [ 17 ] <[ Comment] [ 22 ] >** parsed comments
121
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.&#x 20 ; (optional, default ` 'default_theme' ` )
124
124
125
125
### Examples
126
126
@@ -181,7 +181,7 @@ documentation.build(['index.js'])
181
181
});
182
182
```
183
183
184
- Returns ** [ Promise] [ 21 ] <[ string] [ 18 ] >**
184
+ Returns ** [ Promise] [ 21 ] <[ string] [ 18 ] >** &#x 20 ;
185
185
186
186
[ 1 ] : #lint
187
187
0 commit comments