|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectcom.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.Check
com.puppycrawl.tools.checkstyle.checks.javadoc.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>
| Constructor Summary | |
JavadocVariableCheck()
|
|
| Method Summary | |
int[] |
getDefaultTokens()
Returns the default token a check is interested in. |
void |
setExcludeScope(java.lang.String aScope)
Set the excludeScope. |
void |
setScope(java.lang.String aFrom)
Sets the scope to check. |
void |
visitToken(DetailAST aAST)
Called to process a token. |
| Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check |
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens |
| Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter |
getMessageBundle, getSeverity, getSeverityLevel, 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 |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public JavadocVariableCheck()
| Method Detail |
public void setScope(java.lang.String aFrom)
aFrom - string to get the scope frompublic void setExcludeScope(java.lang.String aScope)
aScope - a String valuepublic int[] getDefaultTokens()
Check
getDefaultTokens in class CheckCheckpublic void visitToken(DetailAST aAST)
Check
visitToken in class CheckaAST - the token to processCheck
|
Back to the Checkstyle Home Page | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||