Documents a function's return value.
Example
/**
* Gets the clip rectangle of the specified element.
* @param {HTMLElement} element The element whose clip rectangle to get.
* @returns {ClipRect} The clip rectangle of this animation's element.
*/
Aeon.AnimationPackage.Clip.prototype.getClip = function Clip$getClip(element) Description
This token documents a function's return value. It consists of three parts:
@returns {type} summary
description- The type of the return value (surrounded with curly braces). Required.
(Alphanumeric characters including '.' and '$' until a space character) - The summary of the return value. Optional.
(Any characters until the end of the line) - The description of the return value. Optional.
(Any characters from the start of the second line until the next token or until the end of the comment).
See also
All tokens
@param
@arguments
@type