Javadoc Comments Checks

AtclauseOrder	Checks the order of javadoc block-tags or javadoc tags.
IllegalBlockTag	Detects a user-defined Javadoc block tag and reports a violation when the tag is present with text that does not match `tagTextPattern`.
InappropriateJavadocBlockTagsOnType	Checks that Javadoc block tags for type definitions (class, interface, enum, record, annotation) do not contain tags that are semantically invalid for types.
InvalidJavadocPosition	Checks that Javadocs are located at the correct position.
JavadocBlockTagLocation	Checks that a javadoc block tag appears only at the beginning of a line, ignoring leading asterisks and white space.
JavadocContentLocation	Checks that the Javadoc content begins from the same position for all Javadoc comments in the project.
JavadocEndCommentDelimiter	Checks that the Javadoc closing delimiter contains exactly one asterisk before the slash.
JavadocLeadingAsteriskAlign	Checks the alignment of leading asterisks in a Javadoc comment.
JavadocLinkFirstOccurrence	Checks that in Javadoc comments, each API name is linked with `{@link}` or `{@linkplain}` only on its first occurrence.
JavadocLinkWellKnownApi	Checks that Javadoc comments avoid unnecessary `{@link}` and `{@linkplain}` tags for APIs that are considered well-known.
JavadocMethod	Checks the Javadoc of a method or constructor.
JavadocMissingLeadingAsterisk	Checks if the javadoc has leading asterisks on each line.
JavadocMissingWhitespaceAfterAsterisk	Checks that there is at least one whitespace after the leading asterisk.
JavadocNoErrorInThrowsTag	Checks that `Error` types are not documented in `@throws` or `@exception` Javadoc tags.
JavadocPackage	Checks that each Java package has a Javadoc file used for commenting.
JavadocParagraph	Checks the Javadoc paragraph.
JavadocParamOrder	Checks that `@param` tags in Javadoc comments are in the same order as the parameters in the declaration.
JavadocRegexp	Checks that Javadoc comments do not match a configured regular expression.
JavadocTagContinuationIndentation	Checks the indentation of the continuation lines in block tags.
JavadocThrowsOrder	Checks that multiple `@throws` and `@exception` Javadoc tags are listed alphabetically by exception name.
JavadocType	Checks the Javadoc comments for type definitions.
JavadocVariable	Checks that a variable has a Javadoc comment.
MissingJavadocMethod	Checks for missing Javadoc comments for a method or constructor.
MissingJavadocPackage	Checks for missing package definition Javadoc comments in package-info.java files.
MissingJavadocType	Checks for missing Javadoc comments for class, enum, interface, and annotation interface definitions.
NonEmptyAtclauseDescription	Checks that the block tag is followed by description.
PreferCodeOrSnippetJavadocInlineTag	Checks that Javadoc inline tags `{@code ...}` and `{@snippet ...}` are preferred over HTML tags `<code>` and `<pre>`.
PreferLiteralJavadocInlineTag	Checks that Javadoc inline tags are preferred over escaping entities.
RequireEmptyLineBeforeBlockTagGroup	Checks that one blank line before the block tag if it is present in Javadoc.
SingleLineJavadoc	Checks that a Javadoc block can fit in a single-line and doesn't contain block tags.
SummaryJavadoc	Checks that Javadoc summary sentence does not contain phrases that are not recommended to use.
WriteTag	Requires user defined Javadoc tag to be present in Javadoc comment with defined format.