com.puppycrawl.tools.checkstyle.checks.javadoc

Class JavadocTypeCheck

Implemented Interfaces:
Configurable, Contextualizable

public class JavadocTypeCheck
extends Check

Checks the Javadoc of a type.
Version:
1.1
Authors:
Oliver Burn
Michael Tamm

Method Summary

int[]
getDefaultTokens()
void
setAllowMissingParamTags(boolean aFlag)
Controls whether to allow a type which has type parameters to omit matching param tags in the javadoc.
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

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

setAllowMissingParamTags

public void setAllowMissingParamTags(boolean aFlag)
Controls whether to allow a type which has type parameters to omit matching param tags in the javadoc. Defaults to false.
Parameters:
aFlag - a Boolean value

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