@return
documentjs.tags.return
Describes a function's return value.
@return {TYPE} DESCRIPTION
/**
* Capitalizes a string
* @param {String} s the string to be lowercased.
* @return {String} a string with the first character capitalized,
* and everything else lowercased
*/
capitalize: function( s ) { ... }
Parameters
-
TYPE
{TYPE-EXPRESSION}
OptionalThe type of return value.
-
DESCRIPTION
{String}
OptionalThe description of the return value.