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

Class MissingJavadocMethodCheck

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.MissingJavadocMethodCheck
All Implemented Interfaces:
Configurable, Contextualizable
public class MissingJavadocMethodCheck extends AbstractCheck
Checks for missing Javadoc comments for a method or constructor. The scope to verify is specified using the Scope class and defaults to Scope.PUBLIC. To verify another scope, set property scope to a different scope.

Javadoc is not required on a method that is tagged with the @Override annotation. However, under Java 5 it is not possible to mark a method required for an interface (this was corrected under Java 6). Hence, Checkstyle supports using the convention of using a single {@inheritDoc} tag instead of all the other tags.

For getters and setters for the property allowMissingPropertyJavadoc, the methods must match exactly the structures below. 

 public void setNumber(final int number)
 {
     mNumber = number;
 }

 public int getNumber()
 {
     return mNumber;
 }

 public boolean isSomething()
 {
     return false;
 }
  • Property allowMissingPropertyJavadoc - Control whether to allow missing Javadoc on accessor methods for properties (setters and getters). Type is boolean. Default value is false.
  • Property allowedAnnotations - Configure annotations that allow missed documentation. Type is java.lang.String[]. Default value is Override.
  • 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 ignoreMethodNamesRegex - Ignore method whose names are matching specified regex. Type is java.util.regex.Pattern. Default value is null.
  • Property minLineCount - Control the minimal amount of lines in method to allow no documentation. Type is int. Default value is -1.
  • Property scope - Specify the visibility scope where Javadoc comments are checked. Type is com.puppycrawl.tools.checkstyle.api.Scope. Default value is public.
  • Property tokens - tokens to check Type is java.lang.String[]. Validation type is tokenSet. Default value is: METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF.

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

  • javadoc.missing
Since:
8.21

  • Field Details

  • Constructor Details

  • Method Details

    • setAllowedAnnotations

      public void setAllowedAnnotations(String... userAnnotations)
      Setter to configure annotations that allow missed documentation.
      Parameters:
      userAnnotations - user's value.
      Since:
      8.21

    • setIgnoreMethodNamesRegex

      public void setIgnoreMethodNamesRegex(Pattern pattern)
      Setter to ignore method whose names are matching specified regex.
      Parameters:
      pattern - a pattern.
      Since:
      8.21

    • setMinLineCount

      public void setMinLineCount(int value)
      Setter to control the minimal amount of lines in method to allow no documentation.
      Parameters:
      value - user's value.
      Since:
      8.21

    • setAllowMissingPropertyJavadoc

      public void setAllowMissingPropertyJavadoc(boolean flag)
      Setter to control whether to allow missing Javadoc on accessor methods for properties (setters and getters).
      Parameters:
      flag - a Boolean value
      Since:
      8.21

    • setScope

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

    • setExcludeScope

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

    • getRequiredTokens

      public final 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:

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

    • visitToken

      public final 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

    • getMethodsNumberOfLine

      private static int getMethodsNumberOfLine(DetailAST methodDef)
      Some javadoc.
      Parameters:
      methodDef - Some javadoc.
      Returns:
      Some javadoc.

    • isMissingJavadocAllowed

      private boolean isMissingJavadocAllowed(DetailAST ast)
      Checks if a missing Javadoc is allowed by the check's configuration.
      Parameters:
      ast - the tree node for the method or constructor.
      Returns:
      True if this method or constructor doesn't need Javadoc.

    • isContentsAllowMissingJavadoc

      private boolean isContentsAllowMissingJavadoc(DetailAST ast)
      Checks if the Javadoc can be missing if the method or constructor is below the minimum line count or has a special annotation.
      Parameters:
      ast - the tree node for the method or constructor.
      Returns:
      True if this method or constructor doesn't need Javadoc.

    • matchesSkipRegex

      private boolean matchesSkipRegex(DetailAST methodDef)
      Checks if the given method name matches the regex. In that case we skip enforcement of javadoc for this method
      Parameters:
      methodDef - METHOD_DEF
      Returns:
      true if given method name matches the regex.

    • shouldCheck

      private boolean shouldCheck(DetailAST ast, Scope nodeScope)
      Whether we should check this node.
      Parameters:
      ast - a given node.
      nodeScope - the scope of the node.
      Returns:
      whether we should check a given node.

    • isGetterMethod

      public static boolean isGetterMethod(DetailAST ast)
      Returns whether an AST represents a getter method.
      Parameters:
      ast - the AST to check with
      Returns:
      whether the AST represents a getter method

    • isSetterMethod

      public static boolean isSetterMethod(DetailAST ast)
      Returns whether an AST represents a setter method.
      Parameters:
      ast - the AST to check with
      Returns:
      whether the AST represents a setter method