# Eslint Plugin Jsdoc

> 

## Pages

- [Advanced](advanced.md): * AST and Selectors
- [Processors](processors.md): Normally JavaScript content inside JSDoc tags is not discoverable by ESLint.
- [<code>check-access</code>](rules-check-access.md): * Context and settings
- [<code>check-alignment</code>](rules-check-alignment.md): * Fixer
- [<code>check-examples</code>](rules-check-examples.md): * Options
- [<code>check-indentation</code>](rules-check-indentation.md): * Options
- [<code>check-line-alignment</code>](rules-check-line-alignment.md): * Fixer
- [<code>check-param-names</code>](rules-check-param-names.md): * Fixer
- [<code>check-property-names</code>](rules-check-property-names.md): * Fixer
- [<code>check-syntax</code>](rules-check-syntax.md): * Context and settings
- [<code>check-tag-names</code>](rules-check-tag-names.md): * Fixer
- [<code>check-template-names</code>](rules-check-template-names.md): Checks that any`@template`names are actually used in the connected
- [<code>check-types</code>](rules-check-types.md): * Options
- [<code>check-values</code>](rules-check-values.md): * Options
- [<code>convert-to-jsdoc-comments</code>](rules-convert-to-jsdoc-comments.md): Converts single line or non-JSDoc, multiline comments into JSDoc comments.
- [Empty Tags](rules-empty-tags.md): Expects the following tags to be empty of any content:
- [<code>escape-inline-tags</code>](rules-escape-inline-tags.md): Reports use of JSDoc tags in non-tag positions (in the default "typescript" mode).
- [<code>implements-on-classes</code>](rules-implements-on-classes.md): * Options
- [Imports As Dependencies](rules-imports-as-dependencies.md): This rule will report an issue if JSDoc`import()`statements point to a package
- [<code>informative-docs</code>](rules-informative-docs.md): * Options
- [<code>lines-before-block</code>](rules-lines-before-block.md): This rule enforces minimum number of newlines before JSDoc comment blocks
- [<code>match-description</code>](rules-match-description.md): * Options
- [Match Name](rules-match-name.md): Reports the name portion of a JSDoc tag if matching or not matching
- [Multiline Blocks](rules-multiline-blocks.md): Controls how and whether JSDoc blocks can be expressed as single or multiple
- [No Bad Blocks](rules-no-bad-blocks.md): This rule checks for multi-line-style comments which fail to meet the
- [No Blank Block Descriptions](rules-no-blank-block-descriptions.md): If tags are present, this rule will prevent empty lines in the
- [<code>no-blank-blocks</code>](rules-no-blank-blocks.md): * Fixer
- [<code>no-defaults</code>](rules-no-defaults.md): * Fixer
- [<code>no-missing-syntax</code>](rules-no-missing-syntax.md): * Options
- [No Multi Asterisks](rules-no-multi-asterisks.md): Prevents use of multiple asterisks at the beginning of lines.
- [<code>no-restricted-syntax</code>](rules-no-restricted-syntax.md): * Options
- [<code>no-types</code>](rules-no-types.md): * Fixer
- [<code>no-undefined-types</code>](rules-no-undefined-types.md): * Options
- [<code>prefer-import-tag</code>](rules-prefer-import-tag.md): Prefer`@import`tags to inline`import()`statements.
- [<code>reject-any-type</code>](rules-reject-any-type.md): Reports use of`any`(or`*`) type within JSDoc tag types.
- [<code>reject-function-type</code>](rules-reject-function-type.md): Reports use of`Function`type within JSDoc tag types.
- [Require Asterisk Prefix](rules-require-asterisk-prefix.md): Requires that each JSDoc line starts with an`*`.
- [<code>require-description-complete-sentence</code>](rules-require-description-complete-sentence.md): * Fixer
- [<code>require-description</code>](rules-require-description.md): * Options
- [<code>require-example</code>](rules-require-example.md): * Fixer
- [<code>require-file-overview</code>](rules-require-file-overview.md): * Options
- [<code>require-hyphen-before-param-description</code>](rules-require-hyphen-before-param-description.md): * Fixer
- [<code>require-jsdoc</code>](rules-require-jsdoc.md): * Fixer
- [<code>require-next-description</code>](rules-require-next-description.md): Requires a description for (non-standard)`@next`tags.
- [<code>require-next-type</code>](rules-require-next-type.md): Requires a type on the (non-standard)`@next`tag.
- [<code>require-param-description</code>](rules-require-param-description.md): * Options
- [<code>require-param-name</code>](rules-require-param-name.md): * Options
- [<code>require-param-type</code>](rules-require-param-type.md): * Options
- [<code>require-param</code>](rules-require-param.md): * Fixer
- [<code>require-property-description</code>](rules-require-property-description.md): * Context and settings
- [<code>require-property-name</code>](rules-require-property-name.md): * Context and settings
- [<code>require-property-type</code>](rules-require-property-type.md): * Context and settings
- [<code>require-property</code>](rules-require-property.md): * Fixer
- [<code>require-rejects</code>](rules-require-rejects.md): Requires a (non-standard)`@rejects`tag be added for detectable`Promise`
- [<code>require-returns-check</code>](rules-require-returns-check.md): * Options
- [<code>require-returns-description</code>](rules-require-returns-description.md): * Options
- [<code>require-returns-type</code>](rules-require-returns-type.md): * Options
- [<code>require-returns</code>](rules-require-returns.md): * Fixer
- [<code>require-tags</code>](rules-require-tags.md): Requires tags be present, optionally for specific contexts.
- [<code>require-template-description</code>](rules-require-template-description.md): |||
- [<code>require-template</code>](rules-require-template.md): Checks to see that`@template`tags are present for any detected type
- [<code>require-throws-description</code>](rules-require-throws-description.md): Requires a description for`@throws`tags.
- [<code>require-throws-type</code>](rules-require-throws-type.md): Requires a type on the`@throws`tag.
- [<code>require-throws</code>](rules-require-throws.md): * Options
- [<code>require-yields-check</code>](rules-require-yields-check.md): * Options
- [<code>require-yields-description</code>](rules-require-yields-description.md): Requires a description for`@yields`tags.
- [<code>require-yields-type</code>](rules-require-yields-type.md): Requires a type on the`@yields`tag.
- [<code>require-yields</code>](rules-require-yields.md): * Options
- [<code>required-tags</code>](rules-required-tags.md): Requires tags be present, optionally for specific contexts.
- [<code>sort-tags</code>](rules-sort-tags.md): * Fixer
- [<code>tag-lines</code>](rules-tag-lines.md): * Fixer
- [<code>text-escaping</code>](rules-text-escaping.md): * Fixer
- [<code>ts-method-signature-style</code>](rules-ts-method-signature-style.md): Inspired by`typescript-eslint`'s [method-signature-style](https://typescript-eslint.io/rules/method-signature-style/...
- [<code>ts-no-empty-object-type</code>](rules-ts-no-empty-object-type.md): Warns against use of the empty object type which, in TypeScript,
- [<code>ts-no-unnecessary-template-expression</code>](rules-ts-no-unnecessary-template-expression.md): Catches unnecessary template expressions such as string expressions within
- [<code>ts-prefer-function-type</code>](rules-ts-prefer-function-type.md): Inspired by`typescript-eslint`'s [prefer-function-type](https://typescript-eslint.io/rules/prefer-function-type/) rule.
- [<code>type-formatting</code>](rules-type-formatting.md): Formats JSDoc type values.
- [<code>valid-types</code>](rules-valid-types.md): * Options
- [Settings](settings.md): * [Allow tags (`@private`or`@internal`) to disable rules for that comment block](#user-content-settings-allow-tags-...