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

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 which 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 few lines. Default configuration:

 <module name="SingleLineJavadoc"/>
 

Author:

baratali, maxvetrenko

Constructor Summary

Constructors

Constructor and Description
SingleLineJavadocCheck()

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getDefaultJavadocTokens() Returns the default token types a check is interested in.
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, 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

SingleLineJavadocCheck

public SingleLineJavadocCheck()

Method Detail

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 ast)

Description copied from class: AbstractJavadocCheck

Called to process a Javadoc token.

Overrides:

visitJavadocToken in class AbstractJavadocCheck

Parameters:

ast - the token to process