gjtorikian / biscotto

UNMAINTAINED. CoffeeScript API documentation tool that uses TomDoc notation.
https://gjtorikian.github.io/biscotto/
MIT License
105 stars 18 forks source link

No easy way of documenting events #58

Open mbrio opened 10 years ago

mbrio commented 10 years ago

Looking through Atom and Biscotto I couldn't find any examples of documenting emitted events and felt this was a weakness of Biscotto/TomDoc. Since Biscotto has other extensions I propose adding an Emits keyword:

# Emits loaded whenever something is loaded. The first argument will be an
#   {Object} and the second argument will be a {Boolean}