@returns

Tag Kind: Block
TSDoc Reference: @returns

The @returns tag can be used to document the return value of a function. At most one @returns tag should be present in a comment.

TypeDoc treats the @return tag as an alias for @returns.

Example

/**
 * @param a - the first number
 * @param b - the second number
 * @returns The sum of `a` and `b`
 */
export function sum(a: number, b: number): number;
Copy

See Also

• The @param tag