Class JavadocTypeCheck

All Implemented Interfaces:
Configurable, Contextualizable

public class JavadocTypeCheck extends AbstractCheck

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
Since:
3.0
  • Field Details

    • MSG_UNKNOWN_TAG

      public static final String MSG_UNKNOWN_TAG
      A key is pointing to the warning message text in "messages.properties" file.
      See Also:
    • MSG_TAG_FORMAT

      public static final String MSG_TAG_FORMAT
      A key is pointing to the warning message text in "messages.properties" file.
      See Also:
    • MSG_MISSING_TAG

      public static final String MSG_MISSING_TAG
      A key is pointing to the warning message text in "messages.properties" file.
      See Also:
    • MSG_UNUSED_TAG

      public static final String MSG_UNUSED_TAG
      A key is pointing to the warning message text in "messages.properties" file.
      See Also:
    • MSG_UNUSED_TAG_GENERAL

      public static final String MSG_UNUSED_TAG_GENERAL
      A key is pointing to the warning message text in "messages.properties" file.
      See Also:
  • Constructor Details

    • JavadocTypeCheck

      public JavadocTypeCheck()
  • Method Details

    • setScope

      public void setScope(Scope scope)
      Setter to specify the visibility scope where Javadoc comments are checked.
      Parameters:
      scope - a scope.
    • setExcludeScope

      public void setExcludeScope(Scope excludeScope)
      Setter to specify the visibility scope where Javadoc comments are not checked.
      Parameters:
      excludeScope - a scope.
    • setAuthorFormat

      public void setAuthorFormat(Pattern pattern)
      Setter to specify the pattern for @author tag.
      Parameters:
      pattern - a pattern.
    • setVersionFormat

      public void setVersionFormat(Pattern pattern)
      Setter to specify the pattern for @version tag.
      Parameters:
      pattern - a pattern.
    • setAllowMissingParamTags

      public void setAllowMissingParamTags(boolean flag)
      Setter to control whether to ignore violations when a class has type parameters but does not have matching param tags in the Javadoc.
      Parameters:
      flag - a Boolean value
    • setAllowUnknownTags

      public void setAllowUnknownTags(boolean flag)
      Setter to control whether to ignore violations when a Javadoc tag is not recognised.
      Parameters:
      flag - a Boolean value
    • setAllowedAnnotations

      public void setAllowedAnnotations(String... userAnnotations)
      Setter to specify the list of annotations that allow missed documentation. Only short names are allowed, e.g. Generated.
      Parameters:
      userAnnotations - user's value.
    • getDefaultTokens

      public int[] getDefaultTokens()
      Description copied from class: AbstractCheck
      Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.
      Specified by:
      getDefaultTokens in class AbstractCheck
      Returns:
      the default tokens
      See Also:
    • getAcceptableTokens

      public int[] getAcceptableTokens()
      Description copied from class: AbstractCheck
      The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.
      Specified by:
      getAcceptableTokens in class AbstractCheck
      Returns:
      the token set this check is designed for.
      See Also:
    • getRequiredTokens

      public int[] getRequiredTokens()
      Description copied from class: AbstractCheck
      The tokens that this check must be registered for.
      Specified by:
      getRequiredTokens in class AbstractCheck
      Returns:
      the token set this must be registered for.
      See Also:
    • visitToken

      public void visitToken(DetailAST ast)
      Description copied from class: AbstractCheck
      Called to process a token.
      Overrides:
      visitToken in class AbstractCheck
      Parameters:
      ast - the token to process