@return module

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

  1. TYPE {TYPE-EXPRESSION}:

    The type of return value.

  2. DESCRIPTION {String}:

    The description of the return value.