| import iterateJsdoc from '../iterateJsdoc.js'; |
| |
| export default iterateJsdoc(({ |
| report, |
| utils, |
| }) => { |
| utils.forEachPreferredTag('property', (jsdoc, targetTagName) => { |
| if (!jsdoc.description.trim()) { |
| report( |
| `Missing JSDoc @${targetTagName} "${jsdoc.name}" description.`, |
| null, |
| jsdoc, |
| ); |
| } |
| }); |
| }, { |
| iterateAllJsdocs: true, |
| meta: { |
| docs: { |
| description: 'Requires that each `@property` tag has a `description` value.', |
| url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-description.md#repos-sticky-header', |
| }, |
| type: 'suggestion', |
| }, |
| }); |