Class AtclauseOrderCheck
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.AtclauseOrderCheck
- All Implemented Interfaces:
Configurable
,Contextualizable
Checks the order of javadoc block-tags or javadoc tags.
Note: Google used the term "at-clauses" for block tags in their guide till 2017-02-28.
-
Property
violateExecutionOnNonTightHtml
- Control when to print violations if the Javadoc being examined by this check violates the tight html rules defined at Tight-HTML Rules. Type isboolean
. Default value isfalse
. -
Property
target
- Specify the list of block tags targeted. Type isjava.lang.String[]
. Validation type istokenTypesSet
. Default value is CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF, RECORD_DEF, COMPACT_CTOR_DEF. -
Property
tagOrder
- Specify the order by tags. Type isjava.lang.String[]
. Default value is@author, @deprecated, @exception, @param, @return, @see, @serial, @serialData, @serialField, @since, @throws, @version
.
To configure the default check:
<module name="AtclauseOrder"/>
Example:
/** * Some javadoc. // OK * * @author Some javadoc. // OK * @version Some javadoc. // OK * @param Some javadoc. // OK * @return Some javadoc. // OK * @throws Some javadoc. // OK * @exception Some javadoc. // OK * @see Some javadoc. // OK * @since Some javadoc. // OK * @serial Some javadoc. // OK * @serialField // OK * @serialData // OK * @deprecated Some javadoc. // OK */ class Valid implements Serializable { } /** * Some javadoc. * * @since Some javadoc. // OK * @version Some javadoc. // Violation - wrong order * @deprecated * @see Some javadoc. // Violation - wrong order * @author Some javadoc. // Violation - wrong order */ class Invalid implements Serializable { }
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
at.clause.order
-
javadoc.missed.html.close
-
javadoc.parse.rule.error
-
javadoc.wrong.singleton.html.tag
- Since:
- 6.0
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String[]
Default order of atclauses.static final String
A key is pointing to the warning message text in "messages.properties" file.Specify the order by tags.Specify the list of block tags targeted.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
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate void
checkOrderInTagSection
(DetailNode javadoc) Checks order of atclauses in tag section node.int[]
Returns the default javadoc token types a check is interested in.private static int
getParentType
(DetailAST commentBlock) Returns type of parent node.int[]
The javadoc tokens that this check must be registered for.void
setTagOrder
(String... orders) Setter to specify the order by tags.void
Setter to specify the list of block tags targeted.void
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, visitToken
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
clearViolations, getFileContents, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild
-
Field Details
-
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
DEFAULT_ORDER
Default order of atclauses. -
target
Specify the list of block tags targeted. -
tagOrder
Specify the order by tags.
-
-
Constructor Details
-
AtclauseOrderCheck
public AtclauseOrderCheck()
-
-
Method Details
-
setTarget
Setter to specify the list of block tags targeted.- Parameters:
targets
- user's targets.
-
setTagOrder
Setter to specify the order by tags.- Parameters:
orders
- user's orders.
-
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:
-
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:
-
visitJavadocToken
Description copied from class:AbstractJavadocCheck
Called to process a Javadoc token.- Specified by:
visitJavadocToken
in classAbstractJavadocCheck
- Parameters:
ast
- the token to process
-
checkOrderInTagSection
Checks order of atclauses in tag section node.- Parameters:
javadoc
- Javadoc root node.
-
getParentType
Returns type of parent node.- Parameters:
commentBlock
- child node.- Returns:
- parent type.
-