com.puppycrawl.tools.checkstyle.checks.javadoc

Class JavadocTypeCheck

Implemented Interfaces:
Configurable, Contextualizable

public class JavadocTypeCheck
extends Check

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>
 

Version:
1.1

Authors:
Oliver Burn
Michael Tamm

Method Summary

int[]
getDefaultTokens()
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)

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getDefaultTokens, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getMessageBundle, getSeverity, getSeverityLevel, log, log, 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

Method Details

getDefaultTokens

public int[] getDefaultTokens()
Overrides:
getDefaultTokens in interface Check

See Also:
Check


setAuthorFormat

public void setAuthorFormat(String aFormat)
            throws ConversionException
Set the author tag pattern.

Parameters:
aFormat - a String value


setExcludeScope

public void setExcludeScope(String aScope)
Set the excludeScope.

Parameters:
aScope - a String value


setScope

public void setScope(String aFrom)
Sets the scope to check.

Parameters:
aFrom - string to set scope from


setVersionFormat

public void setVersionFormat(String aFormat)
            throws ConversionException
Set the version format pattern.

Parameters:
aFormat - a String value


visitToken

public void visitToken(DetailAST aAST)
Overrides:
visitToken in interface Check

See Also:
Check