Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 41bc71f

Browse files
hegemonichegemonic
committedJan 31, 2013
regenerate index
1 parent 9039c5d commit 41bc71f

File tree

1 file changed

+54
-59
lines changed

1 file changed

+54
-59
lines changed
 

‎index.html

Lines changed: 54 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,8 @@ <h2 name="Getting_Started" id="Getting_Started">Getting Started</h2>
213213
<dd>About the command-line options JSDoc supports.</dd>
214214
<dt><a href="about-configuring-jsdoc.html">Configuring JSDoc 3 with conf.json</a></dt>
215215
<dd>How to configure JSDoc's output with a configuration file.</dd>
216+
<dt><a href="about-inline-tags.html">Linking using inline tags</a></dt>
217+
<dd>All about inline tags @link, @linkplain, @linkcode, @tutorial.</dd>
216218
<dt><a href="about-plugins.html">All about plugins</a></dt>
217219
<dd>Installing plugins and writing your own.</dd>
218220
<dt><a href="plugins-markdown.html">Configuring the markdown plugin</a></dt>
@@ -239,67 +241,60 @@ <h2 name="Contribute" id="Contribute">Contribute</h2>
239241

240242
<h2 name="JSDoc3_Tag_Dictionary" id="JSDoc3_Tag_Dictionary">JSDoc 3 Tag Dictionary</h2>
241243
<dl>
242-
<dt><a href="tags-event.html">@event</a></dt>
243-
<dd>Document an event.</dd> <dt><a href="tags-deprecated.html">@deprecated</a></dt>
244-
<dd>Document that this is no longer the preferred way.</dd> <dt><a href="tags-mixes.html">@mixes</a></dt>
245-
<dd>[todo] This object mixes in all the members from another object.</dd> <dt><a href="tags-constant.html">@constant</a></dt>
246-
<dd>Document an object as a constant.</dd> <dt><a href="tags-summary.html">@summary</a></dt>
247-
<dd>[todo] A shorter version of the full description.</dd> <dt><a href="tags-abstract.html">@abstract</a></dt>
248-
<dd>This member is meant to be abstract.</dd> <dt><a href="tags-memberof.html">@memberof</a></dt>
249-
<dd>[todo] This object is a member or another object.</dd> <dt><a href="tags-constructor.html">@constructor</a></dt>
250-
<dd>This function is intended to be called with the &quot;new&quot; keyword.</dd> <dt><a href="tags-tagname.html">@tagname</a></dt>
251-
<dd>[todo]</dd> <dt><a href="tags-requires.html">@requires</a></dt>
252-
<dd>[todo] This JavaScript module requires another JavaScript module.</dd> <dt><a href="tags-version.html">@version</a></dt>
253-
<dd>Documents the version number of an item.</dd> <dt><a href="tags-throws.html">@throws</a></dt>
254-
<dd>[todo] Describe what errors could be thrown.</dd> <dt><a href="tags-classdesc.html">@classdesc</a></dt>
255-
<dd>Use the following text to describe the entire class.</dd> <dt><a href="tags-author.html">@author</a></dt>
256-
<dd>Documents the author of an item.</dd> <dt><a href="tags-kind.html">@kind</a></dt>
257-
<dd>[todo] What kind of object is this?</dd> <dt><a href="tags-member.html">@member</a></dt>
258-
<dd>[todo] Document a member.</dd> <dt><a href="tags-since.html">@since</a></dt>
259-
<dd>[todo] When was this feature added?</dd> <dt><a href="tags-access.html">@access</a></dt>
260-
<dd>Specify the access level of this member - private, public, or protected.</dd> <dt><a href="tags-borrows.html">@borrows</a></dt>
261-
<dd>This object uses something from another object.</dd> <dt><a href="tags-mixin.html">@mixin</a></dt>
262-
<dd>[todo] Document a mix-in object.</dd> <dt><a href="tags-see.html">@see</a></dt>
263-
<dd>[todo] Refer to some other documentation for more information.</dd> <dt><a href="tags-tagname.html">@tagname</a></dt>
264-
<dd>[todo]</dd> <dt><a href="tags-file.html">@file</a></dt>
265-
<dd>Describe a file.</dd> <dt><a href="tags-example.html">@example</a></dt>
266-
<dd>Provide an example of how to use a documented item.</dd> <dt><a href="tags-tutorial.html">@tutorial</a></dt>
267-
<dd>Insert a link to an included tutorial file.</dd> <dt><a href="tags-license.html">@license</a></dt>
268-
<dd>[todo] Document the software license that applies to this code.</dd> <dt><a href="tags-fires.html">@fires</a></dt>
269-
<dd>Describe the events this method may fire.</dd> <dt><a href="tags-callback.html">@callback</a></dt>
270-
<dd>Document a callback function.</dd> <dt><a href="tags-module.html">@module</a></dt>
271-
<dd>[todo] Document a JavaScript module.</dd> <dt><a href="tags-protected.html">@protected</a></dt>
272-
<dd>[todo] This member is meant to be protected.</dd> <dt><a href="tags-typedef.html">@typedef</a></dt>
273-
<dd>[todo] Document a custom type.</dd> <dt><a href="tags-global.html">@global</a></dt>
274-
<dd>Document a global object.</dd> <dt><a href="tags-public.html">@public</a></dt>
275-
<dd>[todo] This member is meant to be public.</dd> <dt><a href="tags-this.html">@this</a></dt>
276-
<dd>[todo] What does the this keyword refer to here?</dd> <dt><a href="tags-readonly.html">@readonly</a></dt>
277-
<dd>[todo] This variable is meant to be readonly.</dd> <dt><a href="tags-augments.html">@augments</a></dt>
278-
<dd>This object adds onto a parent object.</dd> <dt><a href="tags-type.html">@type</a></dt>
279-
<dd>[todo] Document the type of an object.</dd> <dt><a href="tags-tagname.html">@tagname</a></dt>
280-
<dd>[todo]</dd> <dt><a href="tags-tagname.html">@tagname</a></dt>
281-
<dd>[todo]</dd> <dt><a href="tags-exports.html">@exports</a></dt>
282-
<dd>Document the name of a JavaScript module.</dd> <dt><a href="tags-constructs.html">@constructs</a></dt>
283-
<dd>This function member will be the constructor for the previous class.</dd> <dt><a href="tags-ignore.html">@ignore</a></dt>
244+
<dt><a href="about-inline-tags.html">Inline tags</a></dt>
245+
<dd>All about inline tags {@link ...}, {@linkplain ...}, {@linkcode ...}, {@tutorial ...}.</dd>
246+
<dt><a href="tags-augments.html">@augments</a></dt>
247+
<dd>This object adds onto a parent object.</dd> <dt><a href="tags-author.html">@author</a></dt>
248+
<dd>Documents the author of an item.</dd> <dt><a href="tags-borrows.html">@borrows</a></dt>
249+
<dd>This object uses something from another object.</dd> <dt><a href="tags-callback.html">@callback</a></dt>
250+
<dd>Document a callback function.</dd> <dt><a href="tags-classdesc.html">@classdesc</a></dt>
251+
<dd>Use the following text to describe the entire class.</dd> <dt><a href="tags-constant.html">@constant</a></dt>
252+
<dd>Document an object as a constant.</dd> <dt><a href="tags-constructor.html">@constructor</a></dt>
253+
<dd>This function is intended to be called with the &quot;new&quot; keyword.</dd> <dt><a href="tags-constructs.html">@constructs</a></dt>
254+
<dd>This function member will be the constructor for the previous class.</dd> <dt><a href="tags-copyright.html">@copyright</a></dt>
255+
<dd>Document some copyright information.</dd> <dt><a href="tags-default.html">@default</a></dt>
256+
<dd>Document the default value.</dd> <dt><a href="tags-deprecated.html">@deprecated</a></dt>
257+
<dd>Document that this is no longer the preferred way.</dd> <dt><a href="tags-description.html">@desc</a></dt>
258+
<dd>Describe the object.</dd> <dt><a href="tags-enum.html">@enum</a></dt>
259+
<dd>Document a collection of related properties.</dd> <dt><a href="tags-event.html">@event</a></dt>
260+
<dd>Document an event.</dd> <dt><a href="tags-example.html">@example</a></dt>
261+
<dd>Provide an example of how to use a documented item.</dd> <dt><a href="tags-exports.html">@exports</a></dt>
262+
<dd>Document the name of a JavaScript module.</dd> <dt><a href="tags-file.html">@file</a></dt>
263+
<dd>Describe a file.</dd> <dt><a href="tags-fires.html">@fires</a></dt>
264+
<dd>Describe the events this method may fire.</dd> <dt><a href="tags-global.html">@global</a></dt>
265+
<dd>Document a global object.</dd> <dt><a href="tags-ignore.html">@ignore</a></dt>
284266
<dd>[todo] Remove this from the final output.</dd> <dt><a href="tags-inner.html">@inner</a></dt>
285-
<dd>[todo] Document an inner object.</dd> <dt><a href="tags-todo.html">@todo</a></dt>
286-
<dd>[todo] Document tasks to be completed for an object.</dd> <dt><a href="tags-property.html">@property</a></dt>
287-
<dd>Document a property of an object.</dd> <dt><a href="tags-returns.html">@returns</a></dt>
288-
<dd>Document the return value of a function.</dd> <dt><a href="tags-static.html">@static</a></dt>
289-
<dd>Document a static member.</dd> <dt><a href="tags-param.html">@param</a></dt>
290-
<dd>&gt;Document the parameter to a function.</dd> <dt><a href="tags-copyright.html">@copyright</a></dt>
291-
<dd>Document some copyright information.</dd> <dt><a href="tags-description.html">@desc</a></dt>
292-
<dd>Describe the object.</dd> <dt><a href="tags-instance.html">@instance</a></dt>
293-
<dd>[todo] Document an instance member.</dd> <dt><a href="tags-external.html">@external</a></dt>
294-
<dd>[todo]</dd> <dt><a href="tags-name.html">@name</a></dt>
267+
<dd>[todo] Document an inner object.</dd> <dt><a href="tags-instance.html">@instance</a></dt>
268+
<dd>[todo] Document an instance member.</dd> <dt><a href="tags-kind.html">@kind</a></dt>
269+
<dd>[todo] What kind of object is this?</dd> <dt><a href="tags-license.html">@license</a></dt>
270+
<dd>[todo] Document the software license that applies to this code.</dd> <dt><a href="tags-link.html">@link</a></dt>
271+
<dd>[IN PROGRESS] Inline tag - create a link.</dd> <dt><a href="tags-member.html">@member</a></dt>
272+
<dd>[todo] Document a member.</dd> <dt><a href="tags-memberof.html">@memberof</a></dt>
273+
<dd>[todo] This object is a member or another object.</dd> <dt><a href="tags-method.html">@method</a></dt>
274+
<dd>[todo] Describe a method or function.</dd> <dt><a href="tags-mixes.html">@mixes</a></dt>
275+
<dd>[todo] This object mixes in all the members from another object.</dd> <dt><a href="tags-mixin.html">@mixin</a></dt>
276+
<dd>[todo] Document a mix-in object.</dd> <dt><a href="tags-module.html">@module</a></dt>
277+
<dd>[todo] Document a JavaScript module.</dd> <dt><a href="tags-name.html">@name</a></dt>
295278
<dd>[todo] Document the name of an object.</dd> <dt><a href="tags-namespace.html">@namespace</a></dt>
296-
<dd>[todo] Document a namespace object.</dd> <dt><a href="tags-enum.html">@enum</a></dt>
297-
<dd>Document a collection of related properties.</dd> <dt><a href="tags-default.html">@default</a></dt>
298-
<dd>Document the default value.</dd> <dt><a href="tags-tagname.html">@tagname</a></dt>
299-
<dd>[todo]</dd> <dt><a href="tags-tagname.html">@tagname</a></dt>
300-
<dd>[todo]</dd> <dt><a href="tags-private.html">@private</a></dt>
301-
<dd>[todo] This member is meant to be private.</dd> <dt><a href="tags-method.html">@method</a></dt>
302-
<dd>[todo] Describe a method or function.</dd></dl>
279+
<dd>[todo] Document a namespace object.</dd> <dt><a href="tags-param.html">@param</a></dt>
280+
<dd>&gt;Document the parameter to a function.</dd> <dt><a href="tags-private.html">@private</a></dt>
281+
<dd>[todo] This member is meant to be private.</dd> <dt><a href="tags-property.html">@property</a></dt>
282+
<dd>Document a property of an object.</dd> <dt><a href="tags-protected.html">@protected</a></dt>
283+
<dd>[todo] This member is meant to be protected.</dd> <dt><a href="tags-public.html">@public</a></dt>
284+
<dd>[todo] This member is meant to be public.</dd> <dt><a href="tags-readonly.html">@readonly</a></dt>
285+
<dd>[todo] This variable is meant to be readonly.</dd> <dt><a href="tags-requires.html">@requires</a></dt>
286+
<dd>[todo] This JavaScript module requires another JavaScript module.</dd> <dt><a href="tags-returns.html">@returns</a></dt>
287+
<dd>Document the return value of a function.</dd> <dt><a href="tags-see.html">@see</a></dt>
288+
<dd>[todo] Refer to some other documentation for more information.</dd> <dt><a href="tags-since.html">@since</a></dt>
289+
<dd>[todo] When was this feature added?</dd> <dt><a href="tags-summary.html">@summary</a></dt>
290+
<dd>[todo] A shorter version of the full description.</dd> <dt><a href="tags-this.html">@this</a></dt>
291+
<dd>[todo] What does the this keyword refer to here?</dd> <dt><a href="tags-throws.html">@throws</a></dt>
292+
<dd>[todo] Describe what errors could be thrown.</dd> <dt><a href="tags-todo.html">@todo</a></dt>
293+
<dd>[todo] Document tasks to be completed for an object.</dd> <dt><a href="tags-tutorial.html">@tutorial</a></dt>
294+
<dd>Insert a link to an included tutorial file.</dd> <dt><a href="tags-type.html">@type</a></dt>
295+
<dd>[todo] Document the type of an object.</dd> <dt><a href="tags-typedef.html">@typedef</a></dt>
296+
<dd>[todo] Document a custom type.</dd> <dt><a href="tags-version.html">@version</a></dt>
297+
<dd>Documents the version number of an item.</dd></dl>
303298

304299
<p>
305300
<link href="styles/css3-github-ribbon.css" rel="stylesheet" />

0 commit comments

Comments
 (0)
Please sign in to comment.