/wiki/TagReturns.wiki

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