jsdoc/require-param-description Pedantic
What it does
Requires that each @param tag has a description value.
Why is this bad?
The description of a param should be documented.
Examples
Examples of incorrect code for this rule:
javascript
/** @param foo */
function quux(foo) {}Examples of correct code for this rule:
javascript
/** @param foo Foo. */
function quux(foo) {}How to use
To enable this rule in the CLI or using the config file, you can use:
bash
oxlint --deny jsdoc/require-param-description --jsdoc-pluginjson
{
"plugins": ["jsdoc"],
"rules": {
"jsdoc/require-param-description": "error"
}
}