/wiki/TagReturns.wiki
http://jsdoc-toolkit.googlecode.com/ · Unknown · 23 lines · 17 code · 6 blank · 0 comment · 0 complexity · 814f18741cb1736c67a3dd031f0a5b4f MD5 · raw file
- #summary @returns
- == The @returns Tag ==
- The `@returns` tag documents the value returned by a function or method.
- === Syntax ===
- {{{
- @returns {returnType} returnDescription
- }}}
- * returnType - Optional: the type of the return value.
- * returnDescription - Optional: any additional description.
- === Example ===
- {{{
- /**
- * @returns {Array} Lines from the file.
- */
- function readLines(filepath) {
- }
- }}}