com.puppycrawl.tools.checkstyle.checks.javadoc

Class JavadocVariableCheck

Implemented Interfaces:
Configurable, Contextualizable

public class JavadocVariableCheck
extends Check

Checks that a variable has Javadoc comment. The scope to verify is specified using the Scope class and defaults to Scope.PRIVATE. To verify another scope, set property scope to one of the Scope constants. An example of how to configure the check is:
 <module name="JavadocVariable"/>
 

An example of how to configure the check for the Scope.PUBLIC scope is:

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

Version:
1.0

Author:
Oliver Burn

Method Summary

int[]
getDefaultTokens()
void
setExcludeScope(String aScope)
Set the excludeScope.
void
setScope(String aFrom)
Sets the scope to check.
void
visitToken(DetailAST aAST)

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

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

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

getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, log, log, setSeverity

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Method Details

getDefaultTokens

public int[] getDefaultTokens()
Overrides:
getDefaultTokens in interface Check

See Also:
Check


setExcludeScope

public void setExcludeScope(String aScope)
Set the excludeScope.

Parameters:
aScope - a String value


setScope

public void setScope(String aFrom)
Sets the scope to check.

Parameters:
aFrom - string to get the scope from


visitToken

public void visitToken(DetailAST aAST)
Overrides:
visitToken in interface Check

See Also:
Check