nikhilkalige / docblockr

DocBlockr is a package for Atom which is designed to make writing documentation faster and easier.
MIT License
405 stars 93 forks source link

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

Open gastrodon opened 5 years ago

gastrodon commented 5 years ago

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