/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. == The @function Tag ==
  3. 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.
  4. === Syntax ===
  5. {{{
  6. @function
  7. }}}
  8. === Example ===
  9. {{{
  10. /**
  11. * @function
  12. */
  13. var paginate = paginateFactory(pages);
  14. }}}
  15. 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.
  16. === See Also ===
  17. * The [TagField @field] tag.