Tag List Report

The following document contains the listing of user tags found in the code. Below is the summary of the occurrences per tag.

Tag Class Total number of occurrences Tag strings used by tag class
Todo Work 6 todo, FIXME

Each tag is detailed below:

Todo Work

Number of occurrences found in the code: 6

com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck Line
do differently in future // violation 56
do differently in future // OK 57
do differently in future // violation 71
do differently in future // OK 72
handle x = 0 case // violation 73
com.puppycrawl.tools.checkstyle.filters.SuppressionXpathFilter Line
Comment </li> <li> TrailingComment </li> <li> UnnecessaryParentheses </li> <li> VariableDeclarationUsageDistance </li> </ul> <p> Certain Checks are partially supported by the filter: </p> <ul> <li> PackageDeclaration (until <a href="https://github.com/checkstyle/checkstyle/pull/8110">#8110</a>) </li> </ul> <p> Also, the filter does not support suppressions inside javadoc reported by Javadoc checks: </p> <ul id="SuppressionXpathFilter_JavadocChecks"> <li> AtclauseOrder </li> <li> JavadocBlockTagLocation </li> <li> JavadocMissingWhitespaceAfterAsterisk </li> <li> JavadocParagraph </li> <li> JavadocStyle </li> <li> JavadocTagContinuationIndentation </li> <li> JavadocType </li> <li> MissingDeprecated </li> <li> NonEmptyAtclauseDescription </li> <li> SingleLineJavadoc </li> <li> SummaryJavadoc </li> <li> WriteTag </li> </ul> <p> Note, that support for these Checks will be available after resolving issues <a href="https://github.com/checkstyle/checkstyle/issues/5770">#5770</a> and <a href="https://github.com/checkstyle/checkstyle/issues/5777">#5777</a>. Support for Indentation check will be available after resolving issue <a href="https://github.com/checkstyle/checkstyle/issues/7734">#7734</a>. </p> <p> Currently, filter supports the following xpath axes: </p> <ul> <li> ancestor </li> <li> ancestor-or-self </li> <li> attribute </li> <li> child </li> <li> descendant </li> <li> descendant-or-self </li> <li> following </li> <li> following-sibling </li> <li> parent </li> <li> preceding </li> <li> preceding-sibling </li> <li> self </li> </ul> <p> You can use the command line helper tool to generate xpath suppressions based on your configuration file and input files. See <a href="https://checkstyle.org/cmdline.html">here</a> for more details. </p> <p> The suppression file location is checked in following order: </p> <ol> <li> as a filesystem location </li> <li> if no file found, and the location starts with either {@code http://} or {@code https://}, then it is interpreted as a URL </li> <li> if no file found, then passed to the {@code ClassLoader.getResource()} method. </li> </ol> <p> SuppressionXpathFilter can suppress Checks that have Treewalker as parent module. </p> <ul> <li> Property {@code file} - Specify the location of the <em>suppressions XML document</em> file. Default value is {@code null}. </li> <li> Property {@code optional} - Control what to do when the file is not existing. If optional is set to false the file must exist, or else it ends with error. On the other hand if optional is true and file is not found, the filter accepts all audit events. Default value is {@code false}. </li> </ul> <p> For example, the following configuration fragment directs the Checker to use a {@code SuppressionXpathFilter} with suppressions file {@code config/suppressions.xml}: </p> <pre> &lt;module name=&quot;SuppressionXpathFilter&quot;&gt; &lt;property name=&quot;file&quot; value=&quot;config/suppressions.xml&quot;/&gt; &lt;property name=&quot;optional&quot; value=&quot;false&quot;/&gt; &lt;/module&gt; </pre> <p> A <a href="https://checkstyle.org/dtds/suppressions_1_2_xpath_experimental.dtd"><em> suppressions XML document</em></a> contains a set of {@code suppress} and {@code suppress-xpath} elements, where each {@code suppress-xpath} element can have the following attributes: </p> <ul> <li> {@code files} - a <a href="https://checkstyle.org/property_types.html#regexp">Regular Expression</a> matched against the file name associated with an audit event. It is optional. </li> <li> {@code checks} - a <a href="https://checkstyle.org/property_types.html#regexp">Regular Expression</a> matched against the name of the check associated with an audit event. Optional as long as {@code id} or {@code message} is specified. </li> <li> {@code message} - a <a href="https://checkstyle.org/property_types.html#regexp">Regular Expression</a> matched against the message of the check associated with an audit event. Optional as long as {@code checks} or {@code id} is specified. </li> <li> {@code id} - a <a href="https://checkstyle.org/property_types.html#string">string</a> matched against the ID of the check associated with an audit event. Optional as long as {@code checks} or {@code message} is specified. </li> <li> {@code query} - a <a href="https://checkstyle.org/property_types.html#string">string</a> xpath query. It is optional. </li> </ul> <p> Each audit event is checked against each {@code suppress} and {@code suppress-xpath} element. It is suppressed if all specified attributes match against the audit event. </p> <p> ATTENTION: filtering by message is dependant on runtime locale. If project is running in different languages it is better to avoid filtering by message. </p> <p> The following suppressions XML document directs a {@code SuppressionXpathFilter} to reject {@code CyclomaticComplexity} violations for all methods with name <i>sayHelloWorld</i> inside <i>FileOne</i> and <i>FileTwo</i> files: </p> <p> Currently, xpath queries support one type of attribute {@code @text}. {@code @text} - addresses to the text value of the node. For example: variable name, annotation name, text content and etc. Only the following token types support {@code @text} attribute: {@code TokenTypes.IDENT}, {@code TokenTypes.STRING_LITERAL}, {@code TokenTypes.CHAR_LITERAL}, {@code TokenTypes.NUM_LONG}, {@code TokenTypes.NUM_INT}, {@code TokenTypes.NUM_DOUBLE}, {@code TokenTypes.NUM_FLOAT}. These token types were selected because only their text values are different in content from token type and represent text value from file and can be used in xpath queries for more accurate results. Other token types always have constant values. </p> <pre> &lt;?xml version=&quot;1.0&quot;?&gt; 73