You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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!
The text was updated successfully, but these errors were encountered:
Hello!
http://usejsdoc.org/tags-returns.html does not document if only types are allowed.
While the description explicitly says
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!
The text was updated successfully, but these errors were encountered: