/wiki/TagReturns.wiki

http://jsdoc-toolkit.googlecode.com/ · Unknown · 23 lines · 17 code · 6 blank · 0 comment · 0 complexity · 814f18741cb1736c67a3dd031f0a5b4f MD5 · raw file

  1. #summary @returns
  2. == The @returns Tag ==
  3. The `@returns` tag documents the value returned by a function or method.
  4. === Syntax ===
  5. {{{
  6. @returns {returnType} returnDescription
  7. }}}
  8. * returnType - Optional: the type of the return value.
  9. * returnDescription - Optional: any additional description.
  10. === Example ===
  11. {{{
  12. /**
  13. * @returns {Array} Lines from the file.
  14. */
  15. function readLines(filepath) {
  16. }
  17. }}}