Contains the Javadoc checks that are bundled with the main distribution.
Class Summary Class Description AbstractJavadocCheckBase class for Checks that process Javadoc comments. AbstractJavadocCheck.FileContextThe file context holder. AtclauseOrderCheckChecks the order of javadoc block-tags or javadoc tags. HtmlTagUsed to keep track of a tag and the text that follows it. InvalidJavadocPositionCheckChecks that Javadocs are located at the correct position. InvalidJavadocTagValue object for storing data about an invalid Javadoc validTags. JavadocBlockTagLocationCheckChecks that a javadoc block tag appears only at the beginning of a line, ignoring leading asterisks and white space. JavadocContentLocationCheckChecks that the Javadoc content begins from the same position for all Javadoc comments in the project. JavadocMethodCheckChecks the Javadoc of a method or constructor. JavadocMethodCheck.ClassInfoContains class's
JavadocMethodCheck.ExceptionInfoStores useful information about declared exception. JavadocMethodCheck.TokenRepresents text element with location in the text. JavadocMissingLeadingAsteriskCheckChecks if the javadoc has leading asterisks on each line. JavadocMissingWhitespaceAfterAsteriskCheckChecks that there is at least one whitespace after the leading asterisk. JavadocNodeImplImplementation of DetailNode interface that is mutable. JavadocPackageCheckChecks that each Java package has a Javadoc file used for commenting. JavadocParagraphCheckChecks the Javadoc paragraph. JavadocStyleCheckValidates Javadoc comments to help ensure they are well formed. JavadocTagRepresents a Javadoc tag. JavadocTagContinuationIndentationCheckChecks the indentation of the continuation lines in block tags. JavadocTagsValue object for combining the list of valid validTags with information about invalid validTags encountered in a certain Javadoc comment. JavadocTypeCheckChecks the Javadoc comments for type definitions. JavadocVariableCheckChecks that a variable has a Javadoc comment. MissingJavadocMethodCheckChecks for missing Javadoc comments for a method or constructor. MissingJavadocPackageCheckChecks for missing package definition Javadoc comments in package-info.java files. MissingJavadocTypeCheckChecks for missing Javadoc comments for class, enum, interface, and annotation interface definitions. NonEmptyAtclauseDescriptionCheckChecks that the block tag is followed by description. RequireEmptyLineBeforeBlockTagGroupCheckChecks that one blank line before the block tag if it is present in Javadoc. SingleLineJavadocCheckChecks that a Javadoc block can fit in a single-line and doesn't contain block tags. SummaryJavadocCheckChecks that Javadoc summary sentence does not contain phrases that are not recommended to use. TagParserHelper class used to parse HTML tags or generic type identifiers from a single-line of text. TagParser.PointRepresents current position in the text. WriteTagCheckRequires user defined Javadoc tag to be present in Javadoc comment with defined format.
Enum Summary Enum Description JavadocContentLocationOptionRepresents the locations for the javadoc content. JavadocTagInfoThis enum defines the various Javadoc tags and their properties. JavadocTagInfo.TypeThe Javadoc Type.