@fires

Table of Contents

Synonyms

@emits

Syntax

@fires <className>#[event:]<eventName>

Overview

The @fires tag indicates that a method can fire a specified type of event when it is called. Use the @event tag to document the event's content.

Examples

Method that fires a 'drain' event
/**
 * Drink the milkshake.
 *
 * @fires Milkshake#drain
 */
Milkshake.prototype.drink = function() {
    // ...
};

© 2011–2017 the contributors to the JSDoc 3 documentation project
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://jsdoc.app/tags-fires.html