Document

Toggle: enabledChecks.document · Fix: autofix.document · Command: document

Maintains source headers, import grouping, section layout, whitespace, and TSDoc shape. It can scaffold minimal TSDoc tags to satisfy a configured documentation policy, but does not invent prose.

{
  "documentation": {
    "required": { "types": true, "functions": true, "exportedFunctions": true, "noInlineFunctions": false }
  }
}

“Types” means classes, enums, interfaces, and type aliases. “Functions” means named function declarations. exportedFunctions can require only exported named functions when functions is false. noInlineFunctions reports arrow functions and function expressions and has no safe autofix. maintain remains a compatibility alias for document.

Generated placeholders are scaffolding. Replace them with descriptions of stable public intent and current signatures.

Before — the public function has no meaningful summary:

export function formatPrice(amount: number): string {
  return `$${amount.toFixed(2)}`;
}

After — a maintainer explains its intent and parameter:

/** Formats a price in US dollars with two decimal places.
 * @param amount Price in dollars.
 * @returns The formatted price.
 */
export function formatPrice(amount: number): string {
  return `$${amount.toFixed(2)}`;
}