/wiki/TagStatic.wiki
http://jsdoc-toolkit.googlecode.com/ · Unknown · 29 lines · 20 code · 9 blank · 0 comment · 0 complexity · b3910f97c52e0100bdaa92877b8f6004 MD5 · raw file
- #summary @static
- == The @static Tag ==
- The `@static` tag indicate that accessing the documented variable does not require instantiation of its parent or containing object.
- === Syntax ===
- {{{
- @static
- }}}
- === Example ===
- {{{
- Hello = {}
- /**
- * @static
- */
- Hello.World = function() {
- alert("Hello world");
- }
- }}}
- In 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.
- === See Also ===
- * The [TagNamespace @namespace] tag is used to document that a variable is meant to be used like a "namespace" with static properties.