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

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. Check also violate javadoc that does not contain first sentence. 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

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Field Summary

Fields

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

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

MSG_JAVADOC_MISSED_HTML_CLOSE, MSG_JAVADOC_PARSE_RULE_ERROR, MSG_JAVADOC_WRONG_SINGLETON_TAG

Constructor Summary

Constructors

Constructor and Description
SummaryJavadocCheck()

Method Summary

Modifier and Type	Method and Description
int[]	getDefaultJavadocTokens() Returns the default javadoc token types a check is interested in.
int[]	getRequiredJavadocTokens() The javadoc tokens that this check must be registered for.
void	setForbiddenSummaryFragments(Pattern 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

acceptJavadocWithNonTightHtml, beginJavadocTree, beginTree, finishJavadocTree, finishTree, getAcceptableJavadocTokens, getAcceptableTokens, getBlockCommentAst, getDefaultTokens, getRequiredTokens, init, isCommentNodesRequired, leaveJavadocToken, setJavadocTokens, setViolateExecutionOnNonTightHtml, visitToken

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

clearMessages, destroy, getClassLoader, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, leaveToken, log, log, log, setClassLoader, setFileContents, setTabWidth, setTokens

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

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

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

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Field Detail

MSG_SUMMARY_FIRST_SENTENCE

public static final String MSG_SUMMARY_FIRST_SENTENCE

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

See Also:

Constant Field Values

MSG_SUMMARY_JAVADOC

public static final String MSG_SUMMARY_JAVADOC

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

See Also:

Constant Field Values

MSG_SUMMARY_JAVADOC_MISSING

public static final String MSG_SUMMARY_JAVADOC_MISSING

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(Pattern pattern)

Sets custom value of regular expression for forbidden summary fragments.

Parameters:

pattern - a pattern.

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 javadoc token types a check is interested in.

Specified by:

getDefaultJavadocTokens in class AbstractJavadocCheck

Returns:

the default javadoc token types

See Also:

JavadocTokenTypes

getRequiredJavadocTokens

public int[] getRequiredJavadocTokens()

Description copied from class: AbstractJavadocCheck

The javadoc tokens that this check must be registered for.

Overrides:

getRequiredJavadocTokens in class AbstractJavadocCheck

Returns:

the javadoc token set this must be registered for.

See Also:

JavadocTokenTypes

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