com.puppycrawl.tools.checkstyle.checks.javadoc

Class JavadocTagContinuationIndentationCheck

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

All Implemented Interfaces:

Configurable, Contextualizable

public class JavadocTagContinuationIndentationCheck
extends AbstractJavadocCheck

Checks the indentation of the continuation lines in at-clauses.

Default configuration:

 <module name="JavadocTagContinuationIndentation">
     <property name="offset" value="4"/>
 </module>
 

Author:

max

Constructor Summary

Constructors

Constructor and Description
JavadocTagContinuationIndentationCheck()

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getDefaultJavadocTokens() Returns the default token types a check is interested in.
void	setOffset(int aOffset) Sets custom indentation level.
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

JavadocTagContinuationIndentationCheck

public JavadocTagContinuationIndentationCheck()

Method Detail

setOffset

public void setOffset(int aOffset)

Sets custom indentation level.

Parameters:

aOffset - custom 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