Class JavadocVariableCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class JavadocVariableCheck
    extends AbstractCheck

    Checks that a variable has a Javadoc comment. Ignores serialVersionUID fields.

    • 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 ignoreNamePattern - Specify the regexp to define variable names to ignore. Type is java.util.regex.Pattern. 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 tokens - tokens to check Type is java.lang.String[]. Validation type is tokenSet. Default value is: ENUM_CONSTANT_DEF.

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • javadoc.missing
    Since:
    3.0
    • Method Detail

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

        public void setIgnoreNamePattern​(Pattern pattern)
        Setter to specify the regexp to define variable names to ignore.
        Parameters:
        pattern - a pattern.
        Since:
        5.8
      • 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
      • isIgnored

        private boolean isIgnored​(DetailAST ast)
        Decides whether the variable name of an AST is in the ignore list.
        Parameters:
        ast - the AST to check
        Returns:
        true if the variable name of ast is in the ignore list.
      • 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.