PageRenderTime 20ms CodeModel.GetById 18ms app.highlight 0ms RepoModel.GetById 1ms app.codeStats 1ms

/wiki/TagDefault.wiki

http://jsdoc-toolkit.googlecode.com/
Unknown | 31 lines | 21 code | 10 blank | 0 comment | 0 complexity | df182888c311d8170f130ce693f8d415 MD5 | raw file
 1#summary @default
 2
 3== The @default Tag ==
 4
 5The `@default` tag allows you to document the default value of an object, including fields of classes.
 6
 7=== Syntax ===
 8
 9{{{
10@default valueDescription
11}}}
12
13  * valueDescription - Required: a description of the default value.
14
15=== Example ===
16
17{{{
18/** @constructor */
19function Page(title) {
20    /**
21     * @default "Undefined"
22     */
23     this.title = title || "Undefined";
24}
25}}}
26
27The `@default` tag is only recognized when applied to objects, it is not meaningful to use it with functions.
28
29=== See Also ===
30
31  * The [TagType @type] tag can be used to document the type of an object's value, or the type of a value returned by a function. Contrast this with `@default` which documents what the actual default value is.