@fires

Содержание

Синонимы
Синтаксис
Обзор
Примеры
Связанные ссылки

Синонимы

@emits

Синтаксис

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

Обзор

Тег @fires указывает, что метод может генерировать событие указанного типа при вызове. Используйте тег @event для документирования содержимого события.

Примеры

Метод, генерирующий событие 'drain'

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

Связанные ссылки

@event
@listens

© 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