diff options
Diffstat (limited to 'tools/eslint/lib/rules/valid-jsdoc.js')
-rw-r--r-- | tools/eslint/lib/rules/valid-jsdoc.js | 28 |
1 files changed, 26 insertions, 2 deletions
diff --git a/tools/eslint/lib/rules/valid-jsdoc.js b/tools/eslint/lib/rules/valid-jsdoc.js index a79bf7fea49..bab6037d176 100644 --- a/tools/eslint/lib/rules/valid-jsdoc.js +++ b/tools/eslint/lib/rules/valid-jsdoc.js @@ -21,7 +21,7 @@ module.exports = function(context) { prefer = options.prefer || {}, // these both default to true, so you have to explicitly make them false - requireReturn = options.requireReturn === false ? false : true, + requireReturn = options.requireReturn !== false, requireParamDescription = options.requireParamDescription !== false, requireReturnDescription = options.requireReturnDescription !== false; @@ -143,7 +143,7 @@ module.exports = function(context) { }); // check for functions missing @returns - if (!hasReturns && !hasConstructor) { + if (!hasReturns && !hasConstructor && node.parent.kind !== "get") { if (requireReturn || functionData.returnPresent) { context.report(jsdocNode, "Missing JSDoc @returns for function."); } @@ -189,3 +189,27 @@ module.exports = function(context) { }; }; + +module.exports.schema = [ + { + "type": "object", + "properties": { + "prefer": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "requireReturn": { + "type": "boolean" + }, + "requireParamDescription": { + "type": "boolean" + }, + "requireReturnDescription": { + "type": "boolean" + } + }, + "additionalProperties": false + } +]; |