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

Use @type for getter values, not @returns #340

Open
gastrodon opened this issue Sep 24, 2019 · 0 comments
Open

Use @type for getter values, not @returns #340

gastrodon opened this issue Sep 24, 2019 · 0 comments

Comments

@gastrodon
Copy link

It seems like this plugin cannot tell the difference between regular function, and getters. In jsdoc, getters appear as Members that have a type, not as Methods that have a return value. For this reason, the return type of a getter should be specified with @type instead of @returns

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

No branches or pull requests

2 participants