com.puppycrawl.tools.checkstyle.checks.javadoc

Class SingleLineJavadocCheck

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

All Implemented Interfaces:

Configurable, Contextualizable

public class SingleLineJavadocCheck
extends AbstractJavadocCheck

Checks that a JavaDoc block can fit on a single line and doesn't contain at-clauses. Javadoc comment that contains at least one at-clause should be formatted in a few lines.
All inline at-clauses are ignored by default.

The Check has the following properties:
ignoredTags - allows to specify a list of at-clauses (including custom at-clauses) to be ignored by the check.
ignoreInlineTags - whether inline at-clauses must be ignored.

Default configuration:

 <module name="SingleLineJavadoc"/>
 

To specify a list of ignored at-clauses and make inline at-clauses not ignored in general:

 <module name="SingleLineJavadoc">
     <property name="ignoredTags" value="@inheritDoc, @link"/>
     <property name="ignoreInlineTags" value="false"/>
 </module>
 

Author:

baratali, maxvetrenko, vladlis

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_KEY 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, MSG_KEY_PARSE_ERROR, MSG_KEY_UNRECOGNIZED_ANTLR_ERROR

Constructor Summary

Constructors

Constructor and Description
SingleLineJavadocCheck()

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	setIgnoredTags(String... tags) Sets a list of tags to be ignored by check.
void	setIgnoreInlineTags(boolean ignoreInlineTags) Sets whether inline tags must be ignored.
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.AbstractCheck

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

MSG_KEY

public static final String MSG_KEY

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

See Also:

Constant Field Values

Constructor Detail

SingleLineJavadocCheck

public SingleLineJavadocCheck()

Method Detail

setIgnoredTags

public void setIgnoredTags(String... tags)

Sets a list of tags to be ignored by check.

Parameters:

tags - to be ignored by check.

setIgnoreInlineTags

public void setIgnoreInlineTags(boolean ignoreInlineTags)

Sets whether inline tags must be ignored.

Parameters:

ignoreInlineTags - whether inline tags must be ignored.

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

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 AbstractCheck

Returns:

the token set this check is designed for.

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: AbstractCheck

The tokens that this check must be registered for.

Overrides:

getRequiredTokens in class AbstractCheck

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