forked from jsdoc/jsdoc.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
231 lines (228 loc) · 12.1 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
<!DOCTYPE html>
<!-- THIS IS A GENERATED FILE. DO NOT EDIT. -->
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="description" content="Official documentation for JSDoc 3.">
<title>Use JSDoc: Index</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
<script src="scripts/prettify.js"></script>
</head>
<body>
<header>
<a href="./index.html">@use JSDoc</a>
</header>
<article>
<h1>Index</h1>
<h2>Getting Started</h2>
<dl>
<dt><a href="about-getting-started.html">Getting Started with JSDoc 3</a></dt>
<dd>A quick-start to documenting JavaScript with JSDoc.</dd>
<dt><a href="about-namepaths.html">Using namepaths with JSDoc 3</a></dt>
<dd>A guide to using namepaths with JSDoc 3.</dd>
<dt><a href="about-commandline.html">Command-line arguments to JSDoc</a></dt>
<dd>About command-line arguments to JSDoc.</dd>
<dt><a href="about-configuring-jsdoc.html">Configuring JSDoc with a configuration file</a></dt>
<dd>How to configure JSDoc using a configuration file.</dd>
<dt><a href="about-configuring-default-template.html">Configuring JSDoc's default template</a></dt>
<dd>How to configure the output from JSDoc's default template.</dd>
<dt><a href="about-block-inline-tags.html">Block and inline tags</a></dt>
<dd>Overview of block and inline JSDoc tags.</dd>
<dt><a href="about-plugins.html">About JSDoc plugins</a></dt>
<dd>How to create and use JSDoc plugins.</dd>
<dt><a href="plugins-markdown.html">Using the Markdown plugin</a></dt>
<dd>Enable Markdown support in JSDoc.</dd>
<dt><a href="about-tutorials.html">Tutorials</a></dt>
<dd>Adding tutorials to your API documentation.</dd>
<dt><a href="about-including-package.html">Including a Package File</a></dt>
<dd>How to show package details in your documentation.</dd>
<dt><a href="about-including-readme.html">Including a README File</a></dt>
<dd>How to include a README file in your documentation.</dd>
<dt><a href="about-license-jsdoc3.html">License</a></dt>
<dd>License information for JSDoc 3.</dd>
</dl>
<h2>JSDoc Examples</h2>
<dl>
<dt><a href="howto-es2015-classes.html">ES 2015 Classes</a></dt>
<dd>How to add JSDoc comments to ECMAScript 2015 classes.</dd>
<dt><a href="howto-es2015-modules.html">ES 2015 Modules</a></dt>
<dd>How to add JSDoc comments to ECMAScript 2015 modules.</dd>
<dt><a href="howto-commonjs-modules.html">CommonJS Modules</a></dt>
<dd>How to add JSDoc comments to CommonJS and Node.js modules.</dd>
<dt><a href="howto-amd-modules.html">AMD Modules</a></dt>
<dd>How to add JSDoc comments to AMD and RequireJS modules.</dd>
</dl>
<h2 id="block-tags">Block Tags</h2>
<dl>
<dt><a href="tags-abstract.html">@abstract</a> (synonyms: @virtual)</dt>
<dd>This member must be implemented (or overridden) by the inheritor.</dd>
<dt><a href="tags-access.html">@access</a></dt>
<dd>Specify the access level of this member (private, package-private, public, or protected).</dd>
<dt><a href="tags-alias.html">@alias</a></dt>
<dd>Treat a member as if it had a different name.</dd>
<dt><a href="tags-async.html">@async</a></dt>
<dd>Indicate that a function is asynchronous.</dd>
<dt><a href="tags-augments.html">@augments</a> (synonyms: @extends)</dt>
<dd>Indicate that a symbol inherits from, and adds to, a parent symbol.</dd>
<dt><a href="tags-author.html">@author</a></dt>
<dd>Identify the author of an item.</dd>
<dt><a href="tags-borrows.html">@borrows</a></dt>
<dd>This object uses something from another object.</dd>
<dt><a href="tags-callback.html">@callback</a></dt>
<dd>Document a callback function.</dd>
<dt><a href="tags-class.html">@class</a> (synonyms: @constructor)</dt>
<dd>This function is intended to be called with the "new" keyword.</dd>
<dt><a href="tags-classdesc.html">@classdesc</a></dt>
<dd>Use the following text to describe the entire class.</dd>
<dt><a href="tags-constant.html">@constant</a> (synonyms: @const)</dt>
<dd>Document an object as a constant.</dd>
<dt><a href="tags-constructs.html">@constructs</a></dt>
<dd>This function member will be the constructor for the previous class.</dd>
<dt><a href="tags-copyright.html">@copyright</a></dt>
<dd>Document some copyright information.</dd>
<dt><a href="tags-default.html">@default</a> (synonyms: @defaultvalue)</dt>
<dd>Document the default value.</dd>
<dt><a href="tags-deprecated.html">@deprecated</a></dt>
<dd>Document that this is no longer the preferred way.</dd>
<dt><a href="tags-description.html">@description</a> (synonyms: @desc)</dt>
<dd>Describe a symbol.</dd>
<dt><a href="tags-enum.html">@enum</a></dt>
<dd>Document a collection of related properties.</dd>
<dt><a href="tags-event.html">@event</a></dt>
<dd>Document an event.</dd>
<dt><a href="tags-example.html">@example</a></dt>
<dd>Provide an example of how to use a documented item.</dd>
<dt><a href="tags-exports.html">@exports</a></dt>
<dd>Identify the member that is exported by a JavaScript module.</dd>
<dt><a href="tags-external.html">@external</a> (synonyms: @host)</dt>
<dd>Identifies an external class, namespace, or module.</dd>
<dt><a href="tags-file.html">@file</a> (synonyms: @fileoverview, @overview)</dt>
<dd>Describe a file.</dd>
<dt><a href="tags-fires.html">@fires</a> (synonyms: @emits)</dt>
<dd>Describe the events this method may fire.</dd>
<dt><a href="tags-function.html">@function</a> (synonyms: @func, @method)</dt>
<dd>Describe a function or method.</dd>
<dt><a href="tags-generator.html">@generator</a></dt>
<dd>Indicate that a function is a generator function.</dd>
<dt><a href="tags-global.html">@global</a></dt>
<dd>Document a global object.</dd>
<dt><a href="tags-hideconstructor.html">@hideconstructor</a></dt>
<dd>Indicate that the constructor should not be displayed.</dd>
<dt><a href="tags-ignore.html">@ignore</a></dt>
<dd>Omit a symbol from the documentation.</dd>
<dt><a href="tags-implements.html">@implements</a></dt>
<dd>This symbol implements an interface.</dd>
<dt><a href="tags-inheritdoc.html">@inheritdoc</a></dt>
<dd>Indicate that a symbol should inherit its parent's documentation.</dd>
<dt><a href="tags-inner.html">@inner</a></dt>
<dd>Document an inner object.</dd>
<dt><a href="tags-instance.html">@instance</a></dt>
<dd>Document an instance member.</dd>
<dt><a href="tags-interface.html">@interface</a></dt>
<dd>This symbol is an interface that others can implement.</dd>
<dt><a href="tags-kind.html">@kind</a></dt>
<dd>What kind of symbol is this?</dd>
<dt><a href="tags-lends.html">@lends</a></dt>
<dd>Document properties on an object literal as if they belonged to a symbol with a given name.</dd>
<dt><a href="tags-license.html">@license</a></dt>
<dd>Identify the license that applies to this code.</dd>
<dt><a href="tags-listens.html">@listens</a></dt>
<dd>List the events that a symbol listens for.</dd>
<dt><a href="tags-member.html">@member</a> (synonyms: @var)</dt>
<dd>Document a member.</dd>
<dt><a href="tags-memberof.html">@memberof</a></dt>
<dd>This symbol belongs to a parent symbol.</dd>
<dt><a href="tags-mixes.html">@mixes</a></dt>
<dd>This object mixes in all the members from another object.</dd>
<dt><a href="tags-mixin.html">@mixin</a></dt>
<dd>Document a mixin object.</dd>
<dt><a href="tags-module.html">@module</a></dt>
<dd>Document a JavaScript module.</dd>
<dt><a href="tags-name.html">@name</a></dt>
<dd>Document the name of an object.</dd>
<dt><a href="tags-namespace.html">@namespace</a></dt>
<dd>Document a namespace object.</dd>
<dt><a href="tags-override.html">@override</a></dt>
<dd>Indicate that a symbol overrides its parent.</dd>
<dt><a href="tags-package.html">@package</a></dt>
<dd>This symbol is meant to be package-private.</dd>
<dt><a href="tags-param.html">@param</a> (synonyms: @arg, @argument)</dt>
<dd>Document the parameter to a function.</dd>
<dt><a href="tags-private.html">@private</a></dt>
<dd>This symbol is meant to be private.</dd>
<dt><a href="tags-property.html">@property</a> (synonyms: @prop)</dt>
<dd>Document a property of an object.</dd>
<dt><a href="tags-protected.html">@protected</a></dt>
<dd>This symbol is meant to be protected.</dd>
<dt><a href="tags-public.html">@public</a></dt>
<dd>This symbol is meant to be public.</dd>
<dt><a href="tags-readonly.html">@readonly</a></dt>
<dd>This symbol is meant to be read-only.</dd>
<dt><a href="tags-requires.html">@requires</a></dt>
<dd>This file requires a JavaScript module.</dd>
<dt><a href="tags-returns.html">@returns</a> (synonyms: @return)</dt>
<dd>Document the return value of a function.</dd>
<dt><a href="tags-see.html">@see</a></dt>
<dd>Refer to some other documentation for more information.</dd>
<dt><a href="tags-since.html">@since</a></dt>
<dd>When was this feature added?</dd>
<dt><a href="tags-static.html">@static</a></dt>
<dd>Document a static member.</dd>
<dt><a href="tags-summary.html">@summary</a></dt>
<dd>A shorter version of the full description.</dd>
<dt><a href="tags-this.html">@this</a></dt>
<dd>What does the 'this' keyword refer to here?</dd>
<dt><a href="tags-throws.html">@throws</a> (synonyms: @exception)</dt>
<dd>Describe what errors could be thrown.</dd>
<dt><a href="tags-todo.html">@todo</a></dt>
<dd>Document tasks to be completed.</dd>
<dt><a href="tags-tutorial.html">@tutorial</a></dt>
<dd>Insert a link to an included tutorial file.</dd>
<dt><a href="tags-type.html">@type</a></dt>
<dd>Document the type of an object.</dd>
<dt><a href="tags-typedef.html">@typedef</a></dt>
<dd>Document a custom type.</dd>
<dt><a href="tags-variation.html">@variation</a></dt>
<dd>Distinguish different objects with the same name.</dd>
<dt><a href="tags-version.html">@version</a></dt>
<dd>Documents the version number of an item.</dd>
<dt><a href="tags-yields.html">@yields</a> (synonyms: @yield)</dt>
<dd>Document the value yielded by a generator function.</dd>
</dl>
<h2 id="inline-tags">Inline Tags</h2>
<dl>
<dt><a href="tags-inline-link.html">{@link}</a> (synonyms: {@linkcode}, {@linkplain})</dt>
<dd>Link to another item in the documentation.</dd>
<dt><a href="tags-inline-tutorial.html">{@tutorial}</a></dt>
<dd>Link to a tutorial.</dd>
</dl>
<h2>Contribute</h2>
<dl>
<dt><a href="https://github.com/jsdoc3/jsdoc">JSDoc project on GitHub</a></dt>
<dd>Contribute to JSDoc.</dd>
<dt><a href="https://github.com/jsdoc3/jsdoc3.github.com">Use JSDoc project on GitHub</a></dt>
<dd>Contribute to the JSDoc documentation.</dd>
</dl>
<p>
<a href="https://github.com/jsdoc3/jsdoc" class="github-ribbon">Fork me on GitHub</a>
</p>
</article>
<footer>
<a class="license-badge" href="http://creativecommons.org/licenses/by-sa/3.0/">
<img alt="Creative Commons License" class="license-badge" src="images/cc-by-sa.svg" width="80" height="15" /></a>
<br>
Copyright © 2011-2017 the
<a href="https://github.com/jsdoc3/jsdoc3.github.com/contributors">contributors</a> to the
JSDoc 3 documentation project.
<br>
This website is <a href="https://github.com/jsdoc3/jsdoc3.github.com">open source</a> and is
licensed under the <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">
Creative Commons Attribution-ShareAlike 3.0 Unported License</a>.
</footer>
<script type="text/javascript">
prettyPrint();
</script>
</body>
</html>