com.puppycrawl.tools.checkstyle.checks.javadoc

Class SummaryJavadocCheck

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.AbstractJavadocCheck

com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class SummaryJavadocCheck
extends AbstractJavadocCheck

Checks that Javadoc summary sentence does not contain phrases that are not recommended to use. By default Check validate that first sentence is not empty:

 <module name="SummaryJavadocCheck"/>
 

To ensure that summary do not contain phrase like "This method returns", use following config:

 <module name="SummaryJavadocCheck">
     <property name="forbiddenSummaryFragments"
     value="^This method returns.*"/>
 </module>
 

To specify period symbol at the end of first javadoc sentence - use following config:

 <module name="SummaryJavadocCheck">
     <property name="period"
     value="period"/>
 </module>
 

Author:

max, Aleksey Nesterenko

Field Summary

Fields

Modifier and Type	Field and Description
static String	SUMMARY_FIRST_SENTENCE A key is pointing to the warning message text in "messages.properties" file.
static String	SUMMARY_JAVADOC A key is pointing to the warning message text in "messages.properties" file.

Fields inherited from class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck

PARSE_ERROR_MESSAGE_KEY, UNRECOGNIZED_ANTLR_ERROR_MESSAGE_KEY

Constructor Summary

Constructors

Constructor and Description
SummaryJavadocCheck()

Method Summary

Modifier and Type	Method and Description
int[]	getAcceptableTokens() The configurable token set.
int[]	getDefaultJavadocTokens() Returns the default token types a check is interested in.
int[]	getRequiredTokens() The tokens that this check must be registered for.
void	setForbiddenSummaryFragments(String pattern) Sets custom value of regular expression for forbidden summary fragments.
void	setPeriod(String period) Sets value of period symbol at the end of first javadoc sentence.
void	visitJavadocToken(DetailNode ast) Called to process a Javadoc token.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck

beginJavadocTree, beginTree, finishJavadocTree, finishTree, getBlockCommentAst, getDefaultTokens, isCommentNodesRequired, leaveJavadocToken, visitToken

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

destroy, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, 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

SUMMARY_FIRST_SENTENCE

public static final String SUMMARY_FIRST_SENTENCE

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

SUMMARY_JAVADOC

public static final String SUMMARY_JAVADOC

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

Constructor Detail

SummaryJavadocCheck

public SummaryJavadocCheck()

Method Detail

setForbiddenSummaryFragments

public void setForbiddenSummaryFragments(String pattern)

Sets custom value of regular expression for forbidden summary fragments.

Parameters:

pattern - user's value.

setPeriod

public void setPeriod(String period)

Sets value of period symbol at the end of first javadoc sentence.

Parameters:

period - period's value.

getDefaultJavadocTokens

public int[] getDefaultJavadocTokens()

Description copied from class: AbstractJavadocCheck

Returns the default token types a check is interested in.

Specified by:

getDefaultJavadocTokens in class AbstractJavadocCheck

Returns:

the default token types

See Also:

JavadocTokenTypes

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

visitJavadocToken

public void visitJavadocToken(DetailNode ast)

Description copied from class: AbstractJavadocCheck

Called to process a Javadoc token.

Specified by:

visitJavadocToken in class AbstractJavadocCheck

Parameters:

ast - the token to process