You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<ahref="https://github.com/jsdoc3/jsdoc3.github.com/contributors">contributors</a> to the JSDoc 3 documentation project.
93
89
<br> This website is <ahref="https://github.com/jsdoc3/jsdoc3.github.com">open source</a> and is licensed under the <arel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">
<p>where <code>...</code> are paths to other files to generate documentation for.</p>
38
-
<p>Additionally, one may provide the path to a <ahref="http://daringfireball.net/projects/markdown/">Markdown file</a> (ending in ".md") or a file named
39
-
"README", and this will be added to the documentation on the front page. See <ahref="about-including-readme.html">these
38
+
<p>Additionally, one may provide the path to a <ahref="http://daringfireball.net/projects/markdown/">Markdown file</a> (ending in <code>.md</code>) or a file named
39
+
<code>README</code>, and this will be added to the documentation on the front page. See <ahref="about-including-readme.html">these
40
40
instructions</a>.</p>
41
41
<p>JSDoc supports a number of command-line options, many of which have both long and short forms. Alternatively, the command-line options may be <ahref="about-configuring-jsdoc.html">specified in a configuration file</a> given to JSDoc. The command-line options are:</p>
<td>Only display symbols with the given <code>access</code> property: <code>private</code>, <code>protected</code>, <code>public</code>, or <code>undefined</code>,
54
53
or <code>all</code> for all access levels. By default, all except <code>private</code> symbols are shown.</td>
<td>The path to a JSDoc <ahref="about-configuring-jsdoc.html">configuration file</a>. Defaults to <code>conf.json</code> or <code>conf.json.EXAMPLE</code> in the directory where JSDoc is installed.</td>
<td>The path to the output folder for the generated documentation. For JSDoc's built-in Haruki template, use <code>console</code> to dump data to the console.
65
62
Defaults to <code>./out</code>.</td>
66
63
</tr>
67
64
<tr>
68
-
<td><code>--debug</code>
69
-
</td>
65
+
<td><code>--debug</code></td>
70
66
<td>Log information that can help debug issues in JSDoc itself.</td>
<td>Assume this encoding when reading all source files. Defaults to <code>utf8</code>.</td>
76
71
</tr>
77
72
<tr>
78
-
<td><code>-h</code>, <code>--help</code>
79
-
</td>
73
+
<td><code>-h</code>, <code>--help</code></td>
80
74
<td>Display information about JSDoc's command-line options, then exit.</td>
81
75
</tr>
82
76
<tr>
83
-
<td><code>--match <value></code>
84
-
</td>
77
+
<td><code>--match <value></code></td>
85
78
<td>Only run tests whose names contain <code>value</code>.</td>
86
79
</tr>
87
80
<tr>
88
-
<td><code>--nocolor</code>
89
-
</td>
81
+
<td><code>--nocolor</code></td>
90
82
<td>When running tests, do not use color in the console output. On Windows, this option is enabled by default.</td>
91
83
</tr>
92
84
<tr>
93
-
<td><code>-p</code>, <code>--private</code>
94
-
</td>
85
+
<td><code>-p</code>, <code>--private</code></td>
95
86
<td>Include symbols marked with the <ahref="tags-private.html"><code>@private</code> tag</a> in the generated documentation. By default, private symbols are
96
87
not included.</td>
97
88
</tr>
98
89
<tr>
99
-
<td><code>-P</code>, <code>--package</code>
100
-
</td>
90
+
<td><code>-P</code>, <code>--package</code></td>
101
91
<td>The <code>package.json</code> file that contains the project name, version, and other details. Defaults to the first <code>package.json</code> file found
102
92
in the source paths.</td>
103
93
</tr>
104
94
<tr>
105
-
<td><code>--pedantic</code>
106
-
</td>
95
+
<td><code>--pedantic</code></td>
107
96
<td>Treat errors as fatal errors, and treat warnings as errors. Defaults to <code>false</code>.</td>
<td>A query string to parse and store in the global variable <code>env.opts.query</code>. Example: <code>foo=bar&baz=true</code>.</td>
113
101
</tr>
114
102
<tr>
115
-
<td><code>-r</code>, <code>--recurse</code>
116
-
</td>
103
+
<td><code>-r</code>, <code>--recurse</code></td>
117
104
<td>Recurse into subdirectories when scanning for source files and tutorials.</td>
118
105
</tr>
119
106
<tr>
120
-
<td><code>-R</code>, <code>--readme</code>
121
-
</td>
107
+
<td><code>-R</code>, <code>--readme</code></td>
122
108
<td>The <code>README.md</code> file to include in the generated documentation. Defaults to the first <code>README.md</code> file found in the source paths.</td>
<td>Directory in which JSDoc should search for tutorials. If omitted, no tutorial pages will be generated. See the <ahref="about-tutorials.html">tutorial instructions</a> for more information.</td>
138
121
</tr>
139
122
<tr>
140
-
<td><code>-v</code>, <code>--version</code>
141
-
</td>
123
+
<td><code>-v</code>, <code>--version</code></td>
142
124
<td>Displays JSDoc's version number, then exits.</td>
143
125
</tr>
144
126
<tr>
145
-
<td><code>--verbose</code>
146
-
</td>
127
+
<td><code>--verbose</code></td>
147
128
<td>Log detailed information to the console as JSDoc runs. Defaults to <code>false</code>.</td>
148
129
</tr>
149
130
<tr>
150
-
<td><code>-X</code>, <code>--explain</code>
151
-
</td>
131
+
<td><code>-X</code>, <code>--explain</code></td>
152
132
<td>Dump all doclets to the console in JSON format, then exit.</td>
<ahref="https://github.com/jsdoc3/jsdoc3.github.com/contributors">contributors</a> to the JSDoc 3 documentation project.
177
154
<br> This website is <ahref="https://github.com/jsdoc3/jsdoc3.github.com">open source</a> and is licensed under the <arel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">
<ahref="https://github.com/jsdoc3/jsdoc3.github.com/contributors">contributors</a> to the JSDoc 3 documentation project.
110
109
<br> This website is <ahref="https://github.com/jsdoc3/jsdoc3.github.com">open source</a> and is licensed under the <arel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">
<p>See the <ahref="about-plugins.html">plugin reference</a> for further information, and look in <ahref="https://github.com/jsdoc3/jsdoc/tree/master/plugins">JSDoc's <code>plugins</code>
134
130
directory</a> for the plugins built into JSDoc.</p>
135
131
<p>You can configure the Markdown plugin by adding a <code>markdown</code> object to your configuration file. See
<p>The <code>source</code> set of options, in combination with paths given to JSDoc on the command line, determines the set of input files that JSDoc uses to generate
<li><code>source.include</code>: An optional array of paths that contain files for which JSDoc should generate documentation. The paths given to JSDoc on the command
161
155
line are combined with these paths. You can use the <ahref="about-commandline.html"><code>-r</code> command-line option</a> to recurse into subdirectories.</li>
162
156
<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
163
157
in <code>source.include</code>.</li>
164
158
<li><code>source.includePattern</code>: An optional string, interpreted as a regular expression. If present, all filenames must match this regular expression to
165
-
be processed by JSDoc. By default, this option is set to ".+\.js(doc|x)?$", meaning that only files with the extensions <code>.js</code>, <code>.jsdoc</code>,
166
-
and
159
+
be processed by JSDoc. By default, this option is set to <code>.+&#92;.js(doc|x)?$</code>, meaning that only files with the extensions <code>.js</code>,
160
+
<code>.jsdoc</code>, and
167
161
<code>.jsx</code> will be processed.</li>
168
162
<li><code>source.excludePattern</code>: An optional string, interpreted as a regular expression. If present, any file matching this regular expression will be
169
163
ignored. By default, this option is set so that files beginning with an underscore (or anything under a directory beginning with an underscore) is ignored.
<p>If you run <code>jsdoc myProject/c.js -c /path/to/my/conf.json -r</code> from the file containing the
205
197
<code>myProject</code> folder, JSDoc will generate documentation for the following files:</p>
206
198
<ul>
207
-
<li><code>myProject/a.js</code>
208
-
</li>
209
-
<li><code>myProject/c.js</code>
210
-
</li>
211
-
<li><code>myProject/lib/a.js</code>
212
-
</li>
199
+
<li><code>myProject/a.js</code></li>
200
+
<li><code>myProject/c.js</code></li>
201
+
<li><code>myProject/lib/a.js</code></li>
213
202
</ul>
214
203
<p>Here's why:</p>
215
204
<ol>
@@ -238,8 +227,7 @@ <h2 id="specifying-the-source-type">Specifying the source type</h2>
238
227
<figure><preclass="prettyprint lang-js"><code>{
239
228
"sourceType": "module"
240
229
}
241
-
</code></pre>
242
-
</figure>
230
+
</code></pre></figure>
243
231
<h2id="incorporating-command-line-options-into-the-configuration-file">Incorporating command-line options into the configuration file</h2>
244
232
<p>You can put many of JSDoc's <ahref="about-commandline.html">command-line options</a> into the configuration file instead of specifying them on the command
245
233
line. To do this, add the long names of the relevant options into an
"tutorials": "path/to/tutorials", // same as -u path/to/tutorials
255
243
}
256
244
}
257
-
</code></pre>
258
-
</figure>
245
+
</code></pre></figure>
259
246
<p>By using the <code>source.include</code> and <code>opts</code> options, you can put almost all of the arguments to JSDoc in a configuration file, so that the
@@ -269,8 +256,7 @@ <h2 id="configuring-tags-and-tag-dictionaries">Configuring tags and tag dictiona
269
256
"dictionaries": ["jsdoc","closure"]
270
257
}
271
258
}
272
-
</code></pre>
273
-
</figure>
259
+
</code></pre></figure>
274
260
<p>The <code>tags.allowUnknownTags</code> property affects how JSDoc handles unrecognized tags. If you set this option to <code>false</code>, and JSDoc finds a
275
261
tag that it does not recognize (for example, <code>@foo</code>), JSDoc logs a warning. By default, this option is set to <code>true</code>. In JSDoc 3.4.1
276
262
and later, you can also set this property to an array of tag names that JSDoc should allow (for example, <code>["foo","bar"]</code>).</p>
<p>If <code>templates.monospaceLinks</code> is true, all link text from the <ahref="tags-inline-link.html">inline <code>{@link}</code>
302
287
tag</a> will be rendered in monospace.</p>
303
288
<p>If <code>templates.cleverLinks</code> is true, <code>{@link asdf}</code> will be rendered in normal font if <code>asdf</code> is a URL, and monospace otherwise.
<ahref="https://github.com/jsdoc3/jsdoc3.github.com/contributors">contributors</a> to the JSDoc 3 documentation project.
325
309
<br> This website is <ahref="https://github.com/jsdoc3/jsdoc3.github.com">open source</a> and is licensed under the <arel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">
0 commit comments