Package com.puppycrawl.tools.checkstyle.checks.javadoc

Class JavadocTypeCheck

java.lang.Object
com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
All Implemented Interfaces:
Configurable, Contextualizable
public class JavadocTypeCheck extends AbstractCheck
Checks the Javadoc comments for type 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 pattern.

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

Does not perform checks for type definitions that do not have any Javadoc comments.

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

  • 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 annotations that allow skipping validation at all. Only short names are allowed, e.g. Generated. Type is java.lang.String[]. Default value is Generated.
  • Property authorFormat - Specify the pattern for @author tag. Type is java.util.regex.Pattern. Default value is null.
  • 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 scope - Specify the visibility scope where Javadoc comments are checked. Type is com.puppycrawl.tools.checkstyle.api.Scope. Default value is private.
  • Property versionFormat - Specify the pattern for @version tag. Type is java.util.regex.Pattern. Default value is null.
  • 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.

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

  • Constructor Details

  • Method Details

    • setScope

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

    • setExcludeScope

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

    • setAuthorFormat

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

    • setVersionFormat

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

    • 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
      Since:
      4.0

    • 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
      Since:
      5.1

    • setAllowedAnnotations

      public void setAllowedAnnotations(String... userAnnotations)
      Setter to specify annotations that allow skipping validation at all. Only short names are allowed, e.g. Generated.
      Parameters:
      userAnnotations - user's value.
      Since:
      8.15

    • 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

    • shouldCheck

      private boolean shouldCheck(DetailAST ast)
      Whether we should check this node.
      Parameters:
      ast - a given node.
      Returns:
      whether we should check a given node.

    • getJavadocTags

      private List<JavadocTag> getJavadocTags(TextBlock textBlock)
      Gets all standalone tags from a given javadoc.
      Parameters:
      textBlock - the Javadoc comment to process.
      Returns:
      all standalone tags from the given javadoc.

    • checkTag

      private void checkTag(DetailAST ast, Iterable<JavadocTag> tags, String tagName, Pattern formatPattern)
      Verifies that a type definition has a required tag.
      Parameters:
      ast - the AST node for the type definition.
      tags - tags from the Javadoc comment for the type definition.
      tagName - the required tag name.
      formatPattern - regexp for the tag value.

    • checkComponentParamTag

      private void checkComponentParamTag(DetailAST ast, Collection<JavadocTag> tags, String recordComponentName)
      Verifies that a record definition has the specified param tag for the specified record component name.
      Parameters:
      ast - the AST node for the record definition.
      tags - tags from the Javadoc comment for the record definition.
      recordComponentName - the name of the type parameter

    • checkTypeParamTag

      private void checkTypeParamTag(DetailAST ast, Collection<JavadocTag> tags, String typeParamName)
      Verifies that a type definition has the specified param tag for the specified type parameter name.
      Parameters:
      ast - the AST node for the type definition.
      tags - tags from the Javadoc comment for the type definition.
      typeParamName - the name of the type parameter

    • checkUnusedParamTags

      private void checkUnusedParamTags(List<JavadocTag> tags, List<String> typeParamNames, List<String> recordComponentNames)
      Checks for unused param tags for type parameters and record components.
      Parameters:
      tags - tags from the Javadoc comment for the type definition
      typeParamNames - names of type parameters
      recordComponentNames - record component names in this definition

    • extractParamNameFromTag

      private static String extractParamNameFromTag(JavadocTag tag)
      Extracts parameter name from tag.
      Parameters:
      tag - javadoc tag to extract parameter name
      Returns:
      extracts type parameter name from tag

    • getRecordComponentNames

      private static List<String> getRecordComponentNames(DetailAST node)
      Collects the record components in a record definition.
      Parameters:
      node - the possible record definition ast.
      Returns:
      the record components in this record definition.