require-jsdoc

ESLint plugin / require-jsdoc

Requires JSDoc documentation.

module.exports = {
  plugins: ["misc"],
  rules: {
    "misc/require-jsdoc": [
      "error",
      {
        excludeSelectors: string[],
        includeSelectors: string[],
        interfaces: "callSignatures" | "constructSignatures" | "interface",
        noDefaultSelectors: boolean
      }
    ]
  }
};

Option	Description	Default
excludeSelectors	Skip these selectors	[]
includeSelectors	Check additional selectors	[]
interfaces	Require documentation for interface (“interface”), call signatures (“callSignatures”), construct signatures (“constructSignatures”)	['callSignatures','constructSignatures']
noDefaultSelectors	Do not check default selectors	false

Examples of incorrect code

function f(): void {}

Examples of correct code

/**
 * Description.
 */
function f(): void {}