Class SingleLineJavadocCheck
java.lang.Object
com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
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
Checks that a Javadoc block can fit in a single-line and doesn't contain block tags.
Javadoc comment that contains at least one block tag should be formatted in a few lines.
- Since:
- 6.0
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
AbstractAutomaticBean.OutputStreamOptions -
Field Summary
FieldsModifier and TypeFieldDescriptionSpecify block tags which are ignored by the check.private booleanControl whether inline tags must be ignored.static final StringA 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_PARSE_RULE_ERROR, MSG_KEY_UNCLOSED_HTML_TAG -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint[]Returns the default javadoc token types a check is interested in.int[]The javadoc tokens that this check must be registered for.private booleanhasJavadocInlineTags(DetailNode javadocRoot) Checks if comment has in-line tags which are not ignored.private booleanhasJavadocTags(DetailNode javadocRoot) Checks if comment has javadoc tags which are not ignored.private static booleanisSingleLineJavadoc(DetailAST blockCommentStart) Checks if comment is single-line comment.private booleanisTagIgnored(DetailNode javadocTagSection) Checks if list of ignored tags contains javadocTagSection's javadoc tag.voidsetIgnoredTags(String... tags) Setter to specify block tags which are ignored by the check.voidsetIgnoreInlineTags(boolean ignoreInlineTags) Setter to control whether inline tags must be ignored.voidvisitJavadocToken(DetailNode ast) Called to process a Javadoc token.Methods inherited from class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
acceptJavadocWithNonTightHtml, beginJavadocTree, beginTree, destroy, finishJavadocTree, finishTree, getAcceptableJavadocTokens, getAcceptableTokens, getBlockCommentAst, getDefaultTokens, getRequiredTokens, init, isCommentNodesRequired, leaveJavadocToken, setJavadocTokens, setViolateExecutionOnNonTightHtml, visitTokenMethods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
clearViolations, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, leaveToken, log, log, log, setFileContents, setTabWidth, setTokensMethods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityMethods inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
configure, contextualize, getConfiguration, setupChild
-
Field Details
-
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
ignoredTags
Specify block tags which are ignored by the check. -
ignoreInlineTags
Control whether inline tags must be ignored.
-
-
Constructor Details
-
SingleLineJavadocCheck
public SingleLineJavadocCheck ()
-
-
Method Details
-
setIgnoredTags
Setter to specify block tags which are ignored by the check.- Parameters:
tags- to be ignored by check.- Since:
- 6.8
-
setIgnoreInlineTags
Setter to control whether inline tags must be ignored.- Parameters:
ignoreInlineTags- whether inline tags must be ignored.- Since:
- 6.8
-
getDefaultJavadocTokens
Description copied from class:AbstractJavadocCheckReturns the default javadoc token types a check is interested in.- Specified by:
getDefaultJavadocTokensin classAbstractJavadocCheck- Returns:
- the default javadoc token types
- See Also:
-
getRequiredJavadocTokens
Description copied from class:AbstractJavadocCheckThe javadoc tokens that this check must be registered for.- Overrides:
getRequiredJavadocTokensin classAbstractJavadocCheck- Returns:
- the javadoc token set this must be registered for.
- See Also:
-
visitJavadocToken
Description copied from class:AbstractJavadocCheckCalled to process a Javadoc token.- Specified by:
visitJavadocTokenin classAbstractJavadocCheck- Parameters:
ast- the token to process
-
isSingleLineJavadoc
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
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:
-
hasJavadocInlineTags
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:
-
isTagIgnored
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.
-