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>
 

Author:

max

Constructor Summary

Constructors

Constructor and Description
SummaryJavadocCheck()

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getDefaultJavadocTokens() Returns the default token types a check is interested in.
void	setForbiddenSummaryFragments(String aPattern) Sets custom value of regular expression for forbidden summary fragments.
void	visitJavadocToken(DetailNode aAst) Called to process a Javadoc token.

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

beginJavadocTree, beginTree, finishJavadocTree, finishTree, getAcceptableTokens, getBlockCommentAst, getDefaultTokens, getRequiredTokens, isCommentNodesRequired, leaveJavadocToken, leaveToken, visitToken

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

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

Constructor Detail

SummaryJavadocCheck

public SummaryJavadocCheck()

Method Detail

setForbiddenSummaryFragments

public void setForbiddenSummaryFragments(String aPattern)

Sets custom value of regular expression for forbidden summary fragments.

Parameters:

aPattern - user'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

visitJavadocToken

public void visitJavadocToken(DetailNode aAst)

Description copied from class: AbstractJavadocCheck

Called to process a Javadoc token.

Overrides:

visitJavadocToken in class AbstractJavadocCheck

Parameters:

aAst - the token to process