| Package | Description |
|---|---|
| com.puppycrawl.tools.checkstyle.checks.annotation |
Contains the Annotation checks that are
bundled with the main distribution.
|
| com.puppycrawl.tools.checkstyle.checks.javadoc |
Contains the Javadoc checks that are bundled with the main distribution.
|
| com.puppycrawl.tools.checkstyle.meta |
Contains module metadata generation classes for checkstyle.
|
| Modifier and Type | Class and Description |
|---|---|
class |
MissingDeprecatedCheck
Verifies that the annotation
@Deprecated and the Javadoc tag
@deprecated are both present when either of them is present. |
| Modifier and Type | Class and Description |
|---|---|
class |
AtclauseOrderCheck
Checks the order of
javadoc block-tags or javadoc tags.
|
class |
JavadocBlockTagLocationCheck
Checks that a
javadoc block tag appears only at the beginning of a line, ignoring
leading asterisks and white space.
|
class |
JavadocMissingLeadingAsteriskCheck
Checks if the javadoc has
leading asterisks on each line.
|
class |
JavadocMissingWhitespaceAfterAsteriskCheck
Checks that there is at least one whitespace after the leading asterisk.
|
class |
JavadocParagraphCheck
Checks the Javadoc paragraph.
|
class |
JavadocTagContinuationIndentationCheck
Checks the indentation of the continuation lines in block tags.
|
class |
NonEmptyAtclauseDescriptionCheck
Checks that the block tag is followed by description.
|
class |
RequireEmptyLineBeforeBlockTagGroupCheck
Checks that one blank line before the block tag if it is present in Javadoc.
|
class |
SingleLineJavadocCheck
Checks that a Javadoc block can fit in a single line and doesn't contain block tags.
|
class |
SummaryJavadocCheck
Checks that
Javadoc summary sentence does not contain phrases that are not recommended to use.
|
| Modifier and Type | Class and Description |
|---|---|
class |
JavadocMetadataScraper
Class for scraping module metadata from the corresponding class' class-level javadoc.
|
Copyright © 2001-2020. All Rights Reserved.