Skip to content

Commit 1e0a1c8

Browse files
committed
update source.exclude docs (#78)
1 parent 28b7f8a commit 1e0a1c8

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

about-configuring-jsdoc.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,8 @@ <h2 id="specifying-input-files">Specifying input files</h2>
9292
<ul>
9393
<li><code>source.include</code>: an optional array of paths that JSDoc should generate documentation for. The paths given to JSDoc on the command line are combined
9494
with these to form the set of files JSDoc will scan. Recall that if a path is a directory, the <code>-r</code> option may be used to recurse into it.</li>
95-
<li><code>source.exclude</code>: an optional array of paths that JSDoc should ignore.</li>
95+
<li><code>source.exclude</code>: an optional array of paths that JSDoc should ignore. In JSDoc 3.3.0 and later, this array may include subdirectories of the paths
96+
in <code>source.include</code>.</li>
9697
<li><code>source.includePattern</code>: an optional string, interpreted as a regular expression. If present, all files <em>must</em> match this in order to be
9798
scanned by JSDoc. By default this is set to &quot;.+&#92;.js(doc)?$&quot;, meaning that only files that end in <code>.js</code> or <code>.jsdoc</code> will
9899
be scanned.</li>

content/en/about-configuring-jsdoc.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,8 @@ your own .json file.)
7171
+ `source.include`: an optional array of paths that JSDoc should generate documentation for. The
7272
paths given to JSDoc on the command line are combined with these to form the set of files JSDoc will
7373
scan. Recall that if a path is a directory, the `-r` option may be used to recurse into it.
74-
+ `source.exclude`: an optional array of paths that JSDoc should ignore.
74+
+ `source.exclude`: an optional array of paths that JSDoc should ignore. In JSDoc 3.3.0 and later,
75+
this array may include subdirectories of the paths in `source.include`.
7576
+ `source.includePattern`: an optional string, interpreted as a regular expression. If present, all
7677
files _must_ match this in order to be scanned by JSDoc. By default this is set to
7778
".+&#92;.js(doc)?$", meaning that only files that end in `.js` or `.jsdoc` will be scanned.

0 commit comments

Comments
 (0)