jsdoc.github.io
jsdoc.github.io copied to clipboard
Can you use @fires on a class definition ?
Just trying to work out the best way to document components so that other devs know what to listen to:
-
@property
= in -
@fires
= out
Does this look reasonable?
/**
* Modal Component
*
* @property closable the modal is closable
* @emits close the modal was closed (success)
* @emits cancel the model was cancelled
*/
export default class {