com.puppycrawl.tools.checkstyle.checks.javadoc

Class JavadocTypeCheck

public class JavadocTypeCheck extends Check

Checks the Javadoc of a type.

Version: 1.1

Author: 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)

Method Detail

getDefaultTokens

public int[] getDefaultTokens()

{@inheritDoc }

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)

Set the author tag pattern.

Parameters: aFormat a String value

Throws: ConversionException unable to parse aFormat

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)

Set the version format pattern.

Parameters: aFormat a String value

Throws: ConversionException unable to parse aFormat

visitToken

public void visitToken(DetailAST aAST)

{@inheritDoc }