Class SingleLineJavadocCheck
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
-
- com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
- com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
- com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
-
- com.puppycrawl.tools.checkstyle.checks.javadoc.SingleLineJavadocCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class SingleLineJavadocCheck extends AbstractJavadocCheck
Checks that a JavaDoc block can fit on a single line and doesn't contain at-clauses. Javadoc comment that contains at least one at-clause should be formatted in a few lines.
All inline at-clauses are ignored by default.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>
-
-
Field Summary
Fields Modifier and Type Field 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.-
Fields inherited from class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
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 Summary
Constructors Constructor Description SingleLineJavadocCheck()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.-
Methods inherited from class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
beginJavadocTree, beginTree, finishJavadocTree, finishTree, getAcceptableJavadocTokens, getAcceptableTokens, getBlockCommentAst, getDefaultTokens, getRequiredTokens, init, isCommentNodesRequired, leaveJavadocToken, setJavadocTokens, visitToken
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
destroy, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, leaveToken, 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
-
-
-
-
Field Detail
-
MSG_KEY
public static final java.lang.String MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
ignoredTags
private java.util.List<java.lang.String> ignoredTags
Allows to specify a list of tags to be ignored by check.
-
ignoreInlineTags
private boolean ignoreInlineTags
Whether inline tags must be ignored.
-
-
Method Detail
-
setIgnoredTags
public void setIgnoredTags(java.lang.String... tags)
Sets a list of tags to be ignored by check.- Parameters:
tags
- to be ignored by check.
-
setIgnoreInlineTags
public void setIgnoreInlineTags(boolean ignoreInlineTags)
Sets whether inline tags must be ignored.- Parameters:
ignoreInlineTags
- whether inline tags must be ignored.
-
getDefaultJavadocTokens
public int[] getDefaultJavadocTokens()
Description copied from class:AbstractJavadocCheck
Returns the default javadoc token types a check is interested in.- Specified by:
getDefaultJavadocTokens
in classAbstractJavadocCheck
- Returns:
- the default javadoc token types
- See Also:
JavadocTokenTypes
-
getRequiredJavadocTokens
public int[] getRequiredJavadocTokens()
Description copied from class:AbstractJavadocCheck
The javadoc tokens that this check must be registered for.- Overrides:
getRequiredJavadocTokens
in classAbstractJavadocCheck
- Returns:
- the javadoc token set this must be registered for.
- See Also:
JavadocTokenTypes
-
visitJavadocToken
public void visitJavadocToken(DetailNode ast)
Description copied from class:AbstractJavadocCheck
Called to process a Javadoc token.- Specified by:
visitJavadocToken
in classAbstractJavadocCheck
- Parameters:
ast
- the token to process
-
isSingleLineJavadoc
private static boolean isSingleLineJavadoc(DetailAST blockCommentStart)
Checks if comment is single line comment.- Parameters:
blockCommentStart
- the AST tree in which a block comment starts- Returns:
- true, if comment is single line comment.
-
hasJavadocTags
private boolean hasJavadocTags(DetailNode javadocRoot)
Checks if comment has javadoc tags which are not ignored. Also works on custom tags. As block tags can be interpreted only at the beginning of a line, only the first instance is checked.- Parameters:
javadocRoot
- javadoc root node.- Returns:
- true, if comment has javadoc tags which are not ignored.
- See Also:
- Block and inline tags
-
hasJavadocInlineTags
private boolean hasJavadocInlineTags(DetailNode javadocRoot)
Checks if comment has in-line tags which are not ignored.- Parameters:
javadocRoot
- javadoc root node.- Returns:
- true, if comment has in-line tags which are not ignored.
- See Also:
- JavadocTags
-
isTagIgnored
private boolean isTagIgnored(DetailNode javadocTagSection)
Checks if list of ignored tags contains javadocTagSection's javadoc tag.- Parameters:
javadocTagSection
- to check javadoc tag in.- Returns:
- true, if ignoredTags contains javadocTagSection's javadoc tag.
-
-