Class JavadocTypeCheck

Checks the Javadoc comments for annotation/enum/class/interface definitions. By default, does not check for author or version tags. The scope to verify is specified using the Scope class and defaults to Scope.PRIVATE. To verify another scope, set property scope to one of the Scope constants. To define the format for an author tag or a version tag, set property authorFormat or versionFormat respectively to a regular expression.

Does not perform checks for author and version tags for inner classes, as they should be redundant because of outer class.

Error messages about type parameters for which no param tags are present can be suppressed by defining property allowMissingParamTags.

• Property scope - Specify the visibility scope where Javadoc comments are checked. Type is com.puppycrawl.tools.checkstyle.api.Scope. Default value is private.
• Property excludeScope - Specify the visibility scope where Javadoc comments are not checked. Type is com.puppycrawl.tools.checkstyle.api.Scope. Default value is null.
• Property authorFormat - Specify the pattern for @author tag. Type is java.util.regex.Pattern. Default value is null.
• Property versionFormat - Specify the pattern for @version tag. Type is java.util.regex.Pattern. Default value is null.
• Property allowMissingParamTags - Control whether to ignore violations when a class has type parameters but does not have matching param tags in the Javadoc. Type is boolean. Default value is false.
• Property allowUnknownTags - Control whether to ignore violations when a Javadoc tag is not recognised. Type is boolean. Default value is false.
• Property allowedAnnotations - Specify the list of annotations that allow missed documentation. Only short names are allowed, e.g. Generated. Type is java.lang.String[]. Default value is Generated.
• Property tokens - tokens to check Type is java.lang.String[]. Validation type is tokenSet. Default value is: INTERFACE_DEF, CLASS_DEF, ENUM_DEF, ANNOTATION_DEF, RECORD_DEF.

To configure the default check:

 <module name="JavadocType"/>
 

To configure the check for public scope:

 <module name="JavadocType">
   <property name="scope" value="public"/>
 </module>
 

To configure the check for an @author tag:

 <module name="JavadocType">
   <property name="authorFormat" value="\S"/>
 </module>
 

To configure the check for a CVS revision version tag:

 <module name="JavadocType">
   <property name="versionFormat" value="\$Revision.*\$"/>
 </module>
 

To configure the check for private classes only:

 <module name="JavadocType">
   <property name="scope" value="private"/>
   <property name="excludeScope" value="package"/>
 </module>
 

Example that allows missing comments for classes annotated with @SpringBootApplication and @Configuration:

 @SpringBootApplication // no violations about missing comment on class
 public class Application {}

 @Configuration // no violations about missing comment on class
 class DatabaseConfiguration {}
 

Use following configuration:

 <module name="JavadocType">
   <property name="allowedAnnotations" value="SpringBootApplication,Configuration"/>
 </module>
 

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• javadoc.unknownTag
• javadoc.unusedTag
• javadoc.unusedTagGeneral
• type.missingTag
• type.tagFormat