search

jscs-dev / jscs-jsdoc

JsDoc validation rules for jscs
MIT License
99 stars 35 forks source link

Implement requireReturnDescription #122

Closed weekens closed 9 years ago

weekens commented 9 years ago

Similar to requireParamDescription, but for returns.

I'd like the following JSDoc to be invalid:

/**
 * Some description.
 *
 * @returns {Boolean}
 */
foo: function() {
  return false;
}
qfox commented 9 years ago

@weekens Thanks for suggestion. Do you mind to tackle this? ;-)

It's easy as: https://github.com/jscs-dev/jscs-jsdoc/blob/master/lib/rules/validate-jsdoc/require-param-description.js

What to do:

weekens commented 9 years ago

@zxqfox, I'll try to!

weekens commented 9 years ago

Created a pull request: https://github.com/jscs-dev/jscs-jsdoc/pull/125