com.puppycrawl.tools.checkstyle.checks.javadoc

Class JavadocVariableCheck

public class JavadocVariableCheck extends Check

Checks that a variable has Javadoc comment.

Version: 1.0

Author: Oliver Burn

Method Summary
int[]getDefaultTokens()
{@inheritDoc}
voidsetExcludeScope(String aScope)
Set the excludeScope.
voidsetScope(String aFrom)
Sets the scope to check.
voidvisitToken(DetailAST aAST)
{@inheritDoc}

Method Detail

getDefaultTokens

public int[] getDefaultTokens()
{@inheritDoc}

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)
{@inheritDoc}