8000 indicate that .jsx files are parsed by default, and remove obsolete note · removed-usr/jsdoc.github.io@a85149a · GitHub
[go: up one dir, main page]

Skip to content

Commit a85149a

Browse files
committed
indicate that .jsx files are parsed by default, and remove obsolete note
1 parent 7ac6c25 commit a85149a

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

about-configuring-jsdoc.html

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ <h2 id="configuration-file">Configuration File</h2>
5656
"dictionaries": ["jsdoc","closure"]
5757
},
5858
"source": {
59-
"includePattern": ".+\\.js(doc)?$",
59+
"includePattern": ".+\\.js(doc|x)?$",
6060
"excludePattern": "(^|\\/|\\\\)_"
6161
},
6262
"plugins": [],
@@ -72,7 +72,7 @@ <h2 id="configuration-file">Configuration File</h2>
7272
<li>JSDoc allows you to use unrecognized tags (<code>tags.allowUnknownTags</code>);</li>
7373
<li>Both standard JSDoc tags and <a href="https://developers.google.com/closure/compiler/docs/js-for-compiler#tags">Closure Compiler tags</a> are enabled (
7474
<code>tags.dictionaries</code>);</li>
75-
<li>Only files ending in &quot;.js&quot; and &quot;.jsdoc&quot; will be processed (<code>source.includePattern</code>);</li>
75+
<li>Only files ending in &quot;.js&quot;, &quot;.jsdoc&quot;, and &quot;.jsx&quot; will be processed (<code>source.includePattern</code>);</li>
7676
<li>Any file starting with an underscore or in a directory starting with an underscore will be
7777
<em>ignored</em> (<code>source.excludePattern</code>);</li>
7878
<li>No plugins are loaded (<code>plugins</code>);</li>
@@ -81,8 +81,7 @@ <h2 id="configuration-file">Configuration File</h2>
8181
<p>These options and others will be further explained on this page.</p>
8282
<p>Further settings may be added to the file as requested by various plugins or templates (for example, the <a href="plugins-markdown.html">Markdown plugin</a> can be configured by including a &quot;markdown&quot; key).</p>
8383
<h2 id="specifying-input-files">Specifying input files</h2>
84-
<p>The &quot;source&quot; set of options, in combination with paths given to JSDoc on the command-line, determine what files JSDoc generates documentation for.
85-
(Remove the comments before adding this example to your own .json file.)</p>
84+
<p>The &quot;source&quot; set of options, in combination with paths given to JSDoc on the command-line, determine what files JSDoc generates documentation for.</p>
8685
<figure><pre class="prettyprint lang-js"><code>"source": {
8786
"include": [ /* array of paths to files to generate documentation for */ ],
8887
"exclude": [ /* array of paths to exclude */ ],

content/en/about-configuring-jsdoc.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ file, this is what JSDoc will use:
2424
"dictionaries": ["jsdoc","closure"]
2525
},
2626
"source": {
27-
"includePattern": ".+\\.js(doc)?$",
27+
"includePattern": ".+\\.js(doc|x)?$",
2828
"excludePattern": "(^|\\/|\\\\)_"
2929
},
3030
"plugins": [],
@@ -41,7 +41,7 @@ This means:
4141
+ JSDoc allows you to use unrecognized tags (`tags.allowUnknownTags`);
4242
+ Both standard JSDoc tags and [Closure Compiler tags][closure-tags] are enabled
4343
(`tags.dictionaries`);
44-
+ Only files ending in ".js" and ".jsdoc" will be processed (`source.includePattern`);
44+
+ Only files ending in ".js", ".jsdoc", and ".jsx" will be processed (`source.includePattern`);
4545
+ Any file starting with an underscore or in a directory starting with an underscore will be
4646
_ignored_ (`source.excludePattern`);
4747
+ No plugins are loaded (`plugins`);
@@ -59,8 +59,7 @@ the [Markdown plugin][markdown] can be configured by including a "markdown" key)
5959
## Specifying input files
6060

6161
The "source" set of options, in combination with paths given to JSDoc on the command-line, determine
62-
what files JSDoc generates documentation for. (Remove the comments before adding this example to
63-
your own .json file.)
62+
what files JSDoc generates documentation for.
6463

6564
{% example %}
6665

0 commit comments

Comments
 (0)
0