Javadoc Comments Checks
AtclauseOrder | Checks the order of javadoc block-tags or javadoc tags. |
InvalidJavadocPosition | Checks that Javadocs are located at the correct position. |
JavadocBlockTagLocation | Checks that a javadoc block tag appears only at the beginning of a line, ignoring leading asterisks and white space. |
JavadocContentLocation | Checks that the Javadoc content begins from the same position for all Javadoc comments in the project. |
JavadocLeadingAsteriskAlign | Checks the alignment of leading asterisks in a Javadoc comment. |
JavadocMethod | Checks the Javadoc of a method or constructor. |
JavadocMissingLeadingAsterisk | Checks if the javadoc has leading asterisks on each line. |
JavadocMissingWhitespaceAfterAsterisk | Checks that there is at least one whitespace after the leading asterisk. |
JavadocPackage | Checks that each Java package has a Javadoc file used for commenting. |
JavadocParagraph | Checks the Javadoc paragraph. |
JavadocStyle | Validates Javadoc comments to help ensure they are well formed. |
JavadocTagContinuationIndentation | Checks the indentation of the continuation lines in block tags. |
JavadocType | Checks the Javadoc comments for type definitions. |
JavadocVariable | Checks that a variable has a Javadoc comment. |
MissingJavadocMethod | Checks for missing Javadoc comments for a method or constructor. |
MissingJavadocPackage | Checks for missing package definition Javadoc comments in package-info.java files. |
MissingJavadocType | Checks for missing Javadoc comments for class, enum, interface, and annotation interface definitions. |
NonEmptyAtclauseDescription | Checks that the block tag is followed by description. |
RequireEmptyLineBeforeBlockTagGroup | Checks that one blank line before the block tag if it is present in Javadoc. |
SingleLineJavadoc | Checks that a Javadoc block can fit in a single-line and doesn't contain block tags. |
SummaryJavadoc | Checks that Javadoc summary sentence does not contain phrases that are not recommended to use. |
WriteTag | Requires user defined Javadoc tag to be present in Javadoc comment with defined format. |