class MyElement extends HTMLElement {
/**
* Dispatched when the enter key is pressed
* @fires {Event} some-event - some description for some-event
* @event {SomeCustomEvent} foo-changed - some description for foo-changed
*/
this.dispatchEvent(new CustomEvent('foo-changed'));
}
[ ] Supports @fires
[ ] Supports @event
[ ] Add docs
[ ] If not Event or CustomEvent, add Reference to the event (it should be in imports or in declarations after the analyze phase)
[ ] Make sure the description after @event or @fires overwrites the description on top
[ ] Deal with jsdoc type imports ${import('./module.js').SomeEvent}. Get type SomeEvent, add reference to ./module.js
[ ] merge or override with JSDoc declared above the class
@fires
@event
Event
orCustomEvent
, addReference
to the event (it should be inimports
or indeclarations
after the analyze phase)@event
or@fires
overwrites the description on top${import('./module.js').SomeEvent}
. Get typeSomeEvent
, add reference to./module.js