com.puppycrawl.tools.checkstyle.checks.javadoc
Class JavadocVariableCheck
- Configurable, Contextualizable
public class JavadocVariableCheck
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:
- Oliver Burn
beginTree , destroy , finishTree , getAcceptableTokens , getClassLoader , getDefaultTokens , getFileContents , getLines , getRequiredTokens , getTabWidth , getTokenNames , init , leaveToken , log , log , setClassLoader , setFileContents , setMessages , setTabWidth , setTokens , visitToken |
getMessageBundle , getSeverity , getSeverityLevel , log , log , log , log , log , log , log , log , log , log , log , setSeverity |
getDefaultTokens
public int[] getDefaultTokens()
- getDefaultTokens in interface Check
Check
setExcludeScope
public void setExcludeScope(String aScope)
Set the excludeScope.
aScope
- a String
value
setScope
public void setScope(String aFrom)
Sets the scope to check.
aFrom
- string to get the scope from