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.AbstractTypeAwareCheck Deprecated. Checkstyle is not type aware tool and all Checks derived from this class are potentially unstable.AbstractTypeAwareCheck.AbstractClassInfo Contains class'sToken
.AbstractTypeAwareCheck.Token Represents text element with location in the text.AtclauseOrderCheck Checks the order of javadoc block-tags or javadoc tags.ClassResolver Utility class to resolve a class name to an actual class.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.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 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 JavadocTagInfo This enum defines the various Javadoc tags and there properties.JavadocTagInfo.Type The Javadoc Type.