com.puppycrawl.tools.checkstyle.checks.javadoc

Class JavadocStyleCheck

Implemented Interfaces:
Configurable, Contextualizable

public class JavadocStyleCheck
extends Check

Custom Checkstyle Check to validate Javadoc. The following checks are performed:

These checks were patterned after the checks made by the doclet com.sun.tools.doclets.doccheck.DocCheck

Version:
1.2

Authors:
Chris Stillwell
Daniel Grenner

Method Summary

int[]
getDefaultTokens()
The default tokens this Check is used for.
void
setCheckEmptyJavadoc(boolean aFlag)
Sets the flag that determines if empty JavaDoc checking should be done.
void
setCheckFirstSentence(boolean aFlag)
Sets the flag that determines if the first sentence is checked for proper end of sentence punctuation.
void
setCheckHtml(boolean aFlag)
Sets the flag that determines if HTML checking is to be performed.
void
setExcludeScope(String aScope)
Set the excludeScope.
void
setScope(String aFrom)
Sets the scope to check.
void
visitToken(DetailAST aAST)
Called to process a token.

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()
The default tokens this Check is used for.
Overrides:
getDefaultTokens in interface Check

See Also:
Check.getDefaultTokens()


setCheckEmptyJavadoc

public void setCheckEmptyJavadoc(boolean aFlag)
Sets the flag that determines if empty JavaDoc checking should be done.

Parameters:
aFlag - true if empty JavaDoc checking should be done.


setCheckFirstSentence

public void setCheckFirstSentence(boolean aFlag)
Sets the flag that determines if the first sentence is checked for proper end of sentence punctuation.

Parameters:
aFlag - true if the first sentence is to be checked


setCheckHtml

public void setCheckHtml(boolean aFlag)
Sets the flag that determines if HTML checking is to be performed.

Parameters:
aFlag - true if HTML checking is to be performed.


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 get the scope from


visitToken

public void visitToken(DetailAST aAST)
Called to process a token.
Overrides:
visitToken in interface Check

See Also:
Check