Rules overview

eslint-plugin-typedoc provides rules that bring TypeDoc feedback directly into your ESLint workflow.

Available rules

Rule	Description	Fix
no-duplicate-param-tags	Disallow duplicate @param tags for the same parameter name.	❌
no-duplicate-type-param-tags	Disallow duplicate @typeParam/@template tags for the same type parameter name.	❌
no-empty-example-tag	Disallow empty @example tags and empty example blocks.	❌
no-empty-remarks-tag	Disallow empty @remarks tags and empty remarks blocks.	❌
no-extra-param-tags	Disallow stale @param tags that no longer map to real parameters.	❌
no-extra-type-param-tags	Disallow stale generic tags (@typeParam/@template) that do not map to signatures.	❌
no-malformed-inline-links	Disallow malformed inline {@link ...} tags.	💡
no-unknown-tags	Disallow unknown TypeDoc tags and normalize common aliases.	🔧
prefer-package-documentation-tag	Prefer canonical @packageDocumentation tags instead of @module.	🔧
prefer-type-param-tag	Prefer canonical @typeParam tags instead of @template.	🔧
require-code-fence-language	Require Markdown code fences in TypeDoc comments to declare a language.	🔧
require-default-value-tag	Require @defaultValue tags on documented exported constants with simple defaults.	🔧
require-deprecated-tag-description	Require @deprecated tags to explain why the API is deprecated or what to use instead.	❌
require-example-tag	Require @example tags on documented exported API declarations.	🔧
require-exported-doc-comment	Require exported declarations to include a TypeDoc comment.	🔧
require-exported-doc-comment-description	Require documented exported declarations to include a lead summary paragraph.	❌
require-package-documentation-description	Require package-level docs to include descriptive prose.	❌
require-package-documentation	Require top-level @packageDocumentation comments in exporting modules.	🔧
require-param-tag-description	Require @param tags to include descriptive prose.	❌
require-param-tags	Require documented declarations to include @param tags for every parameter.	🔧
require-returns-description	Require @returns tags to include semantic descriptions, not only type annotations.	❌
require-returns-tag	Require @returns tags for documented declarations with non-void return types.	🔧
require-throws-description	Require @throws tags to describe throw conditions, not only error types.	❌
require-throws-tag	Require @throws tags when documented functions and methods throw.	🔧
require-type-param-tag-description	Require generic tags to include descriptive prose.	❌
require-type-param-tags	Require @typeParam tags for all declared generic type parameters.	🔧
typedoc-config-requires-options	Require essential options in TypeDoc config objects.	🔧

Preset summary

• typedoc.configs.minimal
• typedoc.configs.recommended
• typedoc.configs.markdown
• typedoc.configs.tsdoc
• typedoc.configs.jsdoc
• typedoc.configs.strict
• typedoc.configs.all

See preset docs for full matrix details.