public class JavadocTypeCheck extends Check
Constructor and Description |
---|
JavadocTypeCheck() |
Modifier and Type | Method and Description |
---|---|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
void |
setAllowMissingParamTags(boolean aFlag)
Controls whether to allow a type which has type parameters to
omit matching param tags in the javadoc.
|
void |
setAllowUnknownTags(boolean aFlag)
Controls whether to flag errors for unknown tags.
|
void |
setAuthorFormat(String aFormat)
Set the author tag pattern.
|
void |
setExcludeScope(String aScope)
Set the excludeScope.
|
void |
setScope(String aFrom)
Sets the scope to check.
|
void |
setVersionFormat(String aFormat)
Set the version format pattern.
|
void |
visitToken(DetailAST aAST)
Called to process a token.
|
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public void setScope(String aFrom)
aFrom
- string to set scope frompublic void setExcludeScope(String aScope)
aScope
- a String
valuepublic void setAuthorFormat(String aFormat) throws org.apache.commons.beanutils.ConversionException
aFormat
- a String
valueorg.apache.commons.beanutils.ConversionException
- unable to parse aFormatpublic void setVersionFormat(String aFormat) throws org.apache.commons.beanutils.ConversionException
aFormat
- a String
valueorg.apache.commons.beanutils.ConversionException
- unable to parse aFormatpublic void setAllowMissingParamTags(boolean aFlag)
aFlag
- a Boolean
valuepublic void setAllowUnknownTags(boolean aFlag)
aFlag
- a Boolean
valuepublic int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public void visitToken(DetailAST aAST)
Check
visitToken
in class Check
aAST
- the token to processCopyright © 2001-2015. All Rights Reserved.