PageRenderTime 8ms CodeModel.GetById 2ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 0ms

/wiki/TagNamespace.wiki

http://jsdoc-toolkit.googlecode.com/
Unknown | 28 lines | 20 code | 8 blank | 0 comment | 0 complexity | 75125316cff26ff54c957f36a1d451d4 MD5 | raw file
 1#summary @namespace
 2
 3== The @namespace Tag ==
 4
 5The namespace tag allows you to document an object that is being used as a "namespace" to keep a collection of properties and methods under a single global name.
 6
 7=== Syntax ===
 8{{{
 9@namespace description
10}}}
11
12  * description - Optional: a description of this namespace.
13
14=== Example ===
15
16_In this example the `load` function will appear as a member of `Extensions.PluginManager`._
17{{{
18/**
19    @namespace Holds functionality related to running plugins.
20*/
21Extensions.PluginManager = {
22}
23
24Extensions.PluginManager.load(plugin) {
25}
26}}}
27
28In documentation a namespace should be treated like a static "class" -- it has no constructor -- similar to the built-in `Math` object in !JavaScript. Namespaces should be listed among any other classes, but should not show any constructor in its documentation.