search

coffeedoc / codo

CoffeeScript API documentation generator. It's like YARD but for CoffeeScript!
Other
625 stars 92 forks source link

Tag to mark asynchronous functions #186

Open bennycode opened 9 years ago

bennycode commented 9 years ago

I am a big fan of codo and its documentation options. During my work with CoffeeScript and doco I noticed that I would like to mark functions as asynchronous. Often I write it in the description of a function but it would be much nicer to have a tag for that (like @async). This could be explicitly point out that some methods (or statements) are executed asynchronously and return their results later.

IDEs could later build on that synatx and display a warning to make developers aware of it.

aseemk commented 9 years ago

Nice idea! I agree. Especially because then you could use e.g. @return and @throw and it would be understood that this refers to what the callback gets.

deiwin commented 8 years ago

There has been a lot of discussion about a similar feature request in the JSDoc project. Probably worth checking that out before deciding on an approach here.