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

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

See: Description

Class Summary

Class	Description
AbstractJavadocCheck	Base class for Checks that process Javadoc comments.
AtclauseOrderCheck	Checks the order of at-clauses.
InvalidJavadocTag	Value object for storing data about an invalid Javadoc validTags.
JavadocMethodCheck	Checks the Javadoc of a method or constructor.
JavadocNodeImpl	Implementation of DetailNode interface that is mutable.
JavadocPackageCheck	Checks that all packages have a package documentation.
JavadocParagraphCheck	Checks that: There is one blank line between each of two paragraphs and one blank line before the at-clauses block if it is present. Each paragraph but the first has <p> immediately before the first word, with no space after.
JavadocStyleCheck	Custom Checkstyle Check to validate Javadoc.
JavadocTag	Represents a Javadoc tag.
JavadocTagContinuationIndentationCheck	Checks the indentation of the continuation lines in at-clauses.
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 of a type.
JavadocUtils	Contains utility methods for working with Javadoc.
JavadocVariableCheck	Checks that a variable has Javadoc comment.
NonEmptyAtclauseDescriptionCheck	Checks that the at-clause tag is followed by description .
SingleLineJavadocCheck	Checks that a JavaDoc block which can fit on a single line and doesn't contain at-clauses.
SummaryJavadocCheck	Checks that Javadoc summary sentence does not contain phrases that are not recommended to use.
WriteTagCheck	Outputs a JavaDoc tag as information.

Enum Summary

Enum	Description
JavadocUtils.JavadocTagType	The type of Javadoc tag we want returned.

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

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