Class MissingJavadocTypeCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class MissingJavadocTypeCheck
    extends AbstractCheck

    Checks for missing Javadoc comments for class, enum, interface, and annotation interface definitions. The scope to verify is specified using the Scope class and defaults to Scope.PUBLIC. To verify another scope, set property scope to one of the Scope constants.

    • Property scope - specify the visibility scope where Javadoc comments are checked. Type is com.puppycrawl.tools.checkstyle.api.Scope. Default value is public.
    • 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 skipAnnotations - specify 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 to make sure all public class, enum, interface, and annotation interface, definitions have javadocs:

     <module name="MissingJavadocType"/>
     

    Example:

     public class PublicClass {} // violation
     private class PublicClass {}
     protected class PublicClass {}
     class PackagePrivateClass {}
     

    To configure the check for private scope:

     <module name="MissingJavadocType">
       <property name="scope" value="private"/>
     </module>
     

    Example:

     public class PublicClass {} // violation
     private class PublicClass {} // violation
     protected class PublicClass {} // violation
     class PackagePrivateClass {} // violation
     

    To configure the check for private classes only:

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

    Example:

     public class PublicClass {}
     private class PublicClass {} // violation
     protected class PublicClass {}
     class PackagePrivateClass {}
     

    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="MissingJavadocType">
       <property name="skipAnnotations" value="SpringBootApplication,Configuration"/>
     </module>
     

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • javadoc.missing
    Since:
    8.20
    • Field Detail

      • 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.
      • skipAnnotations

        private Set<String> skipAnnotations
        Specify annotations that allow missed documentation. 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.
      • setSkipAnnotations

        public void setSkipAnnotations​(String... userAnnotations)
        Setter to specify annotations that allow missed documentation. 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.