10
10
* _ inner_
11
11
* [ ~ JsdocOptions] ( #module_jsdoc-api--jsdoc..JsdocOptions )
12
12
* [ .files] ( #module_jsdoc-api--jsdoc..JsdocOptions+files ) : <code >string</code > \| <code >Array.< ; string> ; </code >
13
- * [ .source] ( #module_jsdoc-api--jsdoc..JsdocOptions+source ) : <code >string</code >
13
+ * [ .source] ( #module_jsdoc-api--jsdoc..JsdocOptions+source ) : <code >string</code > \| < code >Array. & lt ; string & gt ; </ code >
14
14
* [ .cache] ( #module_jsdoc-api--jsdoc..JsdocOptions+cache ) : <code >boolean</code >
15
15
* [ .access] ( #module_jsdoc-api--jsdoc..JsdocOptions+access ) : <code >string</code >
16
16
* [ .configure] ( #module_jsdoc-api--jsdoc..JsdocOptions+configure ) : <code >string</code >
@@ -67,7 +67,7 @@ The jsdoc options, common for all operations.
67
67
68
68
* [ ~ JsdocOptions] ( #module_jsdoc-api--jsdoc..JsdocOptions )
69
69
* [ .files] ( #module_jsdoc-api--jsdoc..JsdocOptions+files ) : <code >string</code > \| <code >Array.< ; string> ; </code >
70
- * [ .source] ( #module_jsdoc-api--jsdoc..JsdocOptions+source ) : <code >string</code >
70
+ * [ .source] ( #module_jsdoc-api--jsdoc..JsdocOptions+source ) : <code >string</code > \| < code >Array. & lt ; string & gt ; </ code >
71
71
* [ .cache] ( #module_jsdoc-api--jsdoc..JsdocOptions+cache ) : <code >boolean</code >
72
72
* [ .access] ( #module_jsdoc-api--jsdoc..JsdocOptions+access ) : <code >string</code >
73
73
* [ .configure] ( #module_jsdoc-api--jsdoc..JsdocOptions+configure ) : <code >string</code >
@@ -85,13 +85,13 @@ The jsdoc options, common for all operations.
85
85
<a name =" module_jsdoc-api--jsdoc..JsdocOptions+files " ></a >
86
86
87
87
##### options.files : <code >string</code > \| <code >Array.< ; string> ; </code >
88
- One or more filenames to process. Either this or ` source ` must be supplied.
88
+ One or more filenames to process. Either ` files ` , ` source ` or ` configure ` must be supplied.
89
89
90
90
** Kind** : instance property of [ <code >JsdocOptions</code >] ( #module_jsdoc-api--jsdoc..JsdocOptions )
91
91
<a name =" module_jsdoc-api--jsdoc..JsdocOptions+source " ></a >
92
92
93
- ##### options.source : <code >string</code >
94
- A string containing source code to process. Either this or ` files ` must be supplied.
93
+ ##### options.source : <code >string</code > \| < code >Array. & lt ; string & gt ; </ code >
94
+ A string or an array of strings containing source code to process. Either ` files ` , ` source ` or ` configure ` must be supplied.
95
95
96
96
** Kind** : instance property of [ <code >JsdocOptions</code >] ( #module_jsdoc-api--jsdoc..JsdocOptions )
97
97
<a name =" module_jsdoc-api--jsdoc..JsdocOptions+cache " ></a >
@@ -109,7 +109,7 @@ Only display symbols with the given access: "public", "protected", "private" or
109
109
<a name =" module_jsdoc-api--jsdoc..JsdocOptions+configure " ></a >
110
110
111
111
##### options.configure : <code >string</code >
112
- The path to the configuration file. Default: path/to/jsdoc/conf.json.
112
+ The path to the configuration file. Default: path/to/jsdoc/conf.json. Either ` files ` , ` source ` or ` configure ` must be supplied.
113
113
114
114
** Kind** : instance property of [ <code >JsdocOptions</code >] ( #module_jsdoc-api--jsdoc..JsdocOptions )
115
115
<a name =" module_jsdoc-api--jsdoc..JsdocOptions+destination " ></a >
0 commit comments