Skip to content

Commit 8555a62

Browse files
committed
docs
1 parent 00bfbeb commit 8555a62

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

docs/api.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* _inner_
1111
* [~JsdocOptions](#module_jsdoc-api--jsdoc..JsdocOptions)
1212
* [.files](#module_jsdoc-api--jsdoc..JsdocOptions+files) : <code>string</code> \| <code>Array.&lt;string&gt;</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>
1414
* [.cache](#module_jsdoc-api--jsdoc..JsdocOptions+cache) : <code>boolean</code>
1515
* [.access](#module_jsdoc-api--jsdoc..JsdocOptions+access) : <code>string</code>
1616
* [.configure](#module_jsdoc-api--jsdoc..JsdocOptions+configure) : <code>string</code>
@@ -67,7 +67,7 @@ The jsdoc options, common for all operations.
6767

6868
* [~JsdocOptions](#module_jsdoc-api--jsdoc..JsdocOptions)
6969
* [.files](#module_jsdoc-api--jsdoc..JsdocOptions+files) : <code>string</code> \| <code>Array.&lt;string&gt;</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>
7171
* [.cache](#module_jsdoc-api--jsdoc..JsdocOptions+cache) : <code>boolean</code>
7272
* [.access](#module_jsdoc-api--jsdoc..JsdocOptions+access) : <code>string</code>
7373
* [.configure](#module_jsdoc-api--jsdoc..JsdocOptions+configure) : <code>string</code>
@@ -85,13 +85,13 @@ The jsdoc options, common for all operations.
8585
<a name="module_jsdoc-api--jsdoc..JsdocOptions+files"></a>
8686

8787
##### options.files : <code>string</code> \| <code>Array.&lt;string&gt;</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.
8989

9090
**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api--jsdoc..JsdocOptions)
9191
<a name="module_jsdoc-api--jsdoc..JsdocOptions+source"></a>
9292

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.
9595

9696
**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api--jsdoc..JsdocOptions)
9797
<a name="module_jsdoc-api--jsdoc..JsdocOptions+cache"></a>
@@ -109,7 +109,7 @@ Only display symbols with the given access: "public", "protected", "private" or
109109
<a name="module_jsdoc-api--jsdoc..JsdocOptions+configure"></a>
110110

111111
##### 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.
113113

114114
**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api--jsdoc..JsdocOptions)
115115
<a name="module_jsdoc-api--jsdoc..JsdocOptions+destination"></a>

index.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,14 @@ class JsdocOptions {
6363
options = options || {}
6464

6565
/**
66-
* One or more filenames to process. Either this or `source` must be supplied.
66+
* One or more filenames to process. Either `files`, `source` or `configure` must be supplied.
6767
* @type {string|string[]}
6868
*/
6969
this.files = arrayify(options.files)
7070

7171
/**
72-
* A string containing source code to process. Either this or `files` must be supplied.
73-
* @type {string}
72+
* A string or an array of strings containing source code to process. Either `files`, `source` or `configure` must be supplied.
73+
* @type {string|string[]}
7474
*/
7575
this.source = options.source
7676

@@ -88,7 +88,7 @@ class JsdocOptions {
8888
this.access = options.access
8989

9090
/**
91-
* The path to the configuration file. Default: path/to/jsdoc/conf.json.
91+
* The path to the configuration file. Default: path/to/jsdoc/conf.json. Either `files`, `source` or `configure` must be supplied.
9292
* @type {string}
9393
*/
9494
this.configure = options.configure

0 commit comments

Comments
 (0)