jsdoc

Verify and Fix JSDoc Comments with ESLint

Use ESLint JSDoc plugin to ensure all functions, classes, and modules have proper, consistent documentation.

CRITICAL: Persistence Requirement

DO NOT STOP until ALL JSDoc issues are resolved. This task requires complete coverage:

• Process every single file reported by the tools
• Fix every missing or malformed JSDoc comment
• Continue working through all modules systematically
• Re-run the analysis tools after each batch of fixes to confirm progress
• Only consider this task complete when ESLint reports zero JSDoc violations

If context window limits approach, document remaining files in the todo list and continue in the next session. Do not leave the codebase in a partially documented state.

1. Install JSDoc Plugin (if missing)

npm install -D eslint-plugin-jsdoc

2. Configure ESLint

Add to .eslintrc.js:

{
  plugins: ['jsdoc'],
  extends: ['plugin:jsdoc/recommended-typescript'],
  rules: {
    'jsdoc/require-jsdoc': ['warn', {
      require: {
        FunctionDeclaration: true,
        MethodDefinition: true,
        ClassDeclaration: true,
        ArrowFunctionExpression: false,
        FunctionExpression: false
      }
    }],
    'jsdoc/require-description': 'warn',
    'jsdoc/require-param-description': 'warn',
    'jsdoc/require-returns-description': 'warn'
  }
}

3. Run JSDoc Analysis

npx eslint . --ext .js,.ts,.vue --rule 'jsdoc/require-jsdoc: warn'

4. JSDoc Standards

Use consistent JSDoc format:

/**
 * Short one-line summary ending with period.
 *
 * Longer description if needed. Explain the purpose,
 * not the implementation.
 *
 * @param param1 - Description of first parameter.
 * @param param2 - Description of second parameter.
 * @returns Description of return value.
 * @throws {Error} When param2 is negative.
 *
 * @example
 * ```ts
 * const result = functionName('value', 42);
 * ```
 */
function functionName(param1: string, param2: number): boolean {
  // ...
}