public class JavadocParagraphCheck extends AbstractJavadocCheck
The check can be specified by option allowNewlineParagraph, which says whether the <p> tag should be placed immediately before the first word.
Default configuration:
<module name="JavadocParagraph"/>
To allow newlines and spaces immediately after the <p> tag:
<module name="JavadocParagraph"> <property name="allowNewlineParagraph" value=="false"/> </module">
In case of allowNewlineParagraph set to false the following example will not have any violations:
/** * <p> * Some Javadoc. * * <p> Some Javadoc. * * <p> * <pre> * Some preformatted Javadoc. * </pre> * */
Modifier and Type | Field and Description |
---|---|
private boolean |
allowNewlineParagraph
Whether the <p> tag should be placed immediately before the first word.
|
static java.lang.String |
MSG_LINE_BEFORE
A key is pointing to the warning message text in "messages.properties"
file.
|
static java.lang.String |
MSG_MISPLACED_TAG
A key is pointing to the warning message text in "messages.properties"
file.
|
static java.lang.String |
MSG_REDUNDANT_PARAGRAPH
A key is pointing to the warning message text in "messages.properties"
file.
|
static java.lang.String |
MSG_TAG_AFTER
A key is pointing to the warning message text in "messages.properties"
file.
|
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 and Description |
---|
JavadocParagraphCheck() |
Modifier and Type | Method and Description |
---|---|
private void |
checkEmptyLine(DetailNode newline)
Determines whether or not the next line after empty line has paragraph tag in the beginning.
|
private void |
checkParagraphTag(DetailNode tag)
Determines whether or not the line with paragraph tag has previous empty line.
|
int[] |
getDefaultJavadocTokens()
Returns the default javadoc token types a check is interested in.
|
private static DetailNode |
getNearestEmptyLine(DetailNode node)
Finds and returns nearest empty line in javadoc.
|
private static DetailNode |
getNearestNode(DetailNode node)
Returns nearest node.
|
int[] |
getRequiredJavadocTokens()
The javadoc tokens that this check must be registered for.
|
private static boolean |
isEmptyLine(DetailNode newLine)
Determines whether or not the line is empty line.
|
private static boolean |
isFirstParagraph(DetailNode paragraphTag)
Determines whether or not the line with paragraph tag is first line in javadoc.
|
private static boolean |
isImmediatelyFollowedByText(DetailNode tag)
Tests whether the paragraph tag is immediately followed by the text.
|
private static boolean |
isLastEmptyLine(DetailNode newLine)
Tests if NEWLINE node is a last node in javadoc.
|
void |
setAllowNewlineParagraph(boolean value)
Sets allowNewlineParagraph.
|
void |
visitJavadocToken(DetailNode ast)
Called to process a Javadoc token.
|
beginJavadocTree, beginTree, finishJavadocTree, finishTree, getAcceptableJavadocTokens, getAcceptableTokens, getBlockCommentAst, getDefaultTokens, getRequiredTokens, init, isCommentNodesRequired, leaveJavadocToken, setJavadocTokens, visitToken
destroy, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public static final java.lang.String MSG_TAG_AFTER
public static final java.lang.String MSG_LINE_BEFORE
public static final java.lang.String MSG_REDUNDANT_PARAGRAPH
public static final java.lang.String MSG_MISPLACED_TAG
private boolean allowNewlineParagraph
public void setAllowNewlineParagraph(boolean value)
value
- value to set.public int[] getDefaultJavadocTokens()
AbstractJavadocCheck
getDefaultJavadocTokens
in class AbstractJavadocCheck
JavadocTokenTypes
public int[] getRequiredJavadocTokens()
AbstractJavadocCheck
getRequiredJavadocTokens
in class AbstractJavadocCheck
JavadocTokenTypes
public void visitJavadocToken(DetailNode ast)
AbstractJavadocCheck
visitJavadocToken
in class AbstractJavadocCheck
ast
- the token to processprivate void checkEmptyLine(DetailNode newline)
newline
- NEWLINE node.private void checkParagraphTag(DetailNode tag)
tag
- html tag.private static DetailNode getNearestNode(DetailNode node)
node
- DetailNode node.private static boolean isEmptyLine(DetailNode newLine)
newLine
- NEWLINE node.private static boolean isFirstParagraph(DetailNode paragraphTag)
paragraphTag
- paragraph tag.private static DetailNode getNearestEmptyLine(DetailNode node)
node
- DetailNode node.private static boolean isLastEmptyLine(DetailNode newLine)
newLine
- NEWLINE node.private static boolean isImmediatelyFollowedByText(DetailNode tag)
tag
- html tag.