/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. == The @field Tag ==
  3. The `@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.
  4. === Syntax ===
  5. {{{
  6. @field
  7. }}}
  8. === Example ===
  9. {{{
  10. /**
  11. * @field
  12. */
  13. var pages = function(){
  14. }
  15. }}}
  16. Without the `@field` tag, the `pages` object would be documented as function.
  17. === See Also ===
  18. * The [TagFunction @function] tag.