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

/wiki/TagFunction.wiki

http://jsdoc-toolkit.googlecode.com/
Unknown | 26 lines | 17 code | 9 blank | 0 comment | 0 complexity | 1ff3ac233b00e46da89eaa0e5080d161 MD5 | raw file
 1#summary @function
 2
 3== The @function Tag ==
 4
 5The `@function` tag allows you to force !JsDoc Toolkit to document an object as if it were a function, even though it may not appear to be one to the parser.
 6
 7=== Syntax ===
 8
 9{{{
10@function
11}}}
12
13=== Example ===
14
15{{{
16/**
17 * @function
18 */
19var paginate = paginateFactory(pages);
20}}}
21
22Without the `@function` tag, the `paginate` object would be documented as generic object, because it isn't possible to tell from examining the line of code what type of value `paginate` will hold when it is run.
23
24=== See Also ===
25
26  * The [TagField @field] tag.