@variation

Syntax

@variation number

Overview

@variation differentiates between multiple symbols that share the same name and parent. JSDoc appends the variation number to the namepath: ClassName(1), ClassName(2), etc.

Example

/**
 * @class
 */
function Widget() {}

/**
 * @class
 * @variation 2
 */
function Widget(options) {}

The two constructors are now accessible as Widget and Widget(2) in namepaths.

See also

• @name
• @alias

Official reference: jsdoc.app/tags-variation