public class JavadocTypeCheck extends Check
Does not perform checks for author and version tags for inner classes, as they should be redundant because of outer class.
Modifier and Type | Field and Description |
---|---|
static String |
MSG_JAVADOC_MISSING
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
MSG_MISSING_TAG
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
MSG_TAG_FORMAT
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
MSG_UNKNOWN_TAG
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
MSG_UNUSED_TAG
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
MSG_UNUSED_TAG_GENERAL
A key is pointing to the warning message text in "messages.properties"
file.
|
Constructor and Description |
---|
JavadocTypeCheck() |
Modifier and Type | Method and Description |
---|---|
int[] |
getAcceptableTokens()
The configurable token set.
|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
int[] |
getRequiredTokens()
The tokens that this check must be registered for.
|
void |
setAllowMissingParamTags(boolean flag)
Controls whether to allow a type which has type parameters to
omit matching param tags in the javadoc.
|
void |
setAllowUnknownTags(boolean flag)
Controls whether to flag errors for unknown tags.
|
void |
setAuthorFormat(String format)
Set the author tag pattern.
|
void |
setExcludeScope(String excludeScope)
Set the excludeScope.
|
void |
setScope(String from)
Sets the scope to check.
|
void |
setVersionFormat(String format)
Set the version format pattern.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public static final String MSG_JAVADOC_MISSING
public static final String MSG_UNKNOWN_TAG
public static final String MSG_TAG_FORMAT
public static final String MSG_MISSING_TAG
public static final String MSG_UNUSED_TAG
public static final String MSG_UNUSED_TAG_GENERAL
public void setScope(String from)
from
- string to set scope frompublic void setExcludeScope(String excludeScope)
excludeScope
- a String
valuepublic void setAuthorFormat(String format)
format
- a String
valuepublic void setVersionFormat(String format)
format
- a String
valuepublic void setAllowMissingParamTags(boolean flag)
flag
- a Boolean
valuepublic void setAllowUnknownTags(boolean flag)
flag
- a Boolean
valuepublic int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public int[] getAcceptableTokens()
Check
getAcceptableTokens
in class Check
TokenTypes
public int[] getRequiredTokens()
Check
getRequiredTokens
in class Check
TokenTypes
public void visitToken(DetailAST ast)
Check
visitToken
in class Check
ast
- the token to processCopyright © 2001–2020. All rights reserved.