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

Class 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 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 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 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"/>

    Example: 

     /**
  * @author a
  * @version $Revision1$
  */
 public class ClassA { // OK
     /** */
     private class ClassB {} // OK
 }

 /**
  * @author
  * @version abc
  * @unknownTag value // violation
  */
 public class ClassC {} // OK

 /** */
 public class ClassD<T> {} // violation, as param tag for <T> is missing

 /** */
 private class ClassE<T> {} // violation, as param tag for <T> is missing

 /** */
 @Generated
 public class ClassF<T> {} // OK

    To configure the check for public scope: 

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

    Example: 

     /**
  * @author a
  * @version $Revision1$
  */
 public class ClassA { // OK
     /** */
     private class ClassB {} // OK
 }

 /**
  * @author
  * @version abc
  * @unknownTag value // violation
  */
 public class ClassC {} // OK

 /** */
 public class ClassD<T> {} // violation, as param tag for <T> is missing

 /** */
 private class ClassE<T> {} // OK

 /** */
 @Generated
 public class ClassF<T> {} // OK

    To configure the check for an @author tag: 

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

    Example: 

     /**
  * @author a
  * @version $Revision1$
  */
 public class ClassA { // OK
     /** */
     private class ClassB {} // OK, as author tag check is ignored for inner class
 }

 /**
  * @author
  * @version abc
  * @unknownTag value // violation
  */
 public class ClassC {} // violation, as author format with only whitespace or new line is invalid

 /** */
 public class ClassD {} // violation, as author tag is missing

 /** */
 private class ClassE {} // violation, as author tag is missing

 /** */
 @Generated
 public class ClassF<T> {} // OK

    To configure the check for a CVS revision version tag: 

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

    Example: 

     /**
  * @author a
  * @version $Revision1$
  */
 public class ClassA { // OK
     /** */
     private class ClassB {} // OK, as version tag check is ignored for inner class
 }

 /**
  * @author
  * @version abc
  * @unknownTag value // violation
  */
 public class ClassC {} // violation, as version format is invalid

 /** */
 public class ClassD {} // violation, as version tag is missing

 /** */
 private class ClassE {} // violation, as version tag is missing

 /** */
 @Generated
 public class ClassF<T> {} // OK

    To configure the check for private classes only: 

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

    Example: 

     /**
  * @author a
  * @version $Revision1$
  */
 public class ClassA { // OK
     /** */
     private class ClassB {} // OK
 }

 /**
  * @author
  * @version abc
  * @unknownTag value // OK
  */
 public class ClassC {} // OK

 /** */
 public class ClassD<T> {} // OK

 /** */
 private class ClassE<T> {} // violation, as param tag for <T> is missing

 /** */
 @Generated
 public class ClassF<T> {} // OK

    To configure the check that allows missing @param tags: 

     <module name="JavadocType">
   <property name="allowMissingParamTags" value="true"/>
 </module>

    Example: 

     /**
  * @author a
  * @version $Revision1$
  */
 public class ClassA { // OK
     /** */
     private class ClassB {} // OK
 }

 /**
  * @author
  * @version abc
  * @unknownTag value // violation
  */
 public class ClassC {} // OK

 /** */
 public class ClassD<T> {} // OK, as missing param tag is allowed

 /** */
 private class ClassE<T> {} // OK, as missing param tag is allowed

 /** */
 @Generated
 public class ClassF<T> {} // OK

    To configure the check that allows unknown tags: 

     <module name="JavadocType">
   <property name="allowUnknownTags" value="true"/>
 </module>

    Example: 

     /**
  * @author a
  * @version $Revision1$
  */
 public class ClassA { // OK
     /** */
     private class ClassB {} // OK
 }

 /**
  * @author
  * @version abc
  * @unknownTag value // OK, as unknown tag is allowed
  */
 public class ClassC {} // OK

 /** */
 public class ClassD {} // OK

 /** */
 private class ClassE {} // OK

 /** */
 @Generated
 public class ClassF<T> {} // OK

    To configure a check that allows skipping validation at all for classes annotated with @SpringBootApplication and @Configuration: 

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

    Example: 

     /** */
 @SpringBootApplication // no violations about missing param tag on class
 public class Application<T> {}

 /** */
 @Configuration // no violations about missing param tag on class
 class DatabaseConfiguration<T> {}

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • javadoc.unknownTag
    • javadoc.unusedTag
    • javadoc.unusedTagGeneral
    • type.missingTag
    • type.tagFormat
    Since:
    3.0

    • Field Detail

      • MSG_UNKNOWN_TAG

        public static final java.lang.String MSG_UNKNOWN_TAG
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

      • MSG_TAG_FORMAT

        public static final java.lang.String MSG_TAG_FORMAT
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

      • MSG_MISSING_TAG

        public static final java.lang.String MSG_MISSING_TAG
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

      • MSG_UNUSED_TAG

        public static final java.lang.String MSG_UNUSED_TAG
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

      • TYPE_NAME_IN_JAVADOC_TAG

        private static final java.util.regex.Pattern TYPE_NAME_IN_JAVADOC_TAG
        Pattern to match type name within angle brackets in javadoc param tag.

      • TYPE_NAME_IN_JAVADOC_TAG_SPLITTER

        private static final java.util.regex.Pattern TYPE_NAME_IN_JAVADOC_TAG_SPLITTER
        Pattern to split type name field in javadoc param tag.

      • scope

        private Scope scope
        Specify the visibility scope where Javadoc comments are checked.

      • excludeScope

        private Scope excludeScope
        Specify the visibility scope where Javadoc comments are not checked.

      • authorFormat

        private java.util.regex.Pattern authorFormat
        Specify the pattern for @author tag.

      • versionFormat

        private java.util.regex.Pattern versionFormat
        Specify the pattern for @version tag.

      • allowMissingParamTags

        private boolean allowMissingParamTags
        Control whether to ignore violations when a class has type parameters but does not have matching param tags in the Javadoc.

      • allowUnknownTags

        private boolean allowUnknownTags
        Control whether to ignore violations when a Javadoc tag is not recognised.

      • allowedAnnotations

        private java.util.Set<java.lang.String> allowedAnnotations
        Specify annotations that allow skipping validation at all. Only short names are allowed, e.g. Generated.

    • Method Detail

      • 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​(java.util.regex.Pattern pattern)
        Setter to specify the pattern for @author tag.
        Parameters:
        pattern - a pattern.

      • setVersionFormat

        public void setVersionFormat​(java.util.regex.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​(java.lang.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.

      • 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:
        TokenTypes

      • 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 java.util.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,
                      java.lang.Iterable<JavadocTag> tags,
                      java.lang.String tagName,
                      java.util.regex.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,
                                    java.util.Collection<JavadocTag> tags,
                                    java.lang.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,
                               java.util.Collection<JavadocTag> tags,
                               java.lang.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​(java.util.List<JavadocTag> tags,
                                  java.util.List<java.lang.String> typeParamNames,
                                  java.util.List<java.lang.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 java.lang.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 java.util.List<java.lang.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.