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.Check

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

All Implemented Interfaces:

Configurable, Contextualizable

public class JavadocVariableCheck
extends Check

Checks that a variable has Javadoc comment.

Version:

1.0

Author:

Oliver Burn

Constructor Summary

Constructors

Constructor and Description
JavadocVariableCheck()

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getDefaultTokens() Returns the default token a check is interested in.
String	getIgnoreNamePattern() Gets the variable names to ignore in the check.
void	setExcludeScope(String scope) Set the excludeScope.
void	setIgnoreNamePattern(String regexp) Sets the variable names to ignore in the check.
void	setScope(String from) Sets the scope to check.
void	visitToken(DetailAST ast) Called to process a token.

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

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

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

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

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Constructor Detail

JavadocVariableCheck

public JavadocVariableCheck()

Method Detail

setScope

public void setScope(String from)

Sets the scope to check.

Parameters:

from - string to get the scope from

setExcludeScope

public void setExcludeScope(String scope)

Set the excludeScope.

Parameters:

scope - a String value

setIgnoreNamePattern

public void setIgnoreNamePattern(String regexp)

Sets the variable names to ignore in the check.

Parameters:

regexp - regexp to define variable names to ignore.

getIgnoreNamePattern

public String getIgnoreNamePattern()

Gets the variable names to ignore in the check.

Returns:

true regexp string to define variable names to ignore.

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

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 Check

Returns:

the default tokens

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

ast - the token to process