jsdoc/jsdoc.github.io

Can you use @fires on a class definition ?

davestewart opened this issue · 0 comments

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 {