public class SingleLineJavadocCheck extends AbstractJavadocCheck
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>
Modifier and Type | Field and Description |
---|---|
static String |
MSG_KEY
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 |
---|
SingleLineJavadocCheck() |
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.
|
beginJavadocTree, beginTree, finishJavadocTree, finishTree, getBlockCommentAst, getDefaultTokens, isCommentNodesRequired, leaveJavadocToken, visitToken
destroy, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public static final String MSG_KEY
public void setIgnoredTags(String tags)
tags
- to be ignored by check.public void setIgnoreInlineTags(boolean ignoreInlineTags)
ignoreInlineTags
- whether inline tags must be ignored.public int[] getDefaultJavadocTokens()
AbstractJavadocCheck
getDefaultJavadocTokens
in class AbstractJavadocCheck
JavadocTokenTypes
public int[] getAcceptableTokens()
Check
getAcceptableTokens
in class Check
TokenTypes
public int[] getRequiredTokens()
Check
getRequiredTokens
in class Check
TokenTypes
public void visitJavadocToken(DetailNode ast)
AbstractJavadocCheck
visitJavadocToken
in class AbstractJavadocCheck
ast
- the token to processCopyright © 2001–2020. All rights reserved.