Originally created by: Redo-San
Baseline (2026-10-06): npm run lint reports 31 JSDoc warnings that are not the bulk "missing description/type" debt — these are actual documentation errors (wrong parameter names, invalid types, unescaped tags) and they are all individually fixable:
| Rule | Count | Locations |
|---|---|---|
jsdoc/check-param-names |
4 | Decentralized_Identity_DID/did.js:638, cli/commands/c2pa.js:461, cli/commands/watermark.js:608, cli/commands/watermark.js:817 |
jsdoc/check-types |
2 | Decentralized_Identity_DID/did.js:876, scripts/update-readme.js:42 |
jsdoc/valid-types |
1 | Iris_Biometric/iris_template_protection.js:219 (function is not a valid type) |
jsdoc/reject-any-type |
1 | Iris_Biometric/iris_ui.js:1481 |
jsdoc/reject-function-type |
2 | Style/mpa-router.js:339, Style/mpa-router.js:378 |
jsdoc/escape-inline-tags |
3 | Iris_Biometric/iris_ui.js:2339, :2352, :2364 |
jsdoc/require-jsdoc |
3 | scripts/actionlint-prepush.mjs:17, scripts/pre-push-check.mjs:14, :18 |
jsdoc/tag-lines |
15 | scripts/update-readme.js (lines 39, 71, 91, 101, 114, 140, 153, 169, 185, 236, 252, 271, 319, 330, 348) |
Worked example — the documented signature is wrong, so generated docs would be wrong too:
/**
*
* @param stored
* @param str
*/
function _jwkBase64urlDecode(str) {
_jwkBase64urlDecode takes one parameter; stored does not exist and must be dropped. Same class of bug in cli/commands/c2pa.js:461 (documents opts, signature is absPath, _opts) and cli/commands/watermark.js:608 / :817 (documents extra leading parameters).
npx eslint --config .tools/Developer_Toolkit/eslint.config.mjs . -f json.npm run check passes.