|
||||||||||
| 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.JavadocTypeCheck
public class JavadocTypeCheck
Checks the Javadoc of a type.
| Constructor Summary | |
|---|---|
JavadocTypeCheck()
|
|
| Method Summary | |
|---|---|
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. |
| 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 |
|---|
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, 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 JavadocTypeCheck()
| Method Detail |
|---|
public void setScope(String aFrom)
aFrom - string to set scope frompublic void setExcludeScope(String aScope)
aScope - a String value
public void setAuthorFormat(String aFormat)
throws org.apache.commons.beanutils.ConversionException
aFormat - a String value
org.apache.commons.beanutils.ConversionException - unable to parse aFormat
public void setVersionFormat(String aFormat)
throws org.apache.commons.beanutils.ConversionException
aFormat - a String value
org.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 CheckTokenTypespublic void visitToken(DetailAST aAST)
Check
visitToken in class CheckaAST - the token to process
|
Back to the Checkstyle Home Page | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||