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

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

Class Summary

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.
HtmlTag	Used to keep track of a tag and the text that follows it.
InvalidJavadocPositionCheck	Checks that Javadocs are located at the correct position.
InvalidJavadocTag	Value object for storing data about an invalid Javadoc validTags.
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.
JavadocLeadingAsteriskAlignCheck	Checks the alignment of leading asterisks in a Javadoc comment.
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.
JavadocPackageCheck	Checks that each Java package has a Javadoc file used for commenting.
JavadocParagraphCheck	Checks the Javadoc paragraph.
JavadocStyleCheck	Validates Javadoc comments to help ensure they are well formed.
JavadocTag	Represents a Javadoc tag.
JavadocTagContinuationIndentationCheck	Checks the indentation of the continuation lines in block tags.
JavadocTags	Value object for combining the list of valid validTags with information about invalid validTags encountered in a certain Javadoc comment.
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.
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.
TagParser	Helper class used to parse HTML tags or generic type identifiers from a single-line of text.
TagParser.Point	Represents current position in the text.
WriteTagCheck	Requires user defined Javadoc tag to be present in Javadoc comment with defined format.

Enum Summary

Enum	Description
JavadocContentLocationOption	Represents the locations for the javadoc content.
JavadocTagInfo	This enum defines the various Javadoc tags and their properties.
JavadocTagInfo.Type	The Javadoc Type.