Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multiple possible types and linking to them #239

Open
E-geek opened this issue Jun 23, 2016 · 2 comments
Open

Multiple possible types and linking to them #239

E-geek opened this issue Jun 23, 2016 · 2 comments
Labels

Comments

@E-geek
Copy link

E-geek commented Jun 23, 2016

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
Copy link
Member

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
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants