Skip to content

@event tags are erased #93

@moog16

Description

@moog16

Currently I'm using the compiler. I use the compiler to build JSON, which I then use to create markdown. According to https://jsdoc.app/tags-event.html, I should be able to use @event tags to document different events that are emitted.

Desired usage:

/**
 * @event Drawer:event Emits when the drawer has closed.
 * @type {object}
 * @event Drawer:opened Emits when the drawer has opened.
 * @type {object}
 */
export class Drawer {

Actual Result:
Using this notation actually removes the Drawer entry from docs.json.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions