JSDoc comments suffer from many issues as of 49b8f29. I ran https://github.com/gajus/eslint-plugin-jsdoc and got the following:
$ yarn eslint .
✖ 455 problems (445 errors, 10 warnings)
253 errors and 0 warnings potentially fixable with the `--fix` option.
error Command failed with exit code 1.
See https://github.com/eclipse-zenoh/zenoh-ts/tree/jsdoc-lints to reproduce. Here's breakdown of the different lint errors found:
jsdoc/require-returns-type: 109
jsdoc/require-param: 72
jsdoc/check-tag-names: 70
jsdoc/tag-lines: 41
jsdoc/require-jsdoc: 41
jsdoc/require-returns: 37
jsdoc/check-alignment: 30
jsdoc/require-param-type: 24
jsdoc/require-param-description: 8
jsdoc/require-returns-description: 4
jsdoc/valid-types: 2
jsdoc/require-yields: 2
jsdoc/require-returns-check: 2
jsdoc/multiline-blocks: 1
jsdoc/empty-tags: 1
jsdoc/check-param-names: 1
JSDoc comments suffer from many issues as of 49b8f29. I ran https://github.com/gajus/eslint-plugin-jsdoc and got the following:
See https://github.com/eclipse-zenoh/zenoh-ts/tree/jsdoc-lints to reproduce. Here's breakdown of the different lint errors found: