com.puppycrawl.tools.checkstyle.checks.javadoc

Class JavadocVariableCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class JavadocVariableCheck
extends AbstractCheck

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

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

To configure the default check:

 <module name="JavadocVariable"/>
 

To configure the check for public scope:

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

To configure the check for members which are in private, but not in protected scope:

 <module name="JavadocVariable">
   <property name="scope" value="private"/>
   <property name="excludeScope" value="protected"/>
 </module>
 

To ignore absence of Javadoc comments for variables with names log or logger:

 <module name="JavadocVariable">
   <property name="ignoreNamePattern" value="log|logger"/>
 </module>
 

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• javadoc.missing

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_JAVADOC_MISSING A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
JavadocVariableCheck()

Method Summary

Modifier and Type	Method and Description
int[]	getAcceptableTokens() The configurable token set.
int[]	getDefaultTokens() Returns the default token a check is interested in.
int[]	getRequiredTokens() The tokens that this check must be registered for.
void	setExcludeScope(Scope excludeScope) Setter to specify the visibility scope where Javadoc comments are not checked.
void	setIgnoreNamePattern(Pattern pattern) Setter to specify the regexp to define variable names to ignore.
void	setScope(Scope scope) Setter to specify the visibility scope where Javadoc comments are checked.
void	visitToken(DetailAST ast) Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

beginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MSG_JAVADOC_MISSING

public static final String MSG_JAVADOC_MISSING

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

Constructor Detail

JavadocVariableCheck

public JavadocVariableCheck()

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.

setIgnoreNamePattern

public void setIgnoreNamePattern(Pattern pattern)

Setter to specify the regexp to define variable names to ignore.

Parameters:

pattern - a pattern.

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:

TokenTypes

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

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:

TokenTypes

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