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 |
---|---|
private java.util.List<java.lang.String> |
ignoredTags
Allows to specify a list of tags to be ignored by check.
|
private boolean |
ignoreInlineTags
Whether inline tags must be ignored.
|
static java.lang.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[] |
getDefaultJavadocTokens()
Returns the default javadoc token types a check is interested in.
|
int[] |
getRequiredJavadocTokens()
The javadoc tokens that this check must be registered for.
|
private boolean |
hasJavadocInlineTags(DetailNode javadocRoot)
Checks if comment has in-line tags which are not ignored.
|
private boolean |
hasJavadocTags(DetailNode javadocRoot)
Checks if comment has javadoc tags which are not ignored.
|
private static boolean |
isSingleLineJavadoc(DetailAST blockCommentStart)
Checks if comment is single line comment.
|
private boolean |
isTagIgnored(DetailNode javadocTagSection)
Checks if list of ignored tags contains javadocTagSection's javadoc tag.
|
void |
setIgnoredTags(java.lang.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, 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_KEY
private java.util.List<java.lang.String> ignoredTags
private boolean ignoreInlineTags
public void setIgnoredTags(java.lang.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[] getRequiredJavadocTokens()
AbstractJavadocCheck
getRequiredJavadocTokens
in class AbstractJavadocCheck
JavadocTokenTypes
public void visitJavadocToken(DetailNode ast)
AbstractJavadocCheck
visitJavadocToken
in class AbstractJavadocCheck
ast
- the token to processprivate static boolean isSingleLineJavadoc(DetailAST blockCommentStart)
blockCommentStart
- the AST tree in which a block comment startsprivate boolean hasJavadocTags(DetailNode javadocRoot)
javadocRoot
- javadoc root node.private boolean hasJavadocInlineTags(DetailNode javadocRoot)
javadocRoot
- javadoc root node.private boolean isTagIgnored(DetailNode javadocTagSection)
javadocTagSection
- to check javadoc tag in.