Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@event tags are erased #93

Open
moog16 opened this issue Jul 9, 2019 · 0 comments
Open

@event tags are erased #93

moog16 opened this issue Jul 9, 2019 · 0 comments

Comments

@moog16
Copy link

moog16 commented Jul 9, 2019

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant