search

coffeedoc / codo

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

Multiple possible types and linking to them #239

Open E-geek opened 8 years ago

E-geek commented 8 years ago

If a property or parameter may have to be one of several types, it would be desirable to specify them by "|" or ",". Example:

# @param {EventLogger|Logger} logger instance of Logger or EventLogger for logging

And need have a links to EventLogger and Logger if it's possible

inossidabile commented 8 years ago

It's specified in README that you should be then handling that via a comma. But I guess that's specifically links that you desire and we don't have indeed. I don't have much time to work on feature requests now unfortunately but you did handle the previous one very well yourself. Could it be another PR from you? :)

pmaselkowski commented 7 years ago

Separating by | is standard in phpdocs, and seems to be standard in jsdocs too