@emits is ignored within the class description

[ibc]

/**
 * A `Server` is foo and bar.
 *
 * @emits {close} Fired when the `Server` is closed.  // THIS IS IGNORED
 */
class Server extends EventEmitter
{
    [...]
}

The above @emits produces nothing in the generated doc.

Instead it just seems to work when applied in a class method description:

class Server extends EventEmitter
{
    /**
     * @emits {close} Fired when the `Server` is closed.  // THIS IS SHOWN
     */
    foo() {}
}

But obviously this makes no sense as events are fired in the class instance and they are not related to API methods...

[jake-knerr]

+1

[krvikash35]

+1

[dannobytes]

👍

[CITguy]

I'm working on getting this updated.

• esdoc PR: feat(Class): add support for class @emits and @listens #524
• esdoc-plugins PR: TBD