com.puppycrawl.tools.checkstyle.checks.javadoc

Class JavadocStyleCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.Check

com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class JavadocStyleCheck
extends Check

Custom Checkstyle Check to validate Javadoc.

Author:

Chris Stillwell, Daniel Grenner, Travis Schneeberger

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY Message property key for the Unclosed HTML message.
static String	EXTRA_HTML Message property key for the Extra HTML message.
static String	INCOMPLETE_TAG Message property key for the Unclosed HTML message.
static String	JAVADOC_MISSING Message property key for the Unclosed HTML message.
static String	NO_PERIOD Message property key for the Unclosed HTML message.
static String	UNCLOSED_HTML Message property key for the Unclosed HTML message.

Constructor Summary

Constructors

Constructor and Description
JavadocStyleCheck()

Method Summary

Modifier and Type	Method and Description
int[]	getAcceptableTokens() The configurable token set.
int[]	getDefaultTokens() Returns the default token a check is interested in.
int[]	getRequiredTokens() The tokens that this check must be registered for.
void	setCheckEmptyJavadoc(boolean flag) Sets the flag that determines if empty Javadoc checking should be done.
void	setCheckFirstSentence(boolean flag) Sets the flag that determines if the first sentence is checked for proper end of sentence punctuation.
void	setCheckHtml(boolean flag) Sets the flag that determines if HTML checking is to be performed.
void	setEndOfSentenceFormat(String format) Set the format for matching the end of a sentence.
void	setExcludeScope(String excludeScope) Set the excludeScope.
void	setScope(String from) Sets the scope to check.
void	visitToken(DetailAST ast) Called to process a token.

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

beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

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

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JAVADOC_MISSING

public static final String JAVADOC_MISSING

Message property key for the Unclosed HTML message.

See Also:

Constant Field Values

EMPTY

public static final String EMPTY

Message property key for the Unclosed HTML message.

See Also:

Constant Field Values

NO_PERIOD

public static final String NO_PERIOD

Message property key for the Unclosed HTML message.

See Also:

Constant Field Values

INCOMPLETE_TAG

public static final String INCOMPLETE_TAG

Message property key for the Unclosed HTML message.

See Also:

Constant Field Values

UNCLOSED_HTML

public static final String UNCLOSED_HTML

Message property key for the Unclosed HTML message.

See Also:

Constant Field Values

EXTRA_HTML

public static final String EXTRA_HTML

Message property key for the Extra HTML message.

See Also:

Constant Field Values

Constructor Detail

JavadocStyleCheck

public JavadocStyleCheck()

Method Detail

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

Specified by:

getDefaultTokens in class Check

Returns:

the default tokens

See Also:

TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: Check

The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.

Overrides:

getAcceptableTokens in class Check

Returns:

the token set this check is designed for.

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: Check

The tokens that this check must be registered for.

Overrides:

getRequiredTokens in class Check

Returns:

the token set this must be registered for.

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

ast - the token to process

setScope

public void setScope(String from)

Sets the scope to check.

Parameters:

from - string to get the scope from

setExcludeScope

public void setExcludeScope(String excludeScope)

Set the excludeScope.

Parameters:

excludeScope - a String value

setEndOfSentenceFormat

public void setEndOfSentenceFormat(String format)

Set the format for matching the end of a sentence.

Parameters:

format - format for matching the end of a sentence.

setCheckFirstSentence

public void setCheckFirstSentence(boolean flag)

Sets the flag that determines if the first sentence is checked for proper end of sentence punctuation.

Parameters:

flag - true if the first sentence is to be checked

setCheckHtml

public void setCheckHtml(boolean flag)

Sets the flag that determines if HTML checking is to be performed.

Parameters:

flag - true if HTML checking is to be performed.

setCheckEmptyJavadoc

public void setCheckEmptyJavadoc(boolean flag)

Sets the flag that determines if empty Javadoc checking should be done.

Parameters:

flag - true if empty Javadoc checking should be done.