|
|||||||||||
| 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
Checks the Javadoc of a type.
By default, does not check for author or version tags.
The scope to verify is specified using the Scope class and
defaults to Scope.PRIVATE. To verify another scope,
set property scope to one of the Scope constants.
To define the format for an author tag or a version tag,
set property authorFormat or versionFormat respectively to a
regular expression.
An example of how to configure the check is:
<module name="JavadocType"/>
An example of how to configure the check for the
Scope.PUBLIC scope is:
<module name="JavadocType">
<property name="scope" value="public"/>
</module>
An example of how to configure the check for an author tag and a version tag is:
<module name="JavadocType">
<property name="authorFormat" value="\S"/>
<property name="versionFormat" value="\S"/>
</module>
An example of how to configure the check for a CVS revision version tag is:
<module name="JavadocType">
<property name="versionFormat" value="\$Revision.*\$"/>
</module>
| Constructor Summary | |
JavadocTypeCheck()
|
|
| Method Summary | |
int[] |
getDefaultTokens()
Returns the default token a check is interested in. |
void |
setAuthorFormat(java.lang.String aFormat)
Set the author tag pattern. |
void |
setExcludeScope(java.lang.String aScope)
Set the excludeScope. |
void |
setScope(java.lang.String aFrom)
Sets the scope to check. |
void |
setVersionFormat(java.lang.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 |
getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, 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(java.lang.String aFrom)
aFrom - string to set scope frompublic void setExcludeScope(java.lang.String aScope)
aScope - a String value
public void setAuthorFormat(java.lang.String aFormat)
throws org.apache.commons.beanutils.ConversionException
aFormat - a String value
org.apache.commons.beanutils.ConversionException - unable to parse aFormat
public void setVersionFormat(java.lang.String aFormat)
throws org.apache.commons.beanutils.ConversionException
aFormat - a String value
org.apache.commons.beanutils.ConversionException - unable to parse aFormatpublic int[] getDefaultTokens()
Check
getDefaultTokens in class CheckCheckpublic void visitToken(DetailAST aAST)
Check
visitToken in class CheckaAST - the token to processCheck
|
Back to the Checkstyle Home Page | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||