jsdoc/require-returns-description Pedantic
What it does
Requires that the @returns tag has a description value. The error will not be reported if the return value is voidor undefined or if it is Promise<void> or Promise<undefined>.
Why is this bad?
A @returns tag should have a description value.
Examples
Examples of incorrect code for this rule:
javascript
/** @returns */
function quux(foo) {}Examples of correct code for this rule:
javascript
/** @returns 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-returns-description --jsdoc-pluginjson
{
"plugins": ["jsdoc"],
"rules": {
"jsdoc/require-returns-description": "error"
}
}