/wiki/TagFunction.wiki
http://jsdoc-toolkit.googlecode.com/ · Unknown · 26 lines · 17 code · 9 blank · 0 comment · 0 complexity · 1ff3ac233b00e46da89eaa0e5080d161 MD5 · raw file
- #summary @function
- == The @function Tag ==
- The `@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.
- === Syntax ===
- {{{
- @function
- }}}
- === Example ===
- {{{
- /**
- * @function
- */
- var paginate = paginateFactory(pages);
- }}}
- Without 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.
- === See Also ===
- * The [TagField @field] tag.