com.puppycrawl.tools.checkstyle.checks.javadoc

Class JavadocParagraphCheck

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

All Implemented Interfaces:

Configurable, Contextualizable

public class JavadocParagraphCheck
extends AbstractJavadocCheck

Checks that:

• There is one blank line between each of two paragraphs and one blank line before the at-clauses block if it is present.
• Each paragraph but the first has <p> immediately before the first word, with no space after.

Default configuration:

 <module name="JavadocParagraph"/>
 

Author:

maxvetrenko

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_LINE_BEFORE A key is pointing to the warning message text in "messages.properties" file.
static String	MSG_REDUNDANT_PARAGRAPH A key is pointing to the warning message text in "messages.properties" file.
static String	MSG_TAG_AFTER A key is pointing to the warning message text in "messages.properties" file.

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

PARSE_ERROR_MESSAGE_KEY, UNRECOGNIZED_ANTLR_ERROR_MESSAGE_KEY

Constructor Summary

Constructors

Constructor and Description
JavadocParagraphCheck()

Method Summary

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

Field Detail

MSG_TAG_AFTER

public static final String MSG_TAG_AFTER

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

See Also:

Constant Field Values

MSG_LINE_BEFORE

public static final String MSG_LINE_BEFORE

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

See Also:

Constant Field Values

MSG_REDUNDANT_PARAGRAPH

public static final String MSG_REDUNDANT_PARAGRAPH

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

See Also:

Constant Field Values

Constructor Detail

JavadocParagraphCheck

public JavadocParagraphCheck()

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