diff --git a/Jake/articles/tags-lends b/Jake/articles/tags-lends new file mode 100644 index 00000000..d276851d --- /dev/null +++ b/Jake/articles/tags-lends @@ -0,0 +1,111 @@ + +

Syntax

+ +@lends <namepath> + +

Overview

+ +

+ The @lends tag allows you to document all the members of an anonymous object literal as if they + were members of an object with the given name. You might want to do this if you were passing an anonymous + object literal into a function that creates a named class from its members +

+ +

Examples

+ +

+ In this example we want to use a helper function to make a class named "Person," along with instance + methods named "initialize" and "say." This is similar to how some popular frameworks handle class creation. +

+ +{{#example}} Example class +// we want to document this as being a class +var Person = makeClass( + // we want to document these as being methods + { + initialize: function(name) { + this.name = name; + }, + say: function(message) { + return this.name + " says: " + message; + } + } +); +{{/example}} + +

+ Without any doc comments JSDoc won't automatically recognize either a class named "Person" nor it's + two methods. To document the methods we must use a "@lends" tag in a doc comment immediately before the + object literal to tell JSDoc that all the member names of that object literal are being "lent" to a + variable named "Person." +

+ +{{#example}} Documented as static methods +/** @class */ +var Person = makeClass( + /** @lends Person */ + { + initialize: function(name) { + this.name = name; + }, + say: function(message) { + return this.name + " says: " + message; + } + } +); +{{/example}} + +

+ Now the functions named "initialize" and "say" will be documented, but they appear as static methods of an + class named "Person." That is possibly what you meant, but in this case we want "initialize" and "say" to + belong to the instances of the "Person" class. So we change things slightly by lending the methods to the + class's prototype: +

+ +{{#example}} Documented as instance methods +/** @class */ +var Person = makeClass( + /** @lends Person.prototype */ + { + initialize: function(name) { + this.name = name; + }, + say: function(message) { + return this.name + " says: " + message; + } + } +); +{{/example}} + +

+ If you are using one of the lent functions to construct the class, you can mark it as such using the + @constructs tag, but remember to remove the @class tag in that case, or else two @classes will be documented. +

+ +{{#example}} Documented constructor +var Person = makeClass( + /** + @lends Person.prototype + */ + { + /** @constructs */ + initialize: function(name) { + this.name = name; + }, + say: function(message) { + return this.name + " says: " + message; + } + } +); +{{/example}} + +

See Also

+ + \ No newline at end of file diff --git a/Jakefile.js b/Jakefile.js index 2569c125..5cd5bd54 100644 --- a/Jakefile.js +++ b/Jakefile.js @@ -50,7 +50,7 @@ task('default', [], function (params) { console.log('Building new gh-pages...'); articles.forEach(function (article) { - var html = Mustache.to_html( + var html = convertEOL(Mustache.to_html( templates.article, { title : article.title, description : article.description, @@ -69,7 +69,7 @@ task('default', [], function (params) { head : templates.head, foot : templates.foot, article : article.body - }); + }), '\n'); fs.writeFileSync(outdir + article.out, html, 'utf8'); console.log('> created ' + outdir + article.out); diff --git a/about-getting-started.html b/about-getting-started.html index 8679ce57..173a6508 100644 --- a/about-getting-started.html +++ b/about-getting-started.html @@ -175,23 +175,23 @@

Getting Started with JSDoc 3

- -

Getting Started

- -

-JSDoc 3 is an API documentation generator for JavaScript, similar to JavaDoc or PHPDoc. You add documentation comments directly to your source code, right along side the code itself. The JSDoc Tool will scan your source code, and generate a complete HTML documentation website for you. -

- -

Adding Documentation Comments to Your Code

- -

-JSDoc's purpose is to document the API of your JavaScript application or library. It is assumed that you will want to document things like: namespaces, classes, methods, method parameters, etc. -

- -

-JSDoc comments should generally be placed immediately before the code being documented. It must start with a /** sequence in order to be recognized by the JSDoc parser. Comments beginning with /*, /***, or more than 3 stars will be ignored. This is a feature to allow you to suppress parsing of comment blocks. -

- + +

Getting Started

+ +

+JSDoc 3 is an API documentation generator for JavaScript, similar to JavaDoc or PHPDoc. You add documentation comments directly to your source code, right along side the code itself. The JSDoc Tool will scan your source code, and generate a complete HTML documentation website for you. +

+ +

Adding Documentation Comments to Your Code

+ +

+JSDoc's purpose is to document the API of your JavaScript application or library. It is assumed that you will want to document things like: namespaces, classes, methods, method parameters, etc. +

+ +

+JSDoc comments should generally be placed immediately before the code being documented. It must start with a /** sequence in order to be recognized by the JSDoc parser. Comments beginning with /*, /***, or more than 3 stars will be ignored. This is a feature to allow you to suppress parsing of comment blocks. +

+
The simplest documentation is just a description.
@@ -202,14 +202,14 @@

Adding Documentation Comments to Your Code

-

-Adding a description is simple, just type the description you want in the documentaton comment. -

- -

-Special "documentation tags" can be used to give more information. For example, if the function is a constructor, you can indicate this by adding a tag. -

- +

+Adding a description is simple, just type the description you want in the documentaton comment. +

+ +

+Special "documentation tags" can be used to give more information. For example, if the function is a constructor, you can indicate this by adding a tag. +

+
Use a documentation tag to describe your code.
@@ -223,10 +223,10 @@

Adding Documentation Comments to Your Code

-

-More tags can be used to add more information. See the Tag Dictionary for a complete list of tags that are recognized by JSDoc 3. -

- +

+More tags can be used to add more information. See the Tag Dictionary for a complete list of tags that are recognized by JSDoc 3. +

+
Adding more information with tags.
@@ -242,16 +242,16 @@

Adding Documentation Comments to Your Code

-

Generating A Website

- -

-Once your code is commented, you can use the JSDoc 3 Tool to generate an HTML website from the source. -

- -

-By default, JSDoc will use the "default" template to turn the documentation data into HTML. You can edit this template to suit your own needs, or create an entirely new template if that is what you prefer. -

- +

Generating A Website

+ +

+Once your code is commented, you can use the JSDoc 3 Tool to generate an HTML website from the source. +

+ +

+By default, JSDoc will use the "default" template to turn the documentation data into HTML. You can edit this template to suit your own needs, or create an entirely new template if that is what you prefer. +

+
Running the documentation generator on the command line.
@@ -260,8 +260,8 @@

Adding Documentation Comments to Your Code

-

-This command will create a folder named "out" in the current working directory. Within that you will find the generated HTML pages. +

+This command will create a folder named "out" in the current working directory. Within that you will find the generated HTML pages.

@@ -274,3 +274,4 @@

Adding Documentation Comments to Your Code

+ diff --git a/about-including-readme.html b/about-including-readme.html index ade4241a..add4bcf8 100644 --- a/about-including-readme.html +++ b/about-including-readme.html @@ -175,11 +175,11 @@

Including a Readme File With JSDoc 3

- -

Including a Readme File in Your Documentation With JSDoc 3

- -

To include a readme file in your documentation, you simply specify the location of your readme file on the command line along with the location of your source files. The readme file will be incorporated into the index.html of your documentation in the default template. The file must be written in markdown and given a .md extension.

- + +

Including a Readme File in Your Documentation With JSDoc 3

+ +

To include a readme file in your documentation, you simply specify the location of your readme file on the command line along with the location of your source files. The readme file will be incorporated into the index.html of your documentation in the default template. The file must be written in markdown and given a .md extension.

+
Including a readme file in your documentation
@@ -188,7 +188,7 @@

Including a Readme File in Your Documentation With JSDoc 3

-

If your file is successfully incorporated into the default template, it's content will be rendered in beautiful HTML just before the files list.

+

If your file is successfully incorporated into the default template, it's content will be rendered in beautiful HTML just before the files list.

@@ -201,3 +201,4 @@

Including a Readme File in Your Documentation With JSDoc 3

+ diff --git a/about-jsdoc3.html b/about-jsdoc3.html index 1041da85..875dc10f 100644 --- a/about-jsdoc3.html +++ b/about-jsdoc3.html @@ -365,3 +365,4 @@

+ diff --git a/about-license-jsdoc3.html b/about-license-jsdoc3.html index 07fd9cf9..c898ae30 100644 --- a/about-license-jsdoc3.html +++ b/about-license-jsdoc3.html @@ -315,3 +315,4 @@

TaffyDB

+ diff --git a/about-namepaths.html b/about-namepaths.html index b885d291..7558586b 100644 --- a/about-namepaths.html +++ b/about-namepaths.html @@ -175,13 +175,13 @@

Using namepaths with JSDoc 3

- -

Namepaths in JSDoc 3

- -

-When referring to a JavaScript variable that is elsewhere in your documentation, you must provide a unique identifier that maps to that variable. A namepath provides a way to do so and disambiguate between instance members, static members and inner variables. -

- + +

Namepaths in JSDoc 3

+ +

+When referring to a JavaScript variable that is elsewhere in your documentation, you must provide a unique identifier that maps to that variable. A namepath provides a way to do so and disambiguate between instance members, static members and inner variables. +

+
Basic Syntax Examples of Nameptahs in JSDoc 3
@@ -194,10 +194,10 @@

Namepaths in JSDoc 3

-

-The example below shows: an instance method named "say," an inner function also named "say," and a static method also named "say." These are three distinct methods that all exist independently of one another. -

- +

+The example below shows: an instance method named "say," an inner function also named "say," and a static method also named "say." These are three distinct methods that all exist independently of one another. +

+
Use a documentation tag to describe your code.
@@ -223,10 +223,10 @@

Namepaths in JSDoc 3

-

-You would use three different namepath syntaxes to refer to the three different methods: -

- +

+You would use three different namepath syntaxes to refer to the three different methods: +

+
Use a documentation tag to describe your code.
@@ -237,14 +237,14 @@

Namepaths in JSDoc 3

-

-You might wonder why there is a syntax to refer to an inner method when that method isn't directly accessible from outside the function it is defined in. While that is true, and thus the "~" syntax is rarely used, it is possible to return a reference to an inner method from another method inside that container, so it is possible that some object elsewhere in your code might borrow an inner method. -

- -

-Note that if a constructor has an instance member that is also a constructor, you can simply chain the namepaths together to form a longer namepath: -

- +

+You might wonder why there is a syntax to refer to an inner method when that method isn't directly accessible from outside the function it is defined in. While that is true, and thus the "~" syntax is rarely used, it is possible to return a reference to an inner method from another method inside that container, so it is possible that some object elsewhere in your code might borrow an inner method. +

+ +

+Note that if a constructor has an instance member that is also a constructor, you can simply chain the namepaths together to form a longer namepath: +

+

Use a documentation tag to describe your code.
@@ -265,11 +265,11 @@

Namepaths in JSDoc 3

-

-In this case, to refer to the method named "consider," you would use the following namepath: -Person#Idea#consider

- -

+

+In this case, to refer to the method named "consider," you would use the following namepath: +Person#Idea#consider

+ +

This chaining can be used with any combination of the connecting symbols: # . ~

@@ -283,3 +283,4 @@

Namepaths in JSDoc 3

+ diff --git a/about-plugins.html b/about-plugins.html index c003137f..d376c752 100644 --- a/about-plugins.html +++ b/about-plugins.html @@ -838,3 +838,4 @@

+ diff --git a/about-testing-jsdoc3.html b/about-testing-jsdoc3.html index 7c9fa4c3..52956d5e 100644 --- a/about-testing-jsdoc3.html +++ b/about-testing-jsdoc3.html @@ -175,15 +175,15 @@

Testing JSDoc 3

- - -

Testing JSDoc 3

- -

Running Tests

- -

Running tests is easy. Just change your working directory to the jsdoc folder -and run the following command on Windows:

- + + +

Testing JSDoc 3

+ +

Running Tests

+ +

Running tests is easy. Just change your working directory to the jsdoc folder +and run the following command on Windows:

+
Example
@@ -192,8 +192,8 @@

Running Tests

-

... or on a Max OSX or *nix platform:

- +

... or on a Max OSX or *nix platform:

+
Example
@@ -202,8 +202,8 @@

Running Tests

-

If you can't get the short-form commands to work, try invoking Java directly:

- +

If you can't get the short-form commands to work, try invoking Java directly:

+
Example
@@ -214,28 +214,28 @@

Running Tests

-

Writing Tests

- -

Adding tests is pretty easy, too. You can write tests for JSDoc itself (to -make sure tags and the parser, etc. are working properly), tests for plugins, and/or -tests for templates.

- -

JSDoc 3 uses Jasmine (https://github.com/pivotal/jasmine) as its testing framework. -Take a look at that project's wiki for documentation on writing tests in general.

- -

Tests for JSDoc

- -

Take a look at the files in the test directory for many examples of -writing tests for JSDoc itself. the test\fixtures directory hold fixtures -for use in the tests and the test\specs directory holds the tests themselves.

- -

Tests for plugins

- -

Tests for plugins are found in plugins\test directory. Plugins containing -tests that were installed with the Jakefile install task will be run automatically.

- -

Tests for templates

- +

Writing Tests

+ +

Adding tests is pretty easy, too. You can write tests for JSDoc itself (to +make sure tags and the parser, etc. are working properly), tests for plugins, and/or +tests for templates.

+ +

JSDoc 3 uses Jasmine (https://github.com/pivotal/jasmine) as its testing framework. +Take a look at that project's wiki for documentation on writing tests in general.

+ +

Tests for JSDoc

+ +

Take a look at the files in the test directory for many examples of +writing tests for JSDoc itself. the test\fixtures directory hold fixtures +for use in the tests and the test\specs directory holds the tests themselves.

+ +

Tests for plugins

+ +

Tests for plugins are found in plugins\test directory. Plugins containing +tests that were installed with the Jakefile install task will be run automatically.

+ +

Tests for templates

+

TODO

@@ -248,3 +248,4 @@

Tests for templates

+ diff --git a/about-tutorials.html b/about-tutorials.html index 20c2e089..377288ee 100644 --- a/about-tutorials.html +++ b/about-tutorials.html @@ -304,3 +304,4 @@
+ diff --git a/howto-commonjs-modules.html b/howto-commonjs-modules.html index 5f133960..9bd153e2 100644 --- a/howto-commonjs-modules.html +++ b/howto-commonjs-modules.html @@ -175,19 +175,19 @@

Document CommonJS Modules

- -

Overview

- -

-JSDoc 3 has built-in support for JavaScript code that is written to conform to the CommonJS Modules standard. This allows you to easily document your own JavaScript modules and the members they export. -

- -

Document a Simple CommonJS Module

- -

-Add a single @module <module identifier> tag at the top of the file that defines your module and any documented members of the exports object in that file will automatically be included in the documentation for that module. -

- + +

Overview

+ +

+JSDoc 3 has built-in support for JavaScript code that is written to conform to the CommonJS Modules standard. This allows you to easily document your own JavaScript modules and the members they export. +

+ +

Document a Simple CommonJS Module

+ +

+Add a single @module <module identifier> tag at the top of the file that defines your module and any documented members of the exports object in that file will automatically be included in the documentation for that module. +

+
The putOn and unbutton methods are documented as members of the "my/shirt" module.
@@ -204,12 +204,12 @@

Document a Simple CommonJS Module

-

Document Members Assigned to module.exports

- -

-Some implementations of the CommonJS Modules standard allow you to assign an object literal to the module.exports namespace directly. This pattern is automatically supported by JSDoc 3. -

- +

Document Members Assigned to module.exports

+ +

+Some implementations of the CommonJS Modules standard allow you to assign an object literal to the module.exports namespace directly. This pattern is automatically supported by JSDoc 3. +

+
The blend and darken methods are documented as members of the "color/mixer" module.
@@ -226,12 +226,12 @@

Document a Simple CommonJS Module

-

Document Members Exported on the Global this

- -

-JSDoc 3 understands the NodeJS convention of exporting properties and functions when they are assigned to a global this variable, as shown below. -

- +

Document Members Exported on the Global this

+ +

+JSDoc 3 understands the NodeJS convention of exporting properties and functions when they are assigned to a global this variable, as shown below. +

+
The Book class is documented as a member of the "bookshelf" module.
@@ -250,10 +250,10 @@

Document a Simple CommonJS Module

-

Document a Function that returns a RequireJS Module

- -

The RequireJS library provides a define method that allows you to write a function to return a module object. Use the @exports tag to document that all the members of an object literal should be documented as members of a module.

- +

Document a Function that returns a RequireJS Module

+ +

The RequireJS library provides a define method that allows you to write a function to return a module object. Use the @exports tag to document that all the members of an object literal should be documented as members of a module.

+
The color property and the Turtleneck class are documented as members of the "my/shirt" module.
@@ -281,10 +281,10 @@

Document a Simple CommonJS Module

-

Document a Module as a Constructor

- -

The following examples illustrate patterns for documenting modules that are constructors.

- +

Document a Module as a Constructor

+ +

The following examples illustrate patterns for documenting modules that are constructors.

+
Use the @alias tag simplify documenting a constructor-module in RequireJS.
@@ -310,8 +310,8 @@

Document a Simple CommonJS Module

-

The same pattern can be documented in CommonJS environments.

- +

The same pattern can be documented in CommonJS environments.

+
Use the @alias tag to document constructor-modules in CommonJS.
@@ -336,10 +336,10 @@

Document a Simple CommonJS Module

-

Document Multiple RequireJS Modules Defined in a Single File

- -

If you have multiple calls to define in a single file use the @exports tag to document each function that returns module code. Name the exported objects "exports" and JSDoc 3 will automatically document any of their members as members of their module.

- +

Document Multiple RequireJS Modules Defined in a Single File

+ +

If you have multiple calls to define in a single file use the @exports tag to document each function that returns module code. Name the exported objects "exports" and JSDoc 3 will automatically document any of their members as members of their module.

+
The getStyleProperty and isInHead methods are documented as members of the "html/utils" module. The Tag class is documented as a member of the "tag" module.
@@ -378,11 +378,11 @@

Document a Simple CommonJS Module

-

See Also

- -
@@ -395,3 +395,4 @@

Document a Simple CommonJS Module

+ diff --git a/index.html b/index.html index dbae8157..dfaac1f1 100644 --- a/index.html +++ b/index.html @@ -175,66 +175,66 @@

Index

- - -

Table of Contents

- -
    -
  1. - Getting Started -
    2. - -
  2. - JSDoc Examples -
    3. - -
  3. - Contribute -
    4. - -
  4. - JSDoc 3 Tag Dictionary -
    5. -
- -

Getting Started

-
-
README
-
Basic info on JSDoc 3.
-
An introduction to JSDoc 3
-
A quick-start to documenting JavaScript with JSDoc.
-
Using namepaths with JSDoc 3.
-
A guide to using namepaths with JSDoc 3.
-
Tutorials mechanism
-
Additional longtext tutorials for your code.
-
Adding Content to Index.html
-
Using Readme files to add content to the default index.html
-
All about plugins
-
Installing plugins and writing your own.
-
Configuring the markdown plugin
-
This allows markdown in code comments and offers 2 flavors.
-
Testing JSDoc 3
-
About running the self tests included with JSDoc 3.
-
License
-
The license covering JSDoc 3 code.
-
- -

JSDoc Examples

-
-
CommonJS Modules
-
Documenting code that conforms to the CommonJS server-side modules standard.
-
- -

Contribute

-
-
JSDoc 3 at github
-
Contribute to the JSDoc 3 project.
-
JSDoc 3 Documentation
-
Contribute to the JSDoc 3 Documentation project.
-
- -

JSDoc 3 Tag Dictionary

-
+ + +

Table of Contents

+ +
    +
  1. + Getting Started +
    2. + +
  2. + JSDoc Examples +
    3. + +
  3. + Contribute +
    4. + +
  4. + JSDoc 3 Tag Dictionary +
    5. +
+ +

Getting Started

+
+
README
+
Basic info on JSDoc 3.
+
An introduction to JSDoc 3
+
A quick-start to documenting JavaScript with JSDoc.
+
Using namepaths with JSDoc 3.
+
A guide to using namepaths with JSDoc 3.
+
Tutorials mechanism
+
Additional longtext tutorials for your code.
+
Adding Content to Index.html
+
Using Readme files to add content to the default index.html
+
All about plugins
+
Installing plugins and writing your own.
+
Configuring the markdown plugin
+
This allows markdown in code comments and offers 2 flavors.
+
Testing JSDoc 3
+
About running the self tests included with JSDoc 3.
+
License
+
The license covering JSDoc 3 code.
+
+ +

JSDoc Examples

+
+
CommonJS Modules
+
Documenting code that conforms to the CommonJS server-side modules standard.
+
+ +

Contribute

+
+
JSDoc 3 at github
+
Contribute to the JSDoc 3 project.
+
JSDoc 3 Documentation
+
Contribute to the JSDoc 3 Documentation project.
+
+ +

JSDoc 3 Tag Dictionary

+
@augments
This object adds onto a parent object.
@author
Documents the author of an item.
@borrows
@@ -258,7 +258,8 @@

JSDoc 3 Tag Dictiona
[todo] Remove this from the final output.
@inner
[todo] Document an inner object.
@instance
[todo] Document an instance member.
@kind
-
[todo] What kind of object is this?
@license
+
[todo] What kind of object is this?
@lends
+
Document properties on an object literal as if they belonged to an object with a given name
@license
[todo] Document the software license that applies to this code.
@member
[todo] Document a member.
@memberof
[todo] This object is a member or another object.
@method
@@ -285,12 +286,12 @@

JSDoc 3 Tag Dictiona
Insert a link to an included tutorial file.
@type
[todo] Document the type of an object.
@typedef
[todo] Document a custom type.
@version
-
Documents the version number of an item.

- -

- -Fork me on GitHub -

+
Documents the version number of an item.
+ +

+ +Fork me on GitHub +

@@ -303,3 +304,4 @@

JSDoc 3 Tag Dictiona + diff --git a/plugins-markdown.html b/plugins-markdown.html index 79162b18..2cdffe5d 100644 --- a/plugins-markdown.html +++ b/plugins-markdown.html @@ -310,3 +310,4 @@

Extended tag support

+ diff --git a/tags-augments.html b/tags-augments.html index 66e97c0f..58173e6a 100644 --- a/tags-augments.html +++ b/tags-augments.html @@ -175,34 +175,34 @@

@augments

- - -

Synonyms

- - - -

Syntax

- -@augments <namepath> - -

Overview

- -

- The @augments or @extends tag marks a symbol as augmenting another symbol. -

- -

- While current versions of JavaScript don't allow classes or subclasses in the same way that class-based languages like Java do, many programmers choose to think of their code structure in these terms. For this purpose JSDoc provides the @class and @extends tags. If you wish to express a similar relationship between two symbols, but don't wish to promote the classical analogy, you can use the @contructor and @augments tags instead. -

- -

Examples

- -

- In the example below I wish to document the fact that Ducks are a specialised form of Animal: meaning that Duck instances are like Animal instances which have been augmented with additional properties. -

- + + +

Synonyms

+ + + +

Syntax

+ +@augments <namepath> + +

Overview

+ +

+ The @augments or @extends tag marks a symbol as augmenting another symbol. +

+ +

+ While current versions of JavaScript don't allow classes or subclasses in the same way that class-based languages like Java do, many programmers choose to think of their code structure in these terms. For this purpose JSDoc provides the @class and @extends tags. If you wish to express a similar relationship between two symbols, but don't wish to promote the classical analogy, you can use the @contructor and @augments tags instead. +

+ +

Examples

+ +

+ In the example below I wish to document the fact that Ducks are a specialised form of Animal: meaning that Duck instances are like Animal instances which have been augmented with additional properties. +

+
Documenting a class/subclass type of relationship.
@@ -237,17 +237,17 @@

Examples

-

- A related pattern can be documented with the @mixin and @mixes tags. Or, if the augmented symbol is only reusing one or two members of another symbol, you may find the @borrows tag more convenient. -

- -

See Also

- -
@@ -260,3 +260,4 @@

See Also

+ diff --git a/tags-author.html b/tags-author.html index 97eefe04..3804ccc3 100644 --- a/tags-author.html +++ b/tags-author.html @@ -175,19 +175,19 @@

@author

- - -

Overview

- -

Document the author of an item. The text following the @author tag -will be used to describe the author in the default template. -

- -

Examples

- -

-

- + + +

Overview

+ +

Document the author of an item. The text following the @author tag +will be used to describe the author in the default template. +

+ +

Examples

+ +

+

+
Documenting the author of an item.
@@ -202,17 +202,17 @@

Examples

-

See Also

- - - -
Contributers to these docs
- -
@@ -225,3 +225,4 @@
Contributers to these docs
+ diff --git a/tags-borrows.html b/tags-borrows.html index 2900d47b..0b25c612 100644 --- a/tags-borrows.html +++ b/tags-borrows.html @@ -175,27 +175,27 @@

@borrows

- -

Syntax

- -@borrows <that namepath> as <this namepath> - -

Overview

- -

- The @borrows tag allows you to add documentation for another symbol to your documentation. -

- -

- This tag would be useful if you had more than one way to reference a function, but you didn't want to duplicate the same documentation in two places. -

- -

Examples

- -

- In this example there exists documentation for the "trstr" function, but "util.trim" is just a reference to that same function by a different name. -

- + +

Syntax

+ +@borrows <that namepath> as <this namepath> + +

Overview

+ +

+ The @borrows tag allows you to add documentation for another symbol to your documentation. +

+ +

+ This tag would be useful if you had more than one way to reference a function, but you didn't want to duplicate the same documentation in two places. +

+ +

Examples

+ +

+ In this example there exists documentation for the "trstr" function, but "util.trim" is just a reference to that same function by a different name. +

+
Duplicate the documentation for trstr as util.trim
@@ -229,3 +229,4 @@

Examples

+ diff --git a/tags-callback.html b/tags-callback.html index 43718a3f..89eb8490 100644 --- a/tags-callback.html +++ b/tags-callback.html @@ -175,33 +175,33 @@

@callback

- -

Synonyms

- -
    -
  • @typedef {function} <namepath>
    • -
- -

Syntax

- -@callback <namepath> - -

Overview

- -

- The @callback tag provides information about a callback function that can be passed to other functions, including the callback's parameters and return value. You can include any of the tags that you can provide for a @method. -

- -

- Once you define a callback, you can use it in the same way as a custom type defined with the @typedef tag. In particular, you can use the callback's name as a type name. This allows you to indicate that a function parameter should contain a certain type of callback. -

- -

- If you want a callback to be displayed with the type definitions for a specific class, you can give the callback a namepath indicating that it is an inner function of that class. You can also define a global callback type that is referenced from multiple classes. -

- -

Examples

- + +

Synonyms

+ +
    +
  • @typedef {function} <namepath>
    • +
+ +

Syntax

+ +@callback <namepath> + +

Overview

+ +

+ The @callback tag provides information about a callback function that can be passed to other functions, including the callback's parameters and return value. You can include any of the tags that you can provide for a @method. +

+ +

+ Once you define a callback, you can use it in the same way as a custom type defined with the @typedef tag. In particular, you can use the callback's name as a type name. This allows you to indicate that a function parameter should contain a certain type of callback. +

+ +

+ If you want a callback to be displayed with the type definitions for a specific class, you can give the callback a namepath indicating that it is an inner function of that class. You can also define a global callback type that is referenced from multiple classes. +

+ +

Examples

+
Documenting a class-specific callback
@@ -254,11 +254,11 @@

Examples

-

See Also

- -

See Also

+ +
@@ -271,3 +271,4 @@

Examples

+ diff --git a/tags-classdesc.html b/tags-classdesc.html index 0a1361f2..fd7c9f97 100644 --- a/tags-classdesc.html +++ b/tags-classdesc.html @@ -175,28 +175,28 @@

@classdesc

- -

Syntax

- -@class <SomeClassName>
-@classdesc <some description> - -

Overview

- -

- The @classdesc tag is used to provide a description for a class, separate from the constructor function's description. -

- -

- The functionality of the @classdesc tag in JSDoc 3 duplicates that of the @class in previous versions. As of version 3, the syntax and functionality of the @class tag now exactly matches the @constructor tag, and the @classdesc tag more explicitly communicates its purpose: to document a class's description. -

- -

Examples

- -

- As shown below, a class has places for two descriptions, one applies to the function itself, while the other applies to the class in general. -

- + +

Syntax

+ +@class <SomeClassName>
+@classdesc <some description> + +

Overview

+ +

+ The @classdesc tag is used to provide a description for a class, separate from the constructor function's description. +

+ +

+ The functionality of the @classdesc tag in JSDoc 3 duplicates that of the @class in previous versions. As of version 3, the syntax and functionality of the @class tag now exactly matches the @constructor tag, and the @classdesc tag more explicitly communicates its purpose: to document a class's description. +

+ +

Examples

+ +

+ As shown below, a class has places for two descriptions, one applies to the function itself, while the other applies to the class in general. +

+
A doclet with both a description and a class description
@@ -211,11 +211,11 @@

Examples

-

See Also

- -
@@ -228,3 +228,4 @@

Examples

+ diff --git a/tags-constant.html b/tags-constant.html index 4ee90b0b..0e65fa8c 100644 --- a/tags-constant.html +++ b/tags-constant.html @@ -175,29 +175,29 @@

@constant

- -

Synonyms

- - - -

Syntax

- -@constant [<type> <name>] - -

Overview

- -

- The @constant tag is used to mark the documentation as belonging to a symbol that is a constant. -

- -

Examples

- -

- In this example we are documenting a string constant. Note that although the code is using the const keyword, this is not required by JSDoc. If your JavaScript host environment doesn't yet support constant declarations, the @const documentation can just as effectively be used on var declarations. -

- + +

Synonyms

+ + + +

Syntax

+ +@constant [<type> <name>] + +

Overview

+ +

+ The @constant tag is used to mark the documentation as belonging to a symbol that is a constant. +

+ +

Examples

+ +

+ In this example we are documenting a string constant. Note that although the code is using the const keyword, this is not required by JSDoc. If your JavaScript host environment doesn't yet support constant declarations, the @const documentation can just as effectively be used on var declarations. +

+
A string constant representing the color red
@@ -210,15 +210,15 @@

Examples

-

- Note that the example provides the type in a @type tag. This is optional. Also the optional @default tag is used here too, this will automatically add whatever the assigned value is (for example 'FF0000') to the documentation. -

- -

See Also

- -
@@ -231,3 +231,4 @@

See Also

+ diff --git a/tags-constructor.html b/tags-constructor.html index 30d1ef8f..95eba1de 100644 --- a/tags-constructor.html +++ b/tags-constructor.html @@ -175,25 +175,25 @@

@constructor

- -

Synonyms

- - - -

Syntax

- -@constructor [<type> <name>] - -

Overview

- -

- The @constructor tag marks an function as being a constructor, meant to be called with the new keyword to return an instance. -

- -

Examples

- + +

Synonyms

+ + + +

Syntax

+ +@constructor [<type> <name>] + +

Overview

+ +

+ The @constructor tag marks an function as being a constructor, meant to be called with the new keyword to return an instance. +

+ +

Examples

+
A function that constructs Person instances.
@@ -209,10 +209,10 @@

Examples

-

See Also

- -
@@ -225,3 +225,4 @@

Examples

+ diff --git a/tags-constructs.html b/tags-constructs.html index 4a8f1310..ac74013d 100644 --- a/tags-constructs.html +++ b/tags-constructs.html @@ -175,19 +175,19 @@

@constructs

- -

Overview

- -

-When using an object literal to define a class (for example with the @lends tag) the @constructs tag allows you to document that a particular function will be used to construct instances of that class. -

- -

Syntax

- -@constructs [<name>] - -

Examples

- + +

Overview

+ +

+When using an object literal to define a class (for example with the @lends tag) the @constructs tag allows you to document that a particular function will be used to construct instances of that class. +

+ +

Syntax

+ +@constructs [<name>] + +

Examples

+
Using the @constructs tag with @lends
@@ -227,10 +227,10 @@

Examples

-

See Also

- -
@@ -243,3 +243,4 @@

Examples

+ diff --git a/tags-copyright.html b/tags-copyright.html index 49122892..c71c1f1f 100644 --- a/tags-copyright.html +++ b/tags-copyright.html @@ -175,22 +175,22 @@

@copyright

- -

Syntax

- -@overview
@copyright <some copyright text> - -

Overview

- -

-The @copyright tag is used to document copyright information in a file overview comment. -

- -

Examples

- -

-

- + +

Syntax

+ +@overview
@copyright <some copyright text> + +

Overview

+ +

+The @copyright tag is used to document copyright information in a file overview comment. +

+ +

Examples

+ +

+

+
Example goes here
@@ -202,10 +202,10 @@

Examples

-

See Also

- -
@@ -218,3 +218,4 @@

Examples

+ diff --git a/tags-default.html b/tags-default.html index 1fdd45de..5d1345b1 100644 --- a/tags-default.html +++ b/tags-default.html @@ -175,23 +175,23 @@

@default

- -

Syntax

- -@default [<some value>] - -

Overview

- -

-The @default tag allows you to document the assigned value of a symbol. You can supply this tag with a value yourself or you can allow JSDoc to automatically document the value from the source code -- only possible when the documented symbol is being assigned a single, simple value that is either: a string, a number, a boolean or null. -

- -

Examples

- -

-In this example a constant is documented. The value of the constant is 0xff0000. By adding the @default tag this value is automatically added to the documentation. -

- + +

Syntax

+ +@default [<some value>] + +

Overview

+ +

+The @default tag allows you to document the assigned value of a symbol. You can supply this tag with a value yourself or you can allow JSDoc to automatically document the value from the source code -- only possible when the documented symbol is being assigned a single, simple value that is either: a string, a number, a boolean or null. +

+ +

Examples

+ +

+In this example a constant is documented. The value of the constant is 0xff0000. By adding the @default tag this value is automatically added to the documentation. +

+
Document the number value of a constant
@@ -216,3 +216,4 @@

Examples

+ diff --git a/tags-deprecated.html b/tags-deprecated.html index 4b4d7fa8..adb68787 100644 --- a/tags-deprecated.html +++ b/tags-deprecated.html @@ -175,23 +175,23 @@

@deprecated

- -

Syntax

- -@deprecated [<some text>] - -

Overview

- -

-The @deprecated tag marks a symbol in your code as being deprecated. -

- -

Examples

- -

-You can use the @deprecated tag by itself, or include some text that describes more about the deprecation. -

- + +

Syntax

+ +@deprecated [<some text>] + +

Overview

+ +

+The @deprecated tag marks a symbol in your code as being deprecated. +

+ +

Examples

+ +

+You can use the @deprecated tag by itself, or include some text that describes more about the deprecation. +

+
Document that the old function has been deprecated since version 2.0
@@ -216,3 +216,4 @@

Examples

+ diff --git a/tags-description.html b/tags-description.html index 26988518..251d18af 100644 --- a/tags-description.html +++ b/tags-description.html @@ -175,23 +175,23 @@

@desc

- -

Syntax

- -@desc <some description> - -

Overview

- -

-The @desc tag allows you to provide a general description of the symbol you are documenting. The text can be in the form of HTML or, if you have enabled the markdown plugin, it can be formatted as one of the various flavors or MarkDown. -

- -

Examples

- -

-The @desc (or it's synonym @description) is the default tag in JSDoc, so if no other tag is in effect you can just start writing your description text. -

- + +

Syntax

+ +@desc <some description> + +

Overview

+ +

+The @desc tag allows you to provide a general description of the symbol you are documenting. The text can be in the form of HTML or, if you have enabled the markdown plugin, it can be formatted as one of the various flavors or MarkDown. +

+ +

Examples

+ +

+The @desc (or it's synonym @description) is the default tag in JSDoc, so if no other tag is in effect you can just start writing your description text. +

+
A tagless description is allowed if no other tag is in effect
@@ -208,10 +208,10 @@

Examples

-

-If any other tag has previously been used in a given doc comment, then you must use a @desc tag if you wish to provide a description. -

- +

+If any other tag has previously been used in a given doc comment, then you must use a @desc tag if you wish to provide a description. +

+
A @desc tag is necessary if any other tag is in effect
@@ -228,10 +228,10 @@

Examples

-

See Also

- -

See Also

+ +
@@ -244,3 +244,4 @@

Examples

+ diff --git a/tags-enum.html b/tags-enum.html index 34977347..e8c40682 100644 --- a/tags-enum.html +++ b/tags-enum.html @@ -175,27 +175,27 @@

@enum

- -

Syntax

- -@enum [<type>] - -

Overview

- -

- The @enum tag documents a collection of static properties whose values are all of the same type. -

- -

- An enum is similar a collection of properties, except that an enum is documented in its own doc comment, whereas properties are documented within the doc comment of their container. Often this tag is used with @readonly, as an enum typically represents a collection of constants. -

- -

Examples

- -

- This shows how to document an object that represents a value with three possible states. Note that the enum members can have optional descriptions added if you wish. Also you can override the type, as is shown with "MAYBE" -- by default enum members will be documented with the same type as the enum itself. -

- + +

Syntax

+ +@enum [<type>] + +

Overview

+ +

+ The @enum tag documents a collection of static properties whose values are all of the same type. +

+ +

+ An enum is similar a collection of properties, except that an enum is documented in its own doc comment, whereas properties are documented within the doc comment of their container. Often this tag is used with @readonly, as an enum typically represents a collection of constants. +

+ +

Examples

+ +

+ This shows how to document an object that represents a value with three possible states. Note that the enum members can have optional descriptions added if you wish. Also you can override the type, as is shown with "MAYBE" -- by default enum members will be documented with the same type as the enum itself. +

+
A numeric enum, representing three states
@@ -215,10 +215,10 @@

Examples

-

See Also

- -
@@ -231,3 +231,4 @@

Examples

+ diff --git a/tags-event.html b/tags-event.html index 250ab741..a455e690 100644 --- a/tags-event.html +++ b/tags-event.html @@ -175,42 +175,42 @@

@event

- -

Syntax

- -@event <className>#[event:]<eventName> - -

Overview

- -

- The @event tag allows you to document an event that can be fired. A typical event is represented - by an object with a defined set of properties. -

- -

- Once you have used the @event tag to define a specific type of event, you can use the @fires tag - to indicate that a method can fire that event. -

- -

- JSDoc automatically prepends the namespace event: to each event's name. In general, - you must include this namespace when you link to the event in another doclet. (The @fires tag is - a notable exception; it allows you to omit the namespace.) -

- -

- Note: JSDoc 3 uses @event doclets to document the content of an event. In - contrast, JSDoc Toolkit 2 used @event doclets to identify a function that can be fired when an - event of the same name occurs. -

- -

Examples

- -

- The following examples show how to document an event in the Hurl class called - snowball. The event contains an object with a single property. -

- + +

Syntax

+ +@event <className>#[event:]<eventName> + +

Overview

+ +

+ The @event tag allows you to document an event that can be fired. A typical event is represented + by an object with a defined set of properties. +

+ +

+ Once you have used the @event tag to define a specific type of event, you can use the @fires tag + to indicate that a method can fire that event. +

+ +

+ JSDoc automatically prepends the namespace event: to each event's name. In general, + you must include this namespace when you link to the event in another doclet. (The @fires tag is + a notable exception; it allows you to omit the namespace.) +

+ +

+ Note: JSDoc 3 uses @event doclets to document the content of an event. In + contrast, JSDoc Toolkit 2 used @event doclets to identify a function that can be fired when an + event of the same name occurs. +

+ +

Examples

+ +

+ The following examples show how to document an event in the Hurl class called + snowball. The event contains an object with a single property. +

+
Documenting a function call as an event
@@ -258,10 +258,10 @@

Examples

-

See Also

- -
@@ -274,3 +274,4 @@

Examples

+ diff --git a/tags-example.html b/tags-example.html index 4b6b1957..4a3025df 100644 --- a/tags-example.html +++ b/tags-example.html @@ -175,17 +175,17 @@

@example

- -

Overview

- -

Provide an example of how to use a documented item. The text that follows this tag may span multiple lines, it will be displayed as highlighted code. The leading stars in the comment do not have to be present for this to work. -

- -

Examples

- -

-

- + +

Overview

+ +

Provide an example of how to use a documented item. The text that follows this tag may span multiple lines, it will be displayed as highlighted code. The leading stars in the comment do not have to be present for this to work. +

+ +

Examples

+ +

+

+
Documenting examples.
@@ -220,10 +220,10 @@

Examples

-

See Also

- -
@@ -236,3 +236,4 @@

Examples

+ diff --git a/tags-exports.html b/tags-exports.html index 6373cedc..050f07b0 100644 --- a/tags-exports.html +++ b/tags-exports.html @@ -175,19 +175,19 @@

@exports

- -

Overview

- -

-Use the @exports tag when documenting JavaScript modules to indicate that an object is being exported. -

- -

Examples

- -

-In cases where you are using the special "exports" namespace, the @exports tag is never needed... -

- + +

Overview

+ +

+Use the @exports tag when documenting JavaScript modules to indicate that an object is being exported. +

+ +

Examples

+ +

+In cases where you are using the special "exports" namespace, the @exports tag is never needed... +

+
In CommonJS modules the exports namespace is understood by JSDoc 3
@@ -254,10 +254,10 @@

Examples

-

-If you are exporting an object named anything other than "exports", use the @exports tag to indicate what is being exported. -

- +

+If you are exporting an object named anything other than "exports", use the @exports tag to indicate what is being exported. +

+
The @exports tag is used to document that the "ns" namespace is being exported
@@ -280,11 +280,11 @@

Examples

-

See Also

- -
@@ -297,3 +297,4 @@

Examples

+ diff --git a/tags-file.html b/tags-file.html index 79b80ce0..1501944d 100644 --- a/tags-file.html +++ b/tags-file.html @@ -175,19 +175,19 @@

@file

- -

Overview

- -

Gives a description of the file. Place the comment at the top of the file. -The text following the @file tag will be used as the description of the file -in the default template. -

- -

Examples

- -

-

- + +

Overview

+ +

Gives a description of the file. Place the comment at the top of the file. +The text following the @file tag will be used as the description of the file +in the default template. +

+ +

Examples

+ +

+

+
Giving an overview of a file
@@ -200,17 +200,17 @@

Examples

-

See Also

- -Contributers to these docs - -
@@ -223,3 +223,4 @@
Contributers to these docs
+ diff --git a/tags-fires.html b/tags-fires.html index 891d9e2f..37e8ee7a 100644 --- a/tags-fires.html +++ b/tags-fires.html @@ -175,20 +175,20 @@

@fires

- -

Syntax

- -@fires <className>#[event:]<eventName> - -

Overview

- -

- The @fires tag indicates that a method can fire a specified type of event when it is called. Use - the @event tag to document the event's content. -

- -

Examples

- + +

Syntax

+ +@fires <className>#[event:]<eventName> + +

Overview

+ +

+ The @fires tag indicates that a method can fire a specified type of event when it is called. Use + the @event tag to document the event's content. +

+ +

Examples

+
Method that fires a 'drain' event
@@ -204,10 +204,10 @@

Examples

-

See Also

- -
@@ -220,3 +220,4 @@

Examples

+ diff --git a/tags-global.html b/tags-global.html index ba865957..109c9b84 100644 --- a/tags-global.html +++ b/tags-global.html @@ -175,19 +175,19 @@

@global

- -

Overview

- -

-In cases where the static analysis feature of JSDoc is not able to derive the scope that you intend purely from the code surrounding your doc comments, you can use the @global tag to explicitly specify that a symbol should appear in the documentation as a global symbol. -

- -

Examples

- -

-Use the @global tag to specify that a symbol should be documented as global. -

- + +

Overview

+ +

+In cases where the static analysis feature of JSDoc is not able to derive the scope that you intend purely from the code surrounding your doc comments, you can use the @global tag to explicitly specify that a symbol should appear in the documentation as a global symbol. +

+ +

Examples

+ +

+Use the @global tag to specify that a symbol should be documented as global. +

+
Document an inner variable as a global
@@ -213,3 +213,4 @@

Examples

+ diff --git a/tags-ignore.html b/tags-ignore.html index 8a613b3a..aaa37d9c 100644 --- a/tags-ignore.html +++ b/tags-ignore.html @@ -175,17 +175,17 @@

@ignore

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -

See Also

+ +
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-inner.html b/tags-inner.html index ef92cc3a..a01b6dc6 100644 --- a/tags-inner.html +++ b/tags-inner.html @@ -175,17 +175,17 @@

@inner

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-instance.html b/tags-instance.html index 15de5667..675825d7 100644 --- a/tags-instance.html +++ b/tags-instance.html @@ -175,17 +175,17 @@

@instance

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-kind.html b/tags-kind.html index 0fa238f5..0962c2a9 100644 --- a/tags-kind.html +++ b/tags-kind.html @@ -175,17 +175,17 @@

@kind

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-lends.html b/tags-lends.html new file mode 100644 index 00000000..1a6e74c6 --- /dev/null +++ b/tags-lends.html @@ -0,0 +1,312 @@ + + + + + Use JSDoc: @lends + + + + + + + + + + +
+ @use JSDoc +
+ + + +
+

@lends

+ +

Syntax

+ +@lends <namepath> + +

Overview

+ +

+ The @lends tag allows you to document all the members of an anonymous object literal as if they + were members of an object with the given name. You might want to do this if you were passing an anonymous + object literal into a function that creates a named class from its members +

+ +

Examples

+ +

+ In this example we want to use a helper function to make a class named "Person," along with instance + methods named "initialize" and "say." This is similar to how some popular frameworks handle class creation. +

+ +
+
Example class
+
+
+// we want to document this as being a class
+var Person = makeClass(
+    // we want to document these as being methods
+    {
+        initialize: function(name) {
+            this.name = name;
+        },
+        say: function(message) {
+            return this.name + " says: " + message;
+        }
+    }
+);
+
+
+
+

+ Without any doc comments JSDoc won't automatically recognize either a class named "Person" nor it's + two methods. To document the methods we must use a "@lends" tag in a doc comment immediately before the + object literal to tell JSDoc that all the member names of that object literal are being "lent" to a + variable named "Person." +

+ +
+
Documented as static methods
+
+
+/** @class */
+var Person = makeClass(
+    /** @lends Person */
+    {
+        initialize: function(name) {
+            this.name = name;
+        },
+        say: function(message) {
+            return this.name + " says: " + message;
+        }
+    }
+);
+
+
+
+

+ Now the functions named "initialize" and "say" will be documented, but they appear as static methods of an + class named "Person." That is possibly what you meant, but in this case we want "initialize" and "say" to + belong to the instances of the "Person" class. So we change things slightly by lending the methods to the + class's prototype: +

+ +
+
Documented as instance methods
+
+
+/** @class */
+var Person = makeClass(
+    /** @lends Person.prototype */
+    {
+        initialize: function(name) {
+            this.name = name;
+        },
+        say: function(message) {
+            return this.name + " says: " + message;
+        }
+    }
+);
+
+
+
+

+ If you are using one of the lent functions to construct the class, you can mark it as such using the + @constructs tag, but remember to remove the @class tag in that case, or else two @classes will be documented. +

+ +
+
Documented constructor
+
+
+var Person = makeClass(
+    /**
+      @lends Person.prototype
+    */
+    {
+        /** @constructs */
+        initialize: function(name) {
+            this.name = name;
+        },
+        say: function(message) {
+            return this.name + " says: " + message;
+        }
+    }
+);
+
+
+
+

See Also

+ + +
+ + + + + + + diff --git a/tags-license.html b/tags-license.html index 1c134b8d..a29b298c 100644 --- a/tags-license.html +++ b/tags-license.html @@ -175,17 +175,17 @@

@license

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-member.html b/tags-member.html index 246b76ab..ceae8349 100644 --- a/tags-member.html +++ b/tags-member.html @@ -175,17 +175,17 @@

@member

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-memberof.html b/tags-memberof.html index 4b1a7ee4..f4a5907e 100644 --- a/tags-memberof.html +++ b/tags-memberof.html @@ -175,17 +175,17 @@

@memberof

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-method.html b/tags-method.html index 6e5bf064..5a5f9881 100644 --- a/tags-method.html +++ b/tags-method.html @@ -175,17 +175,17 @@

@method

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-mixes.html b/tags-mixes.html index 85ad8480..27f3aa70 100644 --- a/tags-mixes.html +++ b/tags-mixes.html @@ -175,17 +175,17 @@

@mixes

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-mixin.html b/tags-mixin.html index 005723b7..4720723b 100644 --- a/tags-mixin.html +++ b/tags-mixin.html @@ -175,17 +175,17 @@

@mixin

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-module.html b/tags-module.html index 896d4bc6..b23ab002 100644 --- a/tags-module.html +++ b/tags-module.html @@ -175,17 +175,17 @@

@module

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-name.html b/tags-name.html index a1c10500..243dc36a 100644 --- a/tags-name.html +++ b/tags-name.html @@ -175,17 +175,17 @@

@name

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-namespace.html b/tags-namespace.html index 2724b334..c68e139f 100644 --- a/tags-namespace.html +++ b/tags-namespace.html @@ -175,17 +175,17 @@

@namespace

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-param.html b/tags-param.html index c43adf01..08a294c6 100644 --- a/tags-param.html +++ b/tags-param.html @@ -175,27 +175,27 @@

@param

- - -

Synonyms

- - - -

Overview

- -

-The @param tag (or @arg or @argument) documents a parameter of a function. -

- -

Examples

- -

-The following examples show the basic usage of @param. -

- + + +

Synonyms

+ + + +

Overview

+ +

+The @param tag (or @arg or @argument) documents a parameter of a function. +

+ +

Examples

+ +

+The following examples show the basic usage of @param. +

+
Basic usage of @param
@@ -235,10 +235,10 @@

Examples

-

-The following examples show how to indicate that a parameter can be optional and has a default value -

- +

+The following examples show how to indicate that a parameter can be optional and has a default value +

+
An optional parameter
@@ -271,10 +271,10 @@

Examples

-

-A parameter could also have several types instead of just one. It can also be used multiple times. The following examples reflect these situations. -

- +

+A parameter could also have several types instead of just one. It can also be used multiple times. The following examples reflect these situations. +

+
Multiple types
@@ -311,17 +311,17 @@

Examples

-

See Also

- - - -
Contributers to these docs
- - +

See Also

+ + + +
Contributers to these docs
+ +
@@ -334,3 +334,4 @@
Contributers to these docs
+ diff --git a/tags-private.html b/tags-private.html index 5e4604ac..ff6c6451 100644 --- a/tags-private.html +++ b/tags-private.html @@ -175,17 +175,17 @@

@private

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-property.html b/tags-property.html index a9424d63..1b720c12 100644 --- a/tags-property.html +++ b/tags-property.html @@ -175,27 +175,27 @@

@property

- -

Overview

- -

- The @property tag is a way to easily document a list of static properties of a class, namespace or other object. -

- -

- Normally JSDoc templates would create an entire new page to display information about each level of a nested namespace hierarchy. Sometimes what you really want is to just list all the properties, including nested properties, all together on the same page. -

- -

- Note that property tags must be used in doc comments for the thing that they are properties of, a namespace or a class for example. This tag is intended for simple collections of static properties, it does not allow you to provide @examples or similar complex information for each property, just the type, name and description. -

- -

Examples

- -

- In this example we have a namespace named "config." We want all the information about the defaults property, including it's nested values to appear on the same page with the documentation for config. -

- + +

Overview

+ +

+ The @property tag is a way to easily document a list of static properties of a class, namespace or other object. +

+ +

+ Normally JSDoc templates would create an entire new page to display information about each level of a nested namespace hierarchy. Sometimes what you really want is to just list all the properties, including nested properties, all together on the same page. +

+ +

+ Note that property tags must be used in doc comments for the thing that they are properties of, a namespace or a class for example. This tag is intended for simple collections of static properties, it does not allow you to provide @examples or similar complex information for each property, just the type, name and description. +

+ +

Examples

+ +

+ In this example we have a namespace named "config." We want all the information about the defaults property, including it's nested values to appear on the same page with the documentation for config. +

+
A namespace with defaults and nested default properties
@@ -220,11 +220,11 @@

Examples

-

See Also

- -
@@ -237,3 +237,4 @@

Examples

+ diff --git a/tags-protected.html b/tags-protected.html index a787895f..ce1f7d16 100644 --- a/tags-protected.html +++ b/tags-protected.html @@ -175,17 +175,17 @@

@protected

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-public.html b/tags-public.html index 35f2d569..27ed31eb 100644 --- a/tags-public.html +++ b/tags-public.html @@ -175,17 +175,17 @@

@public

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-readonly.html b/tags-readonly.html index b6d37114..2844cdbe 100644 --- a/tags-readonly.html +++ b/tags-readonly.html @@ -175,17 +175,17 @@

@readonly

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-requires.html b/tags-requires.html index 09c74a32..4e4671cb 100644 --- a/tags-requires.html +++ b/tags-requires.html @@ -175,17 +175,17 @@

@requires

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-returns.html b/tags-returns.html index b7fed471..e54f2cf5 100644 --- a/tags-returns.html +++ b/tags-returns.html @@ -175,15 +175,15 @@

@returns

- -

Overview

- -

-The @returns tag documents the value that a function returns. -

- -

Examples

- + +

Overview

+ +

+The @returns tag documents the value that a function returns. +

+ +

Examples

+
Type of the return value
@@ -236,16 +236,16 @@

Examples

-

See Also

- - - -
Contributers to these docs
- -
@@ -258,3 +258,4 @@
Contributers to these docs
+ diff --git a/tags-see.html b/tags-see.html index caf3ab3b..d4cc8a89 100644 --- a/tags-see.html +++ b/tags-see.html @@ -175,17 +175,17 @@

@see

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-since.html b/tags-since.html index 5cb709c6..1fd44325 100644 --- a/tags-since.html +++ b/tags-since.html @@ -175,17 +175,17 @@

@since

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-summary.html b/tags-summary.html index 966fe6d3..c7fb7cfb 100644 --- a/tags-summary.html +++ b/tags-summary.html @@ -175,17 +175,17 @@

@summary

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-this.html b/tags-this.html index ae523b33..4bcf1e07 100644 --- a/tags-this.html +++ b/tags-this.html @@ -175,17 +175,17 @@

@this

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-throws.html b/tags-throws.html index 4e71af82..ea477420 100644 --- a/tags-throws.html +++ b/tags-throws.html @@ -175,17 +175,17 @@

@throws

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-todo.html b/tags-todo.html index 41399580..2ccda813 100644 --- a/tags-todo.html +++ b/tags-todo.html @@ -175,17 +175,17 @@

@todo

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-tutorial.html b/tags-tutorial.html index f2b8f8c5..d2df2cb6 100644 --- a/tags-tutorial.html +++ b/tags-tutorial.html @@ -175,17 +175,17 @@

@tutorial

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-type.html b/tags-type.html index 27e65c06..d693a27f 100644 --- a/tags-type.html +++ b/tags-type.html @@ -175,17 +175,17 @@

@type

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-typedef.html b/tags-typedef.html index 38124c74..473da586 100644 --- a/tags-typedef.html +++ b/tags-typedef.html @@ -175,17 +175,17 @@

@typedef

- -

Overview

- -

-

- -

Examples

- -

-

- + +

Overview

+ +

+

+ +

Examples

+ +

+

+
Example goes here
@@ -194,10 +194,10 @@

Examples

-

See Also

- -
@@ -210,3 +210,4 @@

Examples

+ diff --git a/tags-version.html b/tags-version.html index eefba2ad..32b6ad67 100644 --- a/tags-version.html +++ b/tags-version.html @@ -175,18 +175,18 @@

@version

- -

Overview

- -

Documents the version of an item. The text following the @version tag -will be used to denote the version of the item. -

- -

Examples

- -

-

- + +

Overview

+ +

Documents the version of an item. The text following the @version tag +will be used to denote the version of the item. +

+ +

Examples

+ +

+

+
Documenting an item's version.
@@ -203,17 +203,17 @@

Examples

-

See Also

- - - -
Contributers to these docs
- -
@@ -226,3 +226,4 @@
Contributers to these docs
+