/wiki/TagDefault.wiki
Unknown | 31 lines | 21 code | 10 blank | 0 comment | 0 complexity | df182888c311d8170f130ce693f8d415 MD5 | raw file
- #summary @default
- == The @default Tag ==
- The `@default` tag allows you to document the default value of an object, including fields of classes.
- === Syntax ===
- {{{
- @default valueDescription
- }}}
- * valueDescription - Required: a description of the default value.
- === Example ===
- {{{
- /** @constructor */
- function Page(title) {
- /**
- * @default "Undefined"
- */
- this.title = title || "Undefined";
- }
- }}}
- The `@default` tag is only recognized when applied to objects, it is not meaningful to use it with functions.
- === See Also ===
- * 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.