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
<li><strong>Block tags</strong>, which are at the top level of a JSDoc comment.</li>
38
38
<li><strong>Inline tags</strong>, which are within the text of a block tag or a description.</li>
39
39
</ul>
40
-
<p>Block tags usually provide detailed information about your code, such as the parameters that a function accepts. Inline tags usually link to other parts of the
41
-
documentation, similar to the anchor tag (<code><a></code>) in HTML.</p>
42
-
<p>Block tags always begin with an at sign (<code>@</code>). Each block tag must be followed by a line break, with the exception of the last block tag in a JSDoc
43
-
comment.</p>
44
-
<p>Inline tags also begin with an at sign. However, inline tags and their text must be enclosed in curly braces (<code>{</code> and <code>}</code>). The <code>{</code> denotes the start of the inline tag, and the <code>}</code> denotes the end of the inline tag. If your tag's text includes a closing curly brace (<code>}</code>),
45
-
you must escape it with a leading backslash (<code>\</code>). You do not need to use a line break after inline tags.</p>
46
-
<p>Most JSDoc tags are block tags. In general, when this site refers to "JSDoc tags," we really mean "block tags."</p>
40
+
<p>Block tags usually provide detailed information about your code, such as the parameters that a
41
+
function accepts. Inline tags usually link to other parts of the documentation, similar to the
42
+
anchor tag (<code><a></code>) in HTML.</p>
43
+
<p>Block tags always begin with an at sign (<code>@</code>). Each block tag must be followed by a line break,
44
+
with the exception of the last block tag in a JSDoc comment.</p>
45
+
<p>Inline tags also begin with an at sign. However, inline tags and their text must be enclosed in
46
+
curly braces (<code>{</code> and <code>}</code>). The <code>{</code> denotes the start of the inline tag, and the <code>}</code> denotes the end
47
+
of the inline tag. If your tag's text includes a closing curly brace (<code>}</code>), you must escape it with
48
+
a leading backslash (<code>\</code>). You do not need to use a line break after inline tags.</p>
49
+
<p>Most JSDoc tags are block tags. In general, when this site refers to "JSDoc tags," we really mean
50
+
"block tags."</p>
47
51
<h2id="examples">Examples</h2>
48
52
<p>In the following example, <code>@param</code> is a block tag, and <code>{@link}</code> is an inline tag:</p>
49
53
<figure>
50
-
<figcaption>Block and inline tags in JSDoc comments</figcaption><preclass="prettyprint lang-js"><code>/**
54
+
<figcaption>Block and inline tags in JSDoc comments</figcaption>
55
+
<preclass="prettyprint lang-js"><code>/**
51
56
* Set the shoe's color. Use {@link Shoe#setSize} to set the shoe size.
52
57
*
53
58
* @param {string} color - The shoe's color.
@@ -59,7 +64,8 @@ <h2 id="examples">Examples</h2>
59
64
</figure>
60
65
<p>You can use inline tags within a description, as shown above, or within a block tag, as shown below:</p>
61
66
<figure>
62
-
<figcaption>Inline tag used within a block tag</figcaption><preclass="prettyprint lang-js"><code>/**
67
+
<figcaption>Inline tag used within a block tag</figcaption>
68
+
<preclass="prettyprint lang-js"><code>/**
63
69
* Set the shoe's color.
64
70
*
65
71
* @param {SHOE_COLORS} color - The shoe color. Must be an enumerated
@@ -72,7 +78,8 @@ <h2 id="examples">Examples</h2>
72
78
</figure>
73
79
<p>When you use multiple block tags in a JSDoc comment, they must be separated by line breaks:</p>
74
80
<figure>
75
-
<figcaption>Multiple block tags separated by line breaks</figcaption><preclass="prettyprint lang-js"><code>/**
81
+
<figcaption>Multiple block tags separated by line breaks</figcaption>
82
+
<preclass="prettyprint lang-js"><code>/**
76
83
* Set the color and type of the shoelaces.
77
84
*
78
85
* @param {LACE_COLORS} color - The shoelace color.
<ahref="https://github.com/jsdoc3/jsdoc3.github.com/contributors">contributors</a> to the JSDoc 3 documentation project.
93
-
<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
40
-
instructions</a>.</p>
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>
38
+
<p>Additionally, one may provide the path to a <ahref="http://daringfireball.net/projects/markdown/">Markdown file</a> (ending in ".md") or a
39
+
file
40
+
named "README", and this will be added to the documentation on the front page. See <ahref="about-including-readme.html">these
41
+
instructions</a>.</p>
42
+
<p>JSDoc supports a number of command-line options, many of which have both long and short forms.
43
+
Alternatively, the command-line options may be <ahref="about-configuring-jsdoc.html">specified in a configuration file</a>
<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
-
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.
<td>Assume this encoding when reading all source files. Defaults to <code>utf8</code>.</td>
76
75
</tr>
77
76
<tr>
78
-
<td><code>-h</code>, <code>--help</code>
79
-
</td>
77
+
<td><code>-h</code>, <code>--help</code></td>
80
78
<td>Display information about JSDoc's command-line options, then exit.</td>
81
79
</tr>
82
80
<tr>
83
-
<td><code>--match <value></code>
84
-
</td>
81
+
<td><code>--match <value></code></td>
85
82
<td>Only run tests whose names contain <code>value</code>.</td>
86
83
</tr>
87
84
<tr>
88
-
<td><code>--nocolor</code>
89
-
</td>
85
+
<td><code>--nocolor</code></td>
90
86
<td>When running tests, do not use color in the console output. On Windows, this option is enabled by default.</td>
91
87
</tr>
92
88
<tr>
93
-
<td><code>-p</code>, <code>--private</code>
94
-
</td>
95
-
<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
-
not included.</td>
89
+
<td><code>-p</code>, <code>--private</code></td>
90
+
<td>Include symbols marked with the <ahref="tags-private.html"><code>@private</code> tag</a> in the generated documentation. By default, private
91
+
symbols are not included.</td>
97
92
</tr>
98
93
<tr>
99
-
<td><code>-P</code>, <code>--package</code>
100
-
</td>
101
-
<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
-
in the source paths.</td>
94
+
<td><code>-P</code>, <code>--package</code></td>
95
+
<td>The <code>package.json</code> file that contains the project name, version, and other details. Defaults to the first <code>package.json</code>
96
+
file found in the source paths.</td>
103
97
</tr>
104
98
<tr>
105
-
<td><code>--pedantic</code>
106
-
</td>
99
+
<td><code>--pedantic</code></td>
107
100
<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
105
</tr>
114
106
<tr>
115
-
<td><code>-r</code>, <code>--recurse</code>
116
-
</td>
107
+
<td><code>-r</code>, <code>--recurse</code></td>
117
108
<td>Recurse into subdirectories when scanning for source files and tutorials.</td>
118
109
</tr>
119
110
<tr>
120
-
<td><code>-R</code>, <code>--readme</code>
121
-
</td>
122
-
<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>
111
+
<td><code>-R</code>, <code>--readme</code></td>
112
+
<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
<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>
<ahref="https://github.com/jsdoc3/jsdoc3.github.com/contributors">contributors</a> to the JSDoc 3 documentation project.
177
-
<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