Package com.puppycrawl.tools.checkstyle.checks.javadoc

package com.puppycrawl.tools.checkstyle.checks.javadoc

Contains the Javadoc checks that are bundled with the main distribution.

Related Packages

Package	Description
com.puppycrawl.tools.checkstyle.checks	Contains the checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.javadoc.utils	Contains utils classes for the Javadoc checks that are bundled with the main distribution.

Class	Description
AbstractJavadocCheck	Base class for Checks that process Javadoc comments.
AbstractJavadocCheck.FileContext	The file context holder.
AtclauseOrderCheck	Checks the order of javadoc block-tags or javadoc tags.
IllegalBlockTagCheck	Detects a user-defined Javadoc block tag and reports a violation when the tag is present with text that does not match tagTextPattern.
InappropriateJavadocBlockTagsOnTypeCheck	Checks that Javadoc block tags for type definitions (class, interface, enum, record, annotation) do not contain tags that are semantically invalid for types.
InvalidJavadocPositionCheck	Checks that Javadocs are located at the correct position.
InvalidJavadocTag	Value object for storing data about an invalid Javadoc tag.
JavadocBlockTagLocationCheck	Checks that a javadoc block tag appears only at the beginning of a line, ignoring leading asterisks and white space.
JavadocContentLocationCheck	Checks that the Javadoc content begins from the same position for all Javadoc comments in the project.
JavadocContentLocationOption	Represents the locations for the javadoc content.
JavadocEndCommentDelimiterCheck	Checks that the Javadoc closing delimiter contains exactly one asterisk before the slash.
JavadocLeadingAsteriskAlignCheck	Checks the alignment of leading asterisks in a Javadoc comment.
JavadocLinkFirstOccurrenceCheck	Checks that in Javadoc comments, each API name is linked with {@link} or {@linkplain} only on its first occurrence.
JavadocLinkWellKnownApiCheck	Checks that Javadoc comments avoid unnecessary {@link} and {@linkplain} tags for APIs that are considered well-known.
JavadocMethodCheck	Checks the Javadoc of a method or constructor.
JavadocMethodCheck.ClassInfo	Contains class's Token.
JavadocMethodCheck.ExceptionInfo	Stores useful information about declared exception.
JavadocMethodCheck.Token	Represents text element with location in the text.
JavadocMissingLeadingAsteriskCheck	Checks if the javadoc has leading asterisks on each line.
JavadocMissingWhitespaceAfterAsteriskCheck	Checks that there is at least one whitespace after the leading asterisk.
JavadocNodeImpl	Implementation of DetailNode interface that is mutable.
JavadocNoErrorInThrowsTagCheck	Checks that Error types are not documented in @throws or @exception Javadoc tags.
JavadocPackageCheck	Checks that each Java package has a Javadoc file used for commenting.
JavadocParagraphCheck	Checks the Javadoc paragraph.
JavadocParamOrderCheck	Checks that @param tags in Javadoc comments are in the same order as the parameters in the declaration.
JavadocRegexpCheck	Checks that Javadoc comments do not match a configured regular expression.
JavadocTag	Represents a Javadoc tag.
JavadocTagContinuationIndentationCheck	Checks the indentation of the continuation lines in block tags.
JavadocTagInfo	This enum defines the various Javadoc tags and their properties.
JavadocTagInfo.Type	The Javadoc Type.
JavadocThrowsOrderCheck	Checks that multiple @throws and @exception Javadoc tags are listed alphabetically by exception name.
JavadocTypeCheck	Checks the Javadoc comments for type definitions.
JavadocVariableCheck	Checks that a variable has a Javadoc comment.
MissingJavadocMethodCheck	Checks for missing Javadoc comments for a method or constructor.
MissingJavadocPackageCheck	Checks for missing package definition Javadoc comments in package-info.java files.
MissingJavadocTypeCheck	Checks for missing Javadoc comments for class, enum, interface, and annotation interface definitions.
NonEmptyAtclauseDescriptionCheck	Checks that the block tag is followed by description.
PreferCodeOrSnippetJavadocInlineTagCheck	Checks that Javadoc inline tags {@code ...} and {@snippet ...} are preferred over HTML tags <code> and <pre>.
PreferLiteralJavadocInlineTagCheck	Checks that Javadoc inline tags are preferred over escaping entities.
RequireEmptyLineBeforeBlockTagGroupCheck	Checks that one blank line before the block tag if it is present in Javadoc.
SingleLineJavadocCheck	Checks that a Javadoc block can fit in a single-line and doesn't contain block tags.
SummaryJavadocCheck	Checks that Javadoc summary sentence does not contain phrases that are not recommended to use.
WriteTagCheck	Requires user defined Javadoc tag to be present in Javadoc comment with defined format.