PageRenderTime 7ms CodeModel.GetById 2ms app.highlight 1ms RepoModel.GetById 1ms app.codeStats 1ms

/wiki/TagField.wiki

http://jsdoc-toolkit.googlecode.com/
Unknown | 28 lines | 18 code | 10 blank | 0 comment | 0 complexity | 7796daab884225d164bfdc5ab1e28b2c MD5 | raw file
 1#summary @field
 2
 3== The @field Tag ==
 4
 5The `@field` tag allows you to force !JsDoc Toolkit to document an object as if it were a non-function, even though it may not appear to be one to the parser.
 6
 7=== Syntax ===
 8
 9{{{
10@field
11}}}
12
13=== Example ===
14
15{{{
16/**
17 * @field
18 */
19var pages = function(){
20}
21}}}
22
23Without the `@field` tag, the `pages` object would be documented as function.
24
25=== See Also ===
26
27  * The [TagFunction @function] tag.
28