PageRenderTime 29ms CodeModel.GetById 24ms app.highlight 1ms RepoModel.GetById 1ms app.codeStats 1ms

/wiki/TagStatic.wiki

http://jsdoc-toolkit.googlecode.com/
Unknown | 29 lines | 20 code | 9 blank | 0 comment | 0 complexity | b3910f97c52e0100bdaa92877b8f6004 MD5 | raw file
 1#summary @static
 2
 3== The @static Tag ==
 4
 5The `@static` tag indicate that accessing the documented variable does not require instantiation of its parent or containing object.
 6
 7=== Syntax ===
 8
 9{{{
10@static
11}}}
12
13=== Example ===
14
15{{{
16Hello = {}
17
18/**
19 * @static
20 */
21Hello.World = function() {
22    alert("Hello world");
23}
24}}}
25
26In this case you are documenting that the `World` function is a static method of the `Hello` object. In most cases the !JsDoc Toolkit parser can determine that fact on its own, but this tag may rarely be required when it can't.
27
28=== See Also ===
29  * The [TagNamespace @namespace] tag is used to document that a variable is meant to be used like a "namespace" with static properties.