Package | Description |
---|---|
com.puppycrawl.tools.checkstyle.api |
Contains the core API to be used to implement checks.
|
com.puppycrawl.tools.checkstyle.checks.javadoc |
Contains the Javadoc checks that are bundled with the main distribution.
|
com.puppycrawl.tools.checkstyle.utils |
Contains utils classes for checkstyle.
|
Modifier and Type | Method and Description |
---|---|
static Scope |
Scope.getInstance(String scopeName)
Scope factory method.
|
static Scope |
Scope.valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static Scope[] |
Scope.values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
Modifier and Type | Method and Description |
---|---|
boolean |
Scope.isIn(Scope scope)
Checks if this scope is a subscope of another scope.
|
Modifier and Type | Method and Description |
---|---|
void |
JavadocMethodCheck.setExcludeScope(Scope excludeScope)
Set the excludeScope.
|
void |
JavadocVariableCheck.setExcludeScope(Scope excludeScope)
Set the excludeScope.
|
void |
JavadocTypeCheck.setExcludeScope(Scope excludeScope)
Set the excludeScope.
|
void |
JavadocStyleCheck.setExcludeScope(Scope excludeScope)
Set the excludeScope.
|
void |
JavadocMethodCheck.setScope(Scope scope)
Set the scope.
|
void |
JavadocVariableCheck.setScope(Scope scope)
Sets the scope to check.
|
void |
JavadocTypeCheck.setScope(Scope scope)
Sets the scope to check.
|
void |
JavadocStyleCheck.setScope(Scope scope)
Sets the scope to check.
|
Modifier and Type | Method and Description |
---|---|
static Scope |
ScopeUtils.getScopeFromMods(DetailAST aMods)
Returns the Scope specified by the modifier set.
|
static Scope |
ScopeUtils.getSurroundingScope(DetailAST node)
Returns the scope of the surrounding "block".
|
Modifier and Type | Method and Description |
---|---|
static boolean |
ScopeUtils.isInScope(DetailAST ast,
Scope scope)
Checks whether ast node is in a specific scope.
|
Copyright © 2001–2018. All rights reserved.