require-exported-doc-comment

Require exported declarations to include a leading TypeDoc comment block.

Targeted pattern scope

This rule targets exported declarations that TypeDoc commonly documents, including:

• exported functions and classes
• exported interfaces, type aliases, enums, and namespaces
• exported variable declarations

What this rule reports

This rule reports exported declarations that do not have an adjacent leading TypeDoc block comment.

Why this rule exists

Public exports define your documented API surface. Missing comments on exports produce gaps in generated docs and make API intent harder to understand.

❌ Incorrect

export function createClient(): void {}

✅ Correct

/**
 * Create the primary API client.
 */
export function createClient(): void {}

Behavior and migration notes

The autofix inserts a minimal TODO TypeDoc block so teams can quickly mark undocumented exports and fill details incrementally.

ESLint flat config example

import typedocPlugin from "eslint-plugin-typedoc";

export default [
    {
        plugins: { typedoc: typedocPlugin },
        rules: {
            "typedoc/require-exported-doc-comment": "error",
        },
    },
];

When not to use it

Disable this rule when a package intentionally has no generated API documentation and treats exports as internal-only implementation details.

Package documentation

TypeDoc package documentation:

• TypeDoc comments

Further reading

Rule catalog ID: R003

• TypeScript handbook: declaration files introduction

Adoption resources

• Start with typedoc.configs.recommended and combine autofix with targeted follow-up docs review.