blob: 48bf27b3c922a02885f19f4beba63a8df66bb2d1 [file] [log] [blame]
"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc"));
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
var _default = (0, _iterateJsdoc.default)(({
report,
utils
}) => {
utils.forEachPreferredTag('param', (jsdocParameter, targetTagName) => {
if (!jsdocParameter.description) {
report(`Missing JSDoc @${targetTagName} "${jsdocParameter.name}" description.`, null, jsdocParameter);
}
});
}, {
contextDefaults: true,
meta: {
schema: [{
additionalProperties: false,
properties: {
contexts: {
items: {
type: 'string'
},
type: 'array'
}
},
type: 'object'
}],
type: 'suggestion'
}
});
exports.default = _default;
module.exports = exports.default;
//# sourceMappingURL=requireParamDescription.js.map