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>
getDefaultTokens
public int[] getDefaultTokens()
- getDefaultTokens in interface Check
Check
setAuthorFormat
public void setAuthorFormat(String aFormat)
throws ConversionException Set the author tag pattern.
aFormat - a String value
setExcludeScope
public void setExcludeScope(String aScope)
Set the excludeScope.
aScope - a String value
setScope
public void setScope(String aFrom)
Sets the scope to check.
aFrom - string to set scope from
setVersionFormat
public void setVersionFormat(String aFormat)
throws ConversionException Set the version format pattern.
aFormat - a String value