Skip to content
On this page

@summary ​

A shorter version of the full description.

Syntax ​

@summary Summary goes here.

Overview ​

The @summary tag is a shorter version of the full description. It can be added to any doclet.

Examples ​

js
/**
 * A very long, verbose, wordy, long-winded, tedious, verbacious, tautological,
 * profuse, expansive, enthusiastic, redundant, flowery, eloquent, articulate,
 * loquacious, garrulous, chatty, extended, babbling description.
 * @summary A concise summary.
 */
function bloviate() {}