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

Document more in detail how to use @returns with types vs values #185

Open
MartinMuzatko opened this issue Jan 17, 2018 · 0 comments
Open

Comments

@MartinMuzatko
Copy link

Hello!

http://usejsdoc.org/tags-returns.html does not document if only types are allowed.
While the description explicitly says

The @returns tag documents the value that a function returns.

in all the example, types are used.
Are only types important for documentation?
If I know that my function will either return false or a string, how should I document that then?

{String|Boolean} ? {String|false}?

Thanks!

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

No branches or pull requests

1 participant