Modified: maven/website/components/plugins-archives/maven-checkstyle-plugin-LATEST/checkstyle-aggregate-mojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-checkstyle-plugin-LATEST/checkstyle-aggregate-mojo.html (original) +++ maven/website/components/plugins-archives/maven-checkstyle-plugin-LATEST/checkstyle-aggregate-mojo.html Sun Jun 2 14:48:29 2024 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 1.11.1 from target\generated-site\xdoc/checkstyle-aggregate-mojo.xml at 2023-10-21 + | Generated by Apache Maven Doxia Site Renderer 1.11.1 from org.apache.maven.plugins:maven-plugin-report-plugin:3.12.0:report at 2024-06-02 | Rendered using Apache Maven Fluido Skin 1.11.2 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> @@ -49,8 +49,8 @@ <li><a href="../index.html" title="Plugins">Plugins</a><span class="divider">/</span></li> <li><a href="index.html" title="Apache Maven Checkstyle Plugin">Apache Maven Checkstyle Plugin</a><span class="divider">/</span></li> <li class="active ">checkstyle:checkstyle-aggregate</li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-10-21</li> - <li id="projectVersion" class="pull-right">Version: 3.3.1</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-06-02</li> + <li id="projectVersion" class="pull-right">Version: 3.4.0</li> </ul> </div> </header> @@ -117,1078 +117,539 @@ </div> </header> <main id="bodyColumn" class="span10" > - - - <section> -<h2><a name="checkstyle:checkstyle-aggregate"></a>checkstyle:checkstyle-aggregate</h2> - -<p><b>Note</b>:This goal should be used as a Maven report.</p> - -<p><b>Full name</b>:</p> - -<p>org.apache.maven.plugins:maven-checkstyle-plugin:3.3.1:checkstyle-aggregate</p> - -<p><b>Description</b>:</p> - -<div>A reporting task that performs Checkstyle analysis and generates an aggregate HTML report on the violations that Checkstyle finds in a multi-module reactor build.</div> - -<p><b>Attributes</b>:</p> - +<section> +<h2><a name="checkstyle:checkstyle-aggregate"></a>checkstyle:checkstyle-aggregate</h2><a name="checkstyle:checkstyle-aggregate"></a> +<p><strong>Note</strong>:</p> +<p>This goal should be used as a Maven report.</p> +<p><strong>Full name</strong>:</p> +<p>org.apache.maven.plugins:maven-checkstyle-plugin:3.4.0:checkstyle-aggregate</p> +<p><strong>Description</strong>:</p> +<p>A reporting task that performs Checkstyle analysis and generates an aggregate HTML report on the violations that Checkstyle finds in a multi-module reactor build.</p> +<p><strong>Attributes</strong>:</p> <ul> - <li>Requires a Maven project to be executed.</li> - <li>Executes as an aggregator goal.</li> - <li>Requires dependency resolution of artifacts in scope: <code>compile</code>.</li> - <li>The goal is thread-safe and supports parallel builds.</li> - -<li>Since version: <code>2.0</code>.</li> - </ul> - <section> -<h3><a name="Required_Parameters"></a>Required Parameters</h3> - +<li>Since version: <code>2.0</code>.</li></ul><section> +<h3><a name="Required_Parameters"></a>Required Parameters</h3><a name="Required_Parameters"></a> <table border="0" class="table table-striped"> - <tr class="a"> - <th>Name</th> - <th>Type</th> - <th>Since</th> - -<th>Description</th> - </tr> - +<th>Description</th></tr> <tr class="b"> - -<td align="left"><code><a href="#includeResources"><includeResources></a></code></td> - +<td align="left"><a href="#includeResources"><code><includeResources></code></a></td> <td><code>boolean</code></td> - <td><code>2.11</code></td> - -<td>Specifies whether to include the resource directories in the check.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>checkstyle.includeResources</code>.<br /></td> - </tr> - +<td>Specifies whether to include the resource directories in the check.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>checkstyle.includeResources</code></td></tr> <tr class="a"> - -<td align="left"><code><a href="#includes"><includes></a></code></td> - -<td><code>String</code></td> - -<td><code>-</code></td> - -<td>Specifies the names filter of the source files to be used for Checkstyle.<br /><b>Default value is</b>: <code>**\/*.java</code>.<br /><b>User property is</b>: <code>checkstyle.includes</code>.<br /></td> - </tr> - -<tr class="b"> - -<td align="left"><code><a href="#includeTestResources"><includeTestResources></a></code></td> - +<td align="left"><a href="#includeTestResources"><code><includeTestResources></code></a></td> <td><code>boolean</code></td> - <td><code>2.11</code></td> - -<td>Specifies whether to include the test resource directories in the check.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>checkstyle.includeTestResources</code>.<br /></td> - </tr> - +<td>Specifies whether to include the test resource directories in the check.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>checkstyle.includeTestResources</code></td></tr> +<tr class="b"> +<td align="left"><a href="#includes"><code><includes></code></a></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>Specifies the names filter of the source files to be used for Checkstyle.<br /><strong>Default</strong>: <code>**\/*.java</code><br /><strong>User Property</strong>: <code>checkstyle.includes</code></td></tr> <tr class="a"> - -<td align="left"><code><a href="#resourceIncludes"><resourceIncludes></a></code></td> - +<td align="left"><a href="#resourceIncludes"><code><resourceIncludes></code></a></td> <td><code>String</code></td> - <td><code>2.11</code></td> - -<td>Specifies the names filter of the resource files to be used for Checkstyle.<br /><b>Default value is</b>: <code>**/*.properties</code>.<br /><b>User property is</b>: <code>checkstyle.resourceIncludes</code>.<br /></td> - </tr> - </table> - </section> - <section> -<h3><a name="Optional_Parameters"></a>Optional Parameters</h3> - +<td>Specifies the names filter of the resource files to be used for Checkstyle.<br /><strong>Default</strong>: <code>**/*.properties</code><br /><strong>User Property</strong>: <code>checkstyle.resourceIncludes</code></td></tr></table></section><section> +<h3><a name="Optional_Parameters"></a>Optional Parameters</h3><a name="Optional_Parameters"></a> <table border="0" class="table table-striped"> - <tr class="a"> - <th>Name</th> - <th>Type</th> - <th>Since</th> - -<th>Description</th> - </tr> - +<th>Description</th></tr> <tr class="b"> - -<td align="left"><code><a href="#cacheFile"><cacheFile></a></code></td> - +<td align="left"><a href="#cacheFile"><code><cacheFile></code></a></td> <td><code>String</code></td> - <td><code>-</code></td> - -<td>Specifies the cache file used to speed up Checkstyle on successive runs.<br /><b>Default value is</b>: <code>${project.build.directory}/checkstyle-cachefile</code>.<br /></td> - </tr> - +<td>Specifies the cache file used to speed up Checkstyle on successive runs.<br /><strong>Default</strong>: <code>${project.build.directory}/checkstyle-cachefile</code></td></tr> <tr class="a"> - -<td align="left"><code><a href="#checkstyleRules"><checkstyleRules></a></code></td> - +<td align="left"><a href="#checkstyleRules"><code><checkstyleRules></code></a></td> <td><code>PlexusConfiguration</code></td> - <td><code>2.12</code></td> - <td>By using this property, you can specify the whole Checkstyle rules inline directly inside this pom. - -<div> <pre> <plugin> ... <configuration> <checkstyleRules> - <module name="Checker"> - <module name="FileTabCharacter"> - <property name="eachLine" value="true" /> + <module name="Checker"> + <module name="FileTabCharacter"> + <property name="eachLine" value="true" /> </module> - <module name="TreeWalker"> - <module name="EmptyBlock"/> + <module name="TreeWalker"> + <module name="EmptyBlock"/> </module> </module> </checkstyleRules> </configuration> ... -</pre></div><br /></td> - </tr> - +</pre></td></tr> <tr class="b"> - -<td align="left"><code><a href="#checkstyleRulesHeader"><checkstyleRulesHeader></a></code></td> - +<td align="left"><a href="#checkstyleRulesHeader"><code><checkstyleRulesHeader></code></a></td> <td><code>String</code></td> - <td><code>-</code></td> - -<td>The header to use for the inline configuration. Only used when you specify <code>checkstyleRules</code>.<br /><b>Default value is</b>: <code><?xml version="1.0"?> +<td>The header to use for the inline configuration. Only used when you specify <code>checkstyleRules</code>.<br /><strong>Default</strong>: <code><?xml version="1.0"?> <!DOCTYPE module PUBLIC "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" "https://checkstyle.org/dtds/configuration_1_3.dtd"> -</code>.<br /></td> - </tr> - +</code></td></tr> <tr class="a"> - -<td align="left"><code><a href="#configLocation"><configLocation></a></code></td> - +<td align="left"><a href="#configLocation"><code><configLocation></code></a></td> <td><code>String</code></td> - <td><code>-</code></td> - -<td> -<p>Specifies the location of the XML configuration to use.</p> - -<p>Potential values are a filesystem path, a URL, or a classpath resource. This parameter expects that the contents of the location conform to the xml format (Checkstyle <a class="externalLink" href="https://checkstyle.org/config.html#Modules";>Checker module</a>) configuration of rulesets.</p> - +<td><p>Specifies the location of the XML configuration to use.</p> +<p>Potential values are a filesystem path, a URL, or a classpath resource. This parameter expects that the contents of the location conform to the xml format (Checkstyle <a href="https://checkstyle.org/config.html#Modules";>Checker module</a>) configuration of rulesets.</p> <p>This parameter is resolved as resource, URL, then file. If successfully resolved, the contents of the configuration is copied into the <code>${project.build.directory}/checkstyle-configuration.xml</code> file before being passed to Checkstyle as a configuration.</p> - <p>There are 2 predefined rulesets included in Maven Checkstyle Plugin:</p> - <ul> - -<li><code>sun_checks.xml</code>: Sun Checks.</li> - -<li><code>google_checks.xml</code>: Google Checks.</li> -</ul><br /><b>Default value is</b>: <code>sun_checks.xml</code>.<br /><b>User property is</b>: <code>checkstyle.config.location</code>.<br /></td> - </tr> - + <li><code>sun_checks.xml</code>: Sun Checks.</li> + <li><code>google_checks.xml</code>: Google Checks.</li> +</ul><br /><strong>Default</strong>: <code>sun_checks.xml</code><br /><strong>User Property</strong>: <code>checkstyle.config.location</code></td></tr> <tr class="b"> - -<td align="left"><code><a href="#consoleOutput"><consoleOutput></a></code></td> - +<td align="left"><a href="#consoleOutput"><code><consoleOutput></code></a></td> <td><code>boolean</code></td> - <td><code>-</code></td> - -<td>Output errors to console.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>checkstyle.consoleOutput</code>.<br /></td> - </tr> - +<td>Output errors to console.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>checkstyle.consoleOutput</code></td></tr> <tr class="a"> - -<td align="left"><code><a href="#enableFilesSummary"><enableFilesSummary></a></code></td> - +<td align="left"><a href="#enableFilesSummary"><code><enableFilesSummary></code></a></td> <td><code>boolean</code></td> - <td><code>-</code></td> - -<td>Specifies if the Files summary should be enabled or not.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>checkstyle.enable.files.summary</code>.<br /></td> - </tr> - +<td>Specifies if the Files summary should be enabled or not.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>checkstyle.enable.files.summary</code></td></tr> <tr class="b"> - -<td align="left"><code><a href="#enableRulesSummary"><enableRulesSummary></a></code></td> - +<td align="left"><a href="#enableRulesSummary"><code><enableRulesSummary></code></a></td> <td><code>boolean</code></td> - <td><code>-</code></td> - -<td>Specifies if the Rules summary should be enabled or not.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>checkstyle.enable.rules.summary</code>.<br /></td> - </tr> - +<td>Specifies if the Rules summary should be enabled or not.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>checkstyle.enable.rules.summary</code></td></tr> <tr class="a"> - -<td align="left"><code><a href="#enableSeveritySummary"><enableSeveritySummary></a></code></td> - +<td align="left"><a href="#enableSeveritySummary"><code><enableSeveritySummary></code></a></td> <td><code>boolean</code></td> - <td><code>-</code></td> - -<td>Specifies if the Severity summary should be enabled or not.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>checkstyle.enable.severity.summary</code>.<br /></td> - </tr> - +<td>Specifies if the Severity summary should be enabled or not.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>checkstyle.enable.severity.summary</code></td></tr> <tr class="b"> - -<td align="left"><code><a href="#excludeGeneratedSources"><excludeGeneratedSources></a></code></td> - +<td align="left"><a href="#excludeGeneratedSources"><code><excludeGeneratedSources></code></a></td> <td><code>boolean</code></td> - <td><code>3.3.1</code></td> - -<td>Specifies whether generated source files should be excluded from Checkstyle.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>checkstyle.excludeGeneratedSources</code>.<br /></td> - </tr> - +<td>Specifies whether generated source files should be excluded from Checkstyle.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>checkstyle.excludeGeneratedSources</code></td></tr> <tr class="a"> - -<td align="left"><code><a href="#excludes"><excludes></a></code></td> - +<td align="left"><a href="#excludes"><code><excludes></code></a></td> <td><code>String</code></td> - <td><code>-</code></td> - -<td>Specifies the names filter of the source files to be excluded for Checkstyle.<br /><b>User property is</b>: <code>checkstyle.excludes</code>.<br /></td> - </tr> - +<td>Specifies the names filter of the source files to be excluded for Checkstyle.<br /><strong>User Property</strong>: <code>checkstyle.excludes</code></td></tr> <tr class="b"> - -<td align="left"><code><a href="#failsOnError"><failsOnError></a></code></td> - +<td align="left"><a href="#failsOnError"><code><failsOnError></code></a></td> <td><code>boolean</code></td> - <td><code>-</code></td> - -<td>Specifies if the build should fail upon a violation.<br /><b>Default value is</b>: <code>false</code>.<br /></td> - </tr> - +<td>Specifies if the build should fail upon a violation.<br /><strong>Default</strong>: <code>false</code></td></tr> <tr class="a"> - -<td align="left"><code><a href="#headerLocation"><headerLocation></a></code></td> - +<td align="left"><a href="#headerLocation"><code><headerLocation></code></a></td> <td><code>String</code></td> - <td><code>2.0-beta-2</code></td> - -<td> -<p>Specifies the location of the License file (a.k.a. the header file) that can be used by Checkstyle to verify that source code has the correct license header.</p> - +<td><p>Specifies the location of the License file (a.k.a. the header file) that can be used by Checkstyle to verify that source code has the correct license header.</p> <p>You need to use <code>${checkstyle.header.file}</code> in your Checkstyle xml configuration to reference the name of this header file.</p> - <p>For instance:</p> - -<div> <pre> -<module name="RegexpHeader"> - <property name="headerFile" value="${checkstyle.header.file}"/> +<module name="RegexpHeader"> + <property name="headerFile" value="${checkstyle.header.file}"/> </module> -</pre></div><br /><b>Default value is</b>: <code>LICENSE.txt</code>.<br /><b>User property is</b>: <code>checkstyle.header.file</code>.<br /></td> - </tr> - +</pre><br /><strong>Default</strong>: <code>LICENSE.txt</code><br /><strong>User Property</strong>: <code>checkstyle.header.file</code></td></tr> <tr class="b"> - -<td align="left"><code><a href="#includeTestSourceDirectory"><includeTestSourceDirectory></a></code></td> - +<td align="left"><a href="#includeTestSourceDirectory"><code><includeTestSourceDirectory></code></a></td> <td><code>boolean</code></td> - <td><code>2.2</code></td> - -<td>Include or not the test source directory/directories to be used for Checkstyle.<br /><b>Default value is</b>: <code>false</code>.<br /></td> - </tr> - +<td>Include or not the test source directory/directories to be used for Checkstyle.<br /><strong>Default</strong>: <code>false</code></td></tr> <tr class="a"> - -<td align="left"><code><a href="#linkXRef"><linkXRef></a></code></td> - +<td align="left"><a href="#linkXRef"><code><linkXRef></code></a></td> <td><code>boolean</code></td> - <td><code>2.1</code></td> - -<td>Link the violation line numbers to the source xref. Will link automatically if Maven JXR plugin is being used.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>linkXRef</code>.<br /></td> - </tr> - +<td>Link the violation line numbers to the source xref. Will link automatically if Maven JXR plugin is being used.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>linkXRef</code></td></tr> <tr class="b"> - -<td align="left"><code><a href="#omitIgnoredModules"><omitIgnoredModules></a></code></td> - +<td align="left"><a href="#omitIgnoredModules"><code><omitIgnoredModules></code></a></td> <td><code>boolean</code></td> - <td><code>3.0.0</code></td> - -<td>Specifies whether modules with a configured severity of <code>ignore</code> should be omitted during Checkstyle invocation.<br /><b>Default value is</b>: <code>false</code>.<br /></td> - </tr> - +<td>Specifies whether modules with a configured severity of <code>ignore</code> should be omitted during Checkstyle invocation.<br /><strong>Default</strong>: <code>false</code></td></tr> <tr class="a"> - -<td align="left"><code><a href="#outputFile"><outputFile></a></code></td> - +<td align="left"><a href="#outputFile"><code><outputFile></code></a></td> <td><code>File</code></td> - <td><code>-</code></td> - -<td>Specifies the path and filename to save the Checkstyle output. The format of the output file is determined by the <code>outputFileFormat</code> parameter.<br /><b>Default value is</b>: <code>${project.build.directory}/checkstyle-result.xml</code>.<br /><b>User property is</b>: <code>checkstyle.output.file</code>.<br /></td> - </tr> - +<td>Specifies the path and filename to save the Checkstyle output. The format of the output file is determined by the <code>outputFileFormat</code> parameter.<br /><strong>Default</strong>: <code>${project.build.directory}/checkstyle-result.xml</code><br /><strong>User Property</strong>: <code>checkstyle.output.file</code></td></tr> <tr class="b"> - -<td align="left"><code><a href="#outputFileFormat"><outputFileFormat></a></code></td> - +<td align="left"><a href="#outputFileFormat"><code><outputFileFormat></code></a></td> <td><code>String</code></td> - <td><code>-</code></td> - -<td>Specifies the format of the output to be used when writing to the output file. Valid values are "<code>plain</code>" and "<code>xml</code>".<br /><b>Default value is</b>: <code>xml</code>.<br /><b>User property is</b>: <code>checkstyle.output.format</code>.<br /></td> - </tr> - +<td>Specifies the format of the output to be used when writing to the output file. Valid values are "<code>plain</code>", "<code>sarif</code>" and "<code>xml</code>".<br /><strong>Default</strong>: <code>xml</code><br /><strong>User Property</strong>: <code>checkstyle.output.format</code></td></tr> <tr class="a"> - -<td align="left"><code><a href="#propertiesLocation"><propertiesLocation></a></code></td> - +<td align="left"><a href="#propertiesLocation"><code><propertiesLocation></code></a></td> <td><code>String</code></td> - <td><code>2.0-beta-2</code></td> - -<td> -<p>Specifies the location of the properties file.</p> - +<td><p>Specifies the location of the properties file.</p> <p>This parameter is resolved as URL, File then resource. If successfully resolved, the contents of the properties location is copied into the <code>${project.build.directory}/checkstyle-checker.properties</code> file before being passed to Checkstyle for loading.</p> - -<p>The contents of the <code>propertiesLocation</code> will be made available to Checkstyle for specifying values for parameters within the xml configuration (specified in the <code>configLocation</code> parameter).</p><br /><b>User property is</b>: <code>checkstyle.properties.location</code>.<br /></td> - </tr> - +<p>The contents of the <code>propertiesLocation</code> will be made available to Checkstyle for specifying values for parameters within the xml configuration (specified in the <code>configLocation</code> parameter).</p><br /><strong>User Property</strong>: <code>checkstyle.properties.location</code></td></tr> <tr class="b"> - -<td align="left"><code><a href="#propertyExpansion"><propertyExpansion></a></code></td> - +<td align="left"><a href="#propertyExpansion"><code><propertyExpansion></code></a></td> <td><code>String</code></td> - <td><code>-</code></td> - -<td>Allows for specifying raw property expansion information.<br /></td> - </tr> - +<td>Allows for specifying raw property expansion information.</td></tr> <tr class="a"> - -<td align="left"><code><a href="#resourceExcludes"><resourceExcludes></a></code></td> - +<td align="left"><a href="#resourceExcludes"><code><resourceExcludes></code></a></td> <td><code>String</code></td> - <td><code>2.11</code></td> - -<td>Specifies the names filter of the resource files to be excluded for Checkstyle.<br /><b>User property is</b>: <code>checkstyle.resourceExcludes</code>.<br /></td> - </tr> - +<td>Specifies the names filter of the resource files to be excluded for Checkstyle.<br /><strong>User Property</strong>: <code>checkstyle.resourceExcludes</code></td></tr> <tr class="b"> - -<td align="left"><code><a href="#rulesFiles"><rulesFiles></a></code></td> - +<td align="left"><a href="#rulesFiles"><code><rulesFiles></code></a></td> <td><code>File</code></td> - <td><code>-</code></td> - -<td>Dump file for inlined Checkstyle rules.<br /><b>Default value is</b>: <code>${project.build.directory}/checkstyle-rules.xml</code>.<br /><b>User property is</b>: <code>checkstyle.output.rules.file</code>.<br /></td> - </tr> - +<td>Dump file for inlined Checkstyle rules.<br /><strong>Default</strong>: <code>${project.build.directory}/checkstyle-rules.xml</code><br /><strong>User Property</strong>: <code>checkstyle.output.rules.file</code></td></tr> <tr class="a"> - -<td align="left"><code><a href="#skip"><skip></a></code></td> - +<td align="left"><a href="#skip"><code><skip></code></a></td> <td><code>boolean</code></td> - <td><code>2.2</code></td> - -<td>Skip entire check.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>checkstyle.skip</code>.<br /></td> - </tr> - +<td>Skip entire check.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>checkstyle.skip</code></td></tr> <tr class="b"> - -<td align="left"><code><a href="#sourceDirectories"><sourceDirectories></a></code></td> - +<td align="left"><a href="#sourceDirectories"><code><sourceDirectories></code></a></td> <td><code>List<String></code></td> - <td><code>2.13</code></td> - -<td>Specifies the location of the source directories to be used for Checkstyle. Default value is <code>${project.compileSourceRoots}</code>.<br /></td> - </tr> - +<td>Specifies the location of the source directories to be used for Checkstyle. Default value is <code>${project.compileSourceRoots}</code>.</td></tr> <tr class="a"> - -<td align="left"><code><a href="#sourceDirectory"><sourceDirectory></a></code></td> - +<td align="left"><a href="#sourceDirectory"><code><sourceDirectory></code></a></td> <td><code>File</code></td> - <td><code>-</code></td> - -<td><b>Deprecated.</b> Specifies the location of the source directory to be used for Checkstyle.<br /></td> - </tr> - +<td> +<div><strong>Deprecated.</strong><br />instead use <a href="#sourceDirectories"><code>sourceDirectories</code></a>. For version 3.0.0, this parameter is only defined to break the build if you use it!</div><br />Specifies the location of the source directory to be used for Checkstyle.</td></tr> <tr class="b"> - -<td align="left"><code><a href="#suppressionsFileExpression"><suppressionsFileExpression></a></code></td> - +<td align="left"><a href="#suppressionsFileExpression"><code><suppressionsFileExpression></code></a></td> <td><code>String</code></td> - <td><code>2.1</code></td> - -<td>The key to be used in the properties for the suppressions file.<br /><b>Default value is</b>: <code>checkstyle.suppressions.file</code>.<br /><b>User property is</b>: <code>checkstyle.suppression.expression</code>.<br /></td> - </tr> - +<td>The key to be used in the properties for the suppressions file.<br /><strong>Default</strong>: <code>checkstyle.suppressions.file</code><br /><strong>User Property</strong>: <code>checkstyle.suppression.expression</code></td></tr> <tr class="a"> - -<td align="left"><code><a href="#suppressionsLocation"><suppressionsLocation></a></code></td> - +<td align="left"><a href="#suppressionsLocation"><code><suppressionsLocation></code></a></td> <td><code>String</code></td> - <td><code>2.0-beta-2</code></td> - -<td> -<p>Specifies the location of the suppressions XML file to use.</p> - +<td><p>Specifies the location of the suppressions XML file to use.</p> <p>This parameter is resolved as resource, URL, then file. If successfully resolved, the contents of the suppressions XML is copied into the <code>${project.build.directory}/checkstyle-supressions.xml</code> file before being passed to Checkstyle for loading.</p> - -<p>See <code>suppressionsFileExpression</code> for the property that will be made available to your Checkstyle configuration.</p><br /><b>User property is</b>: <code>checkstyle.suppressions.location</code>.<br /></td> - </tr> - +<p>See <code>suppressionsFileExpression</code> for the property that will be made available to your Checkstyle configuration.</p><br /><strong>User Property</strong>: <code>checkstyle.suppressions.location</code></td></tr> <tr class="b"> - -<td align="left"><code><a href="#testSourceDirectories"><testSourceDirectories></a></code></td> - +<td align="left"><a href="#testSourceDirectories"><code><testSourceDirectories></code></a></td> <td><code>List<String></code></td> - <td><code>2.13</code></td> - -<td>Specifies the location of the test source directories to be used for Checkstyle. Default value is <code>${project.testCompileSourceRoots}</code>.<br /></td> - </tr> - +<td>Specifies the location of the test source directories to be used for Checkstyle. Default value is <code>${project.testCompileSourceRoots}</code>.</td></tr> <tr class="a"> - -<td align="left"><code><a href="#testSourceDirectory"><testSourceDirectory></a></code></td> - +<td align="left"><a href="#testSourceDirectory"><code><testSourceDirectory></code></a></td> <td><code>File</code></td> - <td><code>2.2</code></td> - -<td><b>Deprecated.</b> Specifies the location of the test source directory to be used for Checkstyle.<br /></td> - </tr> - +<td> +<div><strong>Deprecated.</strong><br />instead use <a href="#testSourceDirectories"><code>testSourceDirectories</code></a>. For version 3.0.0, this parameter is only defined to break the build if you use it!</div><br />Specifies the location of the test source directory to be used for Checkstyle.</td></tr> <tr class="b"> - -<td align="left"><code><a href="#treeWalkerNames"><treeWalkerNames></a></code></td> - +<td align="left"><a href="#treeWalkerNames"><code><treeWalkerNames></code></a></td> <td><code>List<String></code></td> - <td><code>2.11</code></td> - -<td>When using custom treeWalkers, specify their names here so the checks inside the treeWalker end up the the rule-summary.<br /></td> - </tr> - +<td>When using custom treeWalkers, specify their names here so the checks inside the treeWalker end up the the rule-summary.</td></tr> <tr class="a"> - -<td align="left"><code><a href="#useFile"><useFile></a></code></td> - +<td align="left"><a href="#useFile"><code><useFile></code></a></td> <td><code>File</code></td> - <td><code>-</code></td> - -<td>If <code>null</code>, the Checkstyle plugin will display violations on stdout. Otherwise, a text file will be created with the violations.<br /></td> - </tr> - +<td>If <code>null</code>, the Checkstyle plugin will display violations on stdout. Otherwise, a text file will be created with the violations.</td></tr> <tr class="b"> - -<td align="left"><code><a href="#xrefLocation"><xrefLocation></a></code></td> - +<td align="left"><a href="#xrefLocation"><code><xrefLocation></code></a></td> <td><code>File</code></td> - <td><code>-</code></td> - -<td>Location of the Xrefs to link to.<br /><b>Default value is</b>: <code>${project.reporting.outputDirectory}/xref</code>.<br /></td> - </tr> - +<td>Location of the Xrefs to link to.<br /><strong>Default</strong>: <code>${project.reporting.outputDirectory}/xref</code></td></tr> <tr class="a"> - -<td align="left"><code><a href="#xrefTestLocation"><xrefTestLocation></a></code></td> - +<td align="left"><a href="#xrefTestLocation"><code><xrefTestLocation></code></a></td> <td><code>File</code></td> - <td><code>-</code></td> - -<td>Location of the XrefTests to link to.<br /><b>Default value is</b>: <code>${project.reporting.outputDirectory}/xref-test</code>.<br /></td> - </tr> - </table> - </section> - <section> -<h3><a name="Parameter_Details"></a>Parameter Details</h3> - <section> -<h4><a name="a.3CcacheFile.3E"></a><b><a name="cacheFile"><cacheFile></a></b></h4> - +<td>Location of the XrefTests to link to.<br /><strong>Default</strong>: <code>${project.reporting.outputDirectory}/xref-test</code></td></tr></table></section><section> +<h3><a name="Parameter_Details"></a>Parameter Details</h3><a name="Parameter_Details"></a><a name="cacheFile"><section> +<h4><a name="a.3CcacheFile.3E"></a><cacheFile></h4><a name="a.3CcacheFile.3E"></a></a> <div>Specifies the cache file used to speed up Checkstyle on successive runs.</div> - <ul> - -<li><b>Type</b>: <code>java.lang.String</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>Default</b>: <code>${project.build.directory}/checkstyle-cachefile</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CcheckstyleRules.3E"></a><b><a name="checkstyleRules"><checkstyleRules></a></b></h4> - +<li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>Default</strong>: <code>${project.build.directory}/checkstyle-cachefile</code></li></ul><hr /></section><a name="checkstyleRules"><section> +<h4><a name="a.3CcheckstyleRules.3E"></a><checkstyleRules></h4><a name="a.3CcheckstyleRules.3E"></a></a> <div>By using this property, you can specify the whole Checkstyle rules inline directly inside this pom. - -<div> <pre> <plugin> ... <configuration> <checkstyleRules> - <module name="Checker"> - <module name="FileTabCharacter"> - <property name="eachLine" value="true" /> + <module name="Checker"> + <module name="FileTabCharacter"> + <property name="eachLine" value="true" /> </module> - <module name="TreeWalker"> - <module name="EmptyBlock"/> + <module name="TreeWalker"> + <module name="EmptyBlock"/> </module> </module> </checkstyleRules> </configuration> ... -</pre></div></div> - +</pre></div> <ul> - -<li><b>Type</b>: <code>org.codehaus.plexus.configuration.PlexusConfiguration</code></li> - -<li><b>Since</b>: <code>2.12</code></li> - -<li><b>Required</b>: <code>No</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CcheckstyleRulesHeader.3E"></a><b><a name="checkstyleRulesHeader"><checkstyleRulesHeader></a></b></h4> - +<li><strong>Type</strong>: <code>org.codehaus.plexus.configuration.PlexusConfiguration</code></li> +<li><strong>Since</strong>: <code>2.12</code></li> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="checkstyleRulesHeader"><section> +<h4><a name="a.3CcheckstyleRulesHeader.3E"></a><checkstyleRulesHeader></h4><a name="a.3CcheckstyleRulesHeader.3E"></a></a> <div>The header to use for the inline configuration. Only used when you specify <code>checkstyleRules</code>.</div> - <ul> - -<li><b>Type</b>: <code>java.lang.String</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>Default</b>: <code><?xml version="1.0"?> +<li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>Default</strong>: <code><?xml version="1.0"?> <!DOCTYPE module PUBLIC "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" "https://checkstyle.org/dtds/configuration_1_3.dtd"> -</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CconfigLocation.3E"></a><b><a name="configLocation"><configLocation></a></b></h4> - -<div> -<p>Specifies the location of the XML configuration to use.</p> - -<p>Potential values are a filesystem path, a URL, or a classpath resource. This parameter expects that the contents of the location conform to the xml format (Checkstyle <a class="externalLink" href="https://checkstyle.org/config.html#Modules";>Checker module</a>) configuration of rulesets.</p> - +</code></li></ul><hr /></section><a name="configLocation"><section> +<h4><a name="a.3CconfigLocation.3E"></a><configLocation></h4><a name="a.3CconfigLocation.3E"></a></a> +<div><p>Specifies the location of the XML configuration to use.</p> +<p>Potential values are a filesystem path, a URL, or a classpath resource. This parameter expects that the contents of the location conform to the xml format (Checkstyle <a href="https://checkstyle.org/config.html#Modules";>Checker module</a>) configuration of rulesets.</p> <p>This parameter is resolved as resource, URL, then file. If successfully resolved, the contents of the configuration is copied into the <code>${project.build.directory}/checkstyle-configuration.xml</code> file before being passed to Checkstyle as a configuration.</p> - <p>There are 2 predefined rulesets included in Maven Checkstyle Plugin:</p> - <ul> - -<li><code>sun_checks.xml</code>: Sun Checks.</li> - -<li><code>google_checks.xml</code>: Google Checks.</li> + <li><code>sun_checks.xml</code>: Sun Checks.</li> + <li><code>google_checks.xml</code>: Google Checks.</li> </ul></div> - <ul> - -<li><b>Type</b>: <code>java.lang.String</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>User Property</b>: <code>checkstyle.config.location</code></li> - -<li><b>Default</b>: <code>sun_checks.xml</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CconsoleOutput.3E"></a><b><a name="consoleOutput"><consoleOutput></a></b></h4> - +<li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>User Property</strong>: <code>checkstyle.config.location</code></li> +<li><strong>Default</strong>: <code>sun_checks.xml</code></li></ul><hr /></section><a name="consoleOutput"><section> +<h4><a name="a.3CconsoleOutput.3E"></a><consoleOutput></h4><a name="a.3CconsoleOutput.3E"></a></a> <div>Output errors to console.</div> - <ul> - -<li><b>Type</b>: <code>boolean</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>User Property</b>: <code>checkstyle.consoleOutput</code></li> - -<li><b>Default</b>: <code>false</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CenableFilesSummary.3E"></a><b><a name="enableFilesSummary"><enableFilesSummary></a></b></h4> - +<li><strong>Type</strong>: <code>boolean</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>User Property</strong>: <code>checkstyle.consoleOutput</code></li> +<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="enableFilesSummary"><section> +<h4><a name="a.3CenableFilesSummary.3E"></a><enableFilesSummary></h4><a name="a.3CenableFilesSummary.3E"></a></a> <div>Specifies if the Files summary should be enabled or not.</div> - <ul> - -<li><b>Type</b>: <code>boolean</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>User Property</b>: <code>checkstyle.enable.files.summary</code></li> - -<li><b>Default</b>: <code>true</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CenableRulesSummary.3E"></a><b><a name="enableRulesSummary"><enableRulesSummary></a></b></h4> - +<li><strong>Type</strong>: <code>boolean</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>User Property</strong>: <code>checkstyle.enable.files.summary</code></li> +<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="enableRulesSummary"><section> +<h4><a name="a.3CenableRulesSummary.3E"></a><enableRulesSummary></h4><a name="a.3CenableRulesSummary.3E"></a></a> <div>Specifies if the Rules summary should be enabled or not.</div> - <ul> - -<li><b>Type</b>: <code>boolean</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>User Property</b>: <code>checkstyle.enable.rules.summary</code></li> - -<li><b>Default</b>: <code>true</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CenableSeveritySummary.3E"></a><b><a name="enableSeveritySummary"><enableSeveritySummary></a></b></h4> - +<li><strong>Type</strong>: <code>boolean</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>User Property</strong>: <code>checkstyle.enable.rules.summary</code></li> +<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="enableSeveritySummary"><section> +<h4><a name="a.3CenableSeveritySummary.3E"></a><enableSeveritySummary></h4><a name="a.3CenableSeveritySummary.3E"></a></a> <div>Specifies if the Severity summary should be enabled or not.</div> - <ul> - -<li><b>Type</b>: <code>boolean</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>User Property</b>: <code>checkstyle.enable.severity.summary</code></li> - -<li><b>Default</b>: <code>true</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CexcludeGeneratedSources.3E"></a><b><a name="excludeGeneratedSources"><excludeGeneratedSources></a></b></h4> - +<li><strong>Type</strong>: <code>boolean</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>User Property</strong>: <code>checkstyle.enable.severity.summary</code></li> +<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="excludeGeneratedSources"><section> +<h4><a name="a.3CexcludeGeneratedSources.3E"></a><excludeGeneratedSources></h4><a name="a.3CexcludeGeneratedSources.3E"></a></a> <div>Specifies whether generated source files should be excluded from Checkstyle.</div> - <ul> - -<li><b>Type</b>: <code>boolean</code></li> - -<li><b>Since</b>: <code>3.3.1</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>User Property</b>: <code>checkstyle.excludeGeneratedSources</code></li> - -<li><b>Default</b>: <code>false</code></li> - </ul><hr /></section><section> -<h4><a name="a.3Cexcludes.3E"></a><b><a name="excludes"><excludes></a></b></h4> - +<li><strong>Type</strong>: <code>boolean</code></li> +<li><strong>Since</strong>: <code>3.3.1</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>User Property</strong>: <code>checkstyle.excludeGeneratedSources</code></li> +<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="excludes"><section> +<h4><a name="a.3Cexcludes.3E"></a><excludes></h4><a name="a.3Cexcludes.3E"></a></a> <div>Specifies the names filter of the source files to be excluded for Checkstyle.</div> - <ul> - -<li><b>Type</b>: <code>java.lang.String</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>User Property</b>: <code>checkstyle.excludes</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CfailsOnError.3E"></a><b><a name="failsOnError"><failsOnError></a></b></h4> - +<li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>User Property</strong>: <code>checkstyle.excludes</code></li></ul><hr /></section><a name="failsOnError"><section> +<h4><a name="a.3CfailsOnError.3E"></a><failsOnError></h4><a name="a.3CfailsOnError.3E"></a></a> <div>Specifies if the build should fail upon a violation.</div> - <ul> - -<li><b>Type</b>: <code>boolean</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>Default</b>: <code>false</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CheaderLocation.3E"></a><b><a name="headerLocation"><headerLocation></a></b></h4> - -<div> -<p>Specifies the location of the License file (a.k.a. the header file) that can be used by Checkstyle to verify that source code has the correct license header.</p> - +<li><strong>Type</strong>: <code>boolean</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="headerLocation"><section> +<h4><a name="a.3CheaderLocation.3E"></a><headerLocation></h4><a name="a.3CheaderLocation.3E"></a></a> +<div><p>Specifies the location of the License file (a.k.a. the header file) that can be used by Checkstyle to verify that source code has the correct license header.</p> <p>You need to use <code>${checkstyle.header.file}</code> in your Checkstyle xml configuration to reference the name of this header file.</p> - <p>For instance:</p> - -<div> <pre> -<module name="RegexpHeader"> - <property name="headerFile" value="${checkstyle.header.file}"/> +<module name="RegexpHeader"> + <property name="headerFile" value="${checkstyle.header.file}"/> </module> -</pre></div></div> - +</pre></div> <ul> - -<li><b>Type</b>: <code>java.lang.String</code></li> - -<li><b>Since</b>: <code>2.0-beta-2</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>User Property</b>: <code>checkstyle.header.file</code></li> - -<li><b>Default</b>: <code>LICENSE.txt</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CincludeResources.3E"></a><b><a name="includeResources"><includeResources></a></b></h4> - +<li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Since</strong>: <code>2.0-beta-2</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>User Property</strong>: <code>checkstyle.header.file</code></li> +<li><strong>Default</strong>: <code>LICENSE.txt</code></li></ul><hr /></section><a name="includeResources"><section> +<h4><a name="a.3CincludeResources.3E"></a><includeResources></h4><a name="a.3CincludeResources.3E"></a></a> <div>Specifies whether to include the resource directories in the check.</div> - -<ul> - -<li><b>Type</b>: <code>boolean</code></li> - -<li><b>Since</b>: <code>2.11</code></li> - -<li><b>Required</b>: <code>Yes</code></li> - -<li><b>User Property</b>: <code>checkstyle.includeResources</code></li> - -<li><b>Default</b>: <code>true</code></li> - </ul><hr /></section><section> -<h4><a name="a.3Cincludes.3E"></a><b><a name="includes"><includes></a></b></h4> - -<div>Specifies the names filter of the source files to be used for Checkstyle.</div> - <ul> - -<li><b>Type</b>: <code>java.lang.String</code></li> - -<li><b>Required</b>: <code>Yes</code></li> - -<li><b>User Property</b>: <code>checkstyle.includes</code></li> - -<li><b>Default</b>: <code>**\/*.java</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CincludeTestResources.3E"></a><b><a name="includeTestResources"><includeTestResources></a></b></h4> - +<li><strong>Type</strong>: <code>boolean</code></li> +<li><strong>Since</strong>: <code>2.11</code></li> +<li><strong>Required</strong>: <code>Yes</code></li> +<li><strong>User Property</strong>: <code>checkstyle.includeResources</code></li> +<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="includeTestResources"><section> +<h4><a name="a.3CincludeTestResources.3E"></a><includeTestResources></h4><a name="a.3CincludeTestResources.3E"></a></a> <div>Specifies whether to include the test resource directories in the check.</div> - <ul> - -<li><b>Type</b>: <code>boolean</code></li> - -<li><b>Since</b>: <code>2.11</code></li> - -<li><b>Required</b>: <code>Yes</code></li> - -<li><b>User Property</b>: <code>checkstyle.includeTestResources</code></li> - -<li><b>Default</b>: <code>true</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CincludeTestSourceDirectory.3E"></a><b><a name="includeTestSourceDirectory"><includeTestSourceDirectory></a></b></h4> - +<li><strong>Type</strong>: <code>boolean</code></li> +<li><strong>Since</strong>: <code>2.11</code></li> +<li><strong>Required</strong>: <code>Yes</code></li> +<li><strong>User Property</strong>: <code>checkstyle.includeTestResources</code></li> +<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="includeTestSourceDirectory"><section> +<h4><a name="a.3CincludeTestSourceDirectory.3E"></a><includeTestSourceDirectory></h4><a name="a.3CincludeTestSourceDirectory.3E"></a></a> <div>Include or not the test source directory/directories to be used for Checkstyle.</div> - <ul> - -<li><b>Type</b>: <code>boolean</code></li> - -<li><b>Since</b>: <code>2.2</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>Default</b>: <code>false</code></li> - </ul><hr /></section><section> -<h4><a name="a.3ClinkXRef.3E"></a><b><a name="linkXRef"><linkXRef></a></b></h4> - +<li><strong>Type</strong>: <code>boolean</code></li> +<li><strong>Since</strong>: <code>2.2</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="includes"><section> +<h4><a name="a.3Cincludes.3E"></a><includes></h4><a name="a.3Cincludes.3E"></a></a> +<div>Specifies the names filter of the source files to be used for Checkstyle.</div> +<ul> +<li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>Yes</code></li> +<li><strong>User Property</strong>: <code>checkstyle.includes</code></li> +<li><strong>Default</strong>: <code>**\/*.java</code></li></ul><hr /></section><a name="linkXRef"><section> +<h4><a name="a.3ClinkXRef.3E"></a><linkXRef></h4><a name="a.3ClinkXRef.3E"></a></a> <div>Link the violation line numbers to the source xref. Will link automatically if Maven JXR plugin is being used.</div> - <ul> - -<li><b>Type</b>: <code>boolean</code></li> - -<li><b>Since</b>: <code>2.1</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>User Property</b>: <code>linkXRef</code></li> - -<li><b>Default</b>: <code>true</code></li> - </ul><hr /></section><section> -<h4><a name="a.3ComitIgnoredModules.3E"></a><b><a name="omitIgnoredModules"><omitIgnoredModules></a></b></h4> - +<li><strong>Type</strong>: <code>boolean</code></li> +<li><strong>Since</strong>: <code>2.1</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>User Property</strong>: <code>linkXRef</code></li> +<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="omitIgnoredModules"><section> +<h4><a name="a.3ComitIgnoredModules.3E"></a><omitIgnoredModules></h4><a name="a.3ComitIgnoredModules.3E"></a></a> <div>Specifies whether modules with a configured severity of <code>ignore</code> should be omitted during Checkstyle invocation.</div> - <ul> - -<li><b>Type</b>: <code>boolean</code></li> - -<li><b>Since</b>: <code>3.0.0</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>Default</b>: <code>false</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CoutputFile.3E"></a><b><a name="outputFile"><outputFile></a></b></h4> - +<li><strong>Type</strong>: <code>boolean</code></li> +<li><strong>Since</strong>: <code>3.0.0</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="outputFile"><section> +<h4><a name="a.3CoutputFile.3E"></a><outputFile></h4><a name="a.3CoutputFile.3E"></a></a> <div>Specifies the path and filename to save the Checkstyle output. The format of the output file is determined by the <code>outputFileFormat</code> parameter.</div> - <ul> - -<li><b>Type</b>: <code>java.io.File</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>User Property</b>: <code>checkstyle.output.file</code></li> - -<li><b>Default</b>: <code>${project.build.directory}/checkstyle-result.xml</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CoutputFileFormat.3E"></a><b><a name="outputFileFormat"><outputFileFormat></a></b></h4> - -<div>Specifies the format of the output to be used when writing to the output file. Valid values are "<code>plain</code>" and "<code>xml</code>".</div> - -<ul> - -<li><b>Type</b>: <code>java.lang.String</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>User Property</b>: <code>checkstyle.output.format</code></li> - -<li><b>Default</b>: <code>xml</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CpropertiesLocation.3E"></a><b><a name="propertiesLocation"><propertiesLocation></a></b></h4> - -<div> -<p>Specifies the location of the properties file.</p> - +<li><strong>Type</strong>: <code>java.io.File</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>User Property</strong>: <code>checkstyle.output.file</code></li> +<li><strong>Default</strong>: <code>${project.build.directory}/checkstyle-result.xml</code></li></ul><hr /></section><a name="outputFileFormat"><section> +<h4><a name="a.3CoutputFileFormat.3E"></a><outputFileFormat></h4><a name="a.3CoutputFileFormat.3E"></a></a> +<div>Specifies the format of the output to be used when writing to the output file. Valid values are "<code>plain</code>", "<code>sarif</code>" and "<code>xml</code>".</div> +<ul> +<li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>User Property</strong>: <code>checkstyle.output.format</code></li> +<li><strong>Default</strong>: <code>xml</code></li></ul><hr /></section><a name="propertiesLocation"><section> +<h4><a name="a.3CpropertiesLocation.3E"></a><propertiesLocation></h4><a name="a.3CpropertiesLocation.3E"></a></a> +<div><p>Specifies the location of the properties file.</p> <p>This parameter is resolved as URL, File then resource. If successfully resolved, the contents of the properties location is copied into the <code>${project.build.directory}/checkstyle-checker.properties</code> file before being passed to Checkstyle for loading.</p> - <p>The contents of the <code>propertiesLocation</code> will be made available to Checkstyle for specifying values for parameters within the xml configuration (specified in the <code>configLocation</code> parameter).</p></div> - <ul> - -<li><b>Type</b>: <code>java.lang.String</code></li> - -<li><b>Since</b>: <code>2.0-beta-2</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>User Property</b>: <code>checkstyle.properties.location</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CpropertyExpansion.3E"></a><b><a name="propertyExpansion"><propertyExpansion></a></b></h4> - +<li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Since</strong>: <code>2.0-beta-2</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>User Property</strong>: <code>checkstyle.properties.location</code></li></ul><hr /></section><a name="propertyExpansion"><section> +<h4><a name="a.3CpropertyExpansion.3E"></a><propertyExpansion></h4><a name="a.3CpropertyExpansion.3E"></a></a> <div>Allows for specifying raw property expansion information.</div> - <ul> - -<li><b>Type</b>: <code>java.lang.String</code></li> - -<li><b>Required</b>: <code>No</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CresourceExcludes.3E"></a><b><a name="resourceExcludes"><resourceExcludes></a></b></h4> - +<li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="resourceExcludes"><section> +<h4><a name="a.3CresourceExcludes.3E"></a><resourceExcludes></h4><a name="a.3CresourceExcludes.3E"></a></a> <div>Specifies the names filter of the resource files to be excluded for Checkstyle.</div> - <ul> - -<li><b>Type</b>: <code>java.lang.String</code></li> - -<li><b>Since</b>: <code>2.11</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>User Property</b>: <code>checkstyle.resourceExcludes</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CresourceIncludes.3E"></a><b><a name="resourceIncludes"><resourceIncludes></a></b></h4> - +<li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Since</strong>: <code>2.11</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>User Property</strong>: <code>checkstyle.resourceExcludes</code></li></ul><hr /></section><a name="resourceIncludes"><section> +<h4><a name="a.3CresourceIncludes.3E"></a><resourceIncludes></h4><a name="a.3CresourceIncludes.3E"></a></a> <div>Specifies the names filter of the resource files to be used for Checkstyle.</div> - <ul> - -<li><b>Type</b>: <code>java.lang.String</code></li> - -<li><b>Since</b>: <code>2.11</code></li> - -<li><b>Required</b>: <code>Yes</code></li> - -<li><b>User Property</b>: <code>checkstyle.resourceIncludes</code></li> - -<li><b>Default</b>: <code>**/*.properties</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CrulesFiles.3E"></a><b><a name="rulesFiles"><rulesFiles></a></b></h4> - +<li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Since</strong>: <code>2.11</code></li> +<li><strong>Required</strong>: <code>Yes</code></li> +<li><strong>User Property</strong>: <code>checkstyle.resourceIncludes</code></li> +<li><strong>Default</strong>: <code>**/*.properties</code></li></ul><hr /></section><a name="rulesFiles"><section> +<h4><a name="a.3CrulesFiles.3E"></a><rulesFiles></h4><a name="a.3CrulesFiles.3E"></a></a> <div>Dump file for inlined Checkstyle rules.</div> - <ul> - -<li><b>Type</b>: <code>java.io.File</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>User Property</b>: <code>checkstyle.output.rules.file</code></li> - -<li><b>Default</b>: <code>${project.build.directory}/checkstyle-rules.xml</code></li> - </ul><hr /></section><section> -<h4><a name="a.3Cskip.3E"></a><b><a name="skip"><skip></a></b></h4> - +<li><strong>Type</strong>: <code>java.io.File</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>User Property</strong>: <code>checkstyle.output.rules.file</code></li> +<li><strong>Default</strong>: <code>${project.build.directory}/checkstyle-rules.xml</code></li></ul><hr /></section><a name="skip"><section> +<h4><a name="a.3Cskip.3E"></a><skip></h4><a name="a.3Cskip.3E"></a></a> <div>Skip entire check.</div> - <ul> - -<li><b>Type</b>: <code>boolean</code></li> - -<li><b>Since</b>: <code>2.2</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>User Property</b>: <code>checkstyle.skip</code></li> - -<li><b>Default</b>: <code>false</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CsourceDirectories.3E"></a><b><a name="sourceDirectories"><sourceDirectories></a></b></h4> - +<li><strong>Type</strong>: <code>boolean</code></li> +<li><strong>Since</strong>: <code>2.2</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>User Property</strong>: <code>checkstyle.skip</code></li> +<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="sourceDirectories"><section> +<h4><a name="a.3CsourceDirectories.3E"></a><sourceDirectories></h4><a name="a.3CsourceDirectories.3E"></a></a> <div>Specifies the location of the source directories to be used for Checkstyle. Default value is <code>${project.compileSourceRoots}</code>.</div> - <ul> - -<li><b>Type</b>: <code>java.util.List<java.lang.String></code></li> - -<li><b>Since</b>: <code>2.13</code></li> - -<li><b>Required</b>: <code>No</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CsourceDirectory.3E"></a><b><a name="sourceDirectory"><sourceDirectory></a></b></h4> - -<div><b>Deprecated.</b> instead use <a href="#sourceDirectories"><code>sourceDirectories</code></a>. For version 3.0.0, this parameter is only defined to break the build if you use it!</div> - +<li><strong>Type</strong>: <code>java.util.List<java.lang.String></code></li> +<li><strong>Since</strong>: <code>2.13</code></li> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="sourceDirectory"><section> +<h4><a name="a.3CsourceDirectory.3E"></a><sourceDirectory></h4><a name="a.3CsourceDirectory.3E"></a></a> +<div><strong>Deprecated.</strong><br />instead use <a href="#sourceDirectories"><code>sourceDirectories</code></a>. For version 3.0.0, this parameter is only defined to break the build if you use it!</div><br /> <div>Specifies the location of the source directory to be used for Checkstyle.</div> - <ul> - -<li><b>Type</b>: <code>java.io.File</code></li> - -<li><b>Required</b>: <code>No</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CsuppressionsFileExpression.3E"></a><b><a name="suppressionsFileExpression"><suppressionsFileExpression></a></b></h4> - +<li><strong>Type</strong>: <code>java.io.File</code></li> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="suppressionsFileExpression"><section> +<h4><a name="a.3CsuppressionsFileExpression.3E"></a><suppressionsFileExpression></h4><a name="a.3CsuppressionsFileExpression.3E"></a></a> <div>The key to be used in the properties for the suppressions file.</div> - <ul> - -<li><b>Type</b>: <code>java.lang.String</code></li> - -<li><b>Since</b>: <code>2.1</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>User Property</b>: <code>checkstyle.suppression.expression</code></li> - -<li><b>Default</b>: <code>checkstyle.suppressions.file</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CsuppressionsLocation.3E"></a><b><a name="suppressionsLocation"><suppressionsLocation></a></b></h4> - -<div> -<p>Specifies the location of the suppressions XML file to use.</p> - +<li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Since</strong>: <code>2.1</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>User Property</strong>: <code>checkstyle.suppression.expression</code></li> +<li><strong>Default</strong>: <code>checkstyle.suppressions.file</code></li></ul><hr /></section><a name="suppressionsLocation"><section> +<h4><a name="a.3CsuppressionsLocation.3E"></a><suppressionsLocation></h4><a name="a.3CsuppressionsLocation.3E"></a></a> +<div><p>Specifies the location of the suppressions XML file to use.</p> <p>This parameter is resolved as resource, URL, then file. If successfully resolved, the contents of the suppressions XML is copied into the <code>${project.build.directory}/checkstyle-supressions.xml</code> file before being passed to Checkstyle for loading.</p> - <p>See <code>suppressionsFileExpression</code> for the property that will be made available to your Checkstyle configuration.</p></div> - <ul> - -<li><b>Type</b>: <code>java.lang.String</code></li> - -<li><b>Since</b>: <code>2.0-beta-2</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>User Property</b>: <code>checkstyle.suppressions.location</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CtestSourceDirectories.3E"></a><b><a name="testSourceDirectories"><testSourceDirectories></a></b></h4> - +<li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Since</strong>: <code>2.0-beta-2</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>User Property</strong>: <code>checkstyle.suppressions.location</code></li></ul><hr /></section><a name="testSourceDirectories"><section> +<h4><a name="a.3CtestSourceDirectories.3E"></a><testSourceDirectories></h4><a name="a.3CtestSourceDirectories.3E"></a></a> <div>Specifies the location of the test source directories to be used for Checkstyle. Default value is <code>${project.testCompileSourceRoots}</code>.</div> - <ul> - -<li><b>Type</b>: <code>java.util.List<java.lang.String></code></li> - -<li><b>Since</b>: <code>2.13</code></li> - -<li><b>Required</b>: <code>No</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CtestSourceDirectory.3E"></a><b><a name="testSourceDirectory"><testSourceDirectory></a></b></h4> - -<div><b>Deprecated.</b> instead use <a href="#testSourceDirectories"><code>testSourceDirectories</code></a>. For version 3.0.0, this parameter is only defined to break the build if you use it!</div> - +<li><strong>Type</strong>: <code>java.util.List<java.lang.String></code></li> +<li><strong>Since</strong>: <code>2.13</code></li> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="testSourceDirectory"><section> +<h4><a name="a.3CtestSourceDirectory.3E"></a><testSourceDirectory></h4><a name="a.3CtestSourceDirectory.3E"></a></a> +<div><strong>Deprecated.</strong><br />instead use <a href="#testSourceDirectories"><code>testSourceDirectories</code></a>. For version 3.0.0, this parameter is only defined to break the build if you use it!</div><br /> <div>Specifies the location of the test source directory to be used for Checkstyle.</div> - <ul> - -<li><b>Type</b>: <code>java.io.File</code></li> - -<li><b>Since</b>: <code>2.2</code></li> - -<li><b>Required</b>: <code>No</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CtreeWalkerNames.3E"></a><b><a name="treeWalkerNames"><treeWalkerNames></a></b></h4> - +<li><strong>Type</strong>: <code>java.io.File</code></li> +<li><strong>Since</strong>: <code>2.2</code></li> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="treeWalkerNames"><section> +<h4><a name="a.3CtreeWalkerNames.3E"></a><treeWalkerNames></h4><a name="a.3CtreeWalkerNames.3E"></a></a> <div>When using custom treeWalkers, specify their names here so the checks inside the treeWalker end up the the rule-summary.</div> - <ul> - -<li><b>Type</b>: <code>java.util.List<java.lang.String></code></li> - -<li><b>Since</b>: <code>2.11</code></li> - -<li><b>Required</b>: <code>No</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CuseFile.3E"></a><b><a name="useFile"><useFile></a></b></h4> - +<li><strong>Type</strong>: <code>java.util.List<java.lang.String></code></li> +<li><strong>Since</strong>: <code>2.11</code></li> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="useFile"><section> +<h4><a name="a.3CuseFile.3E"></a><useFile></h4><a name="a.3CuseFile.3E"></a></a> <div>If <code>null</code>, the Checkstyle plugin will display violations on stdout. Otherwise, a text file will be created with the violations.</div> - <ul> - -<li><b>Type</b>: <code>java.io.File</code></li> - -<li><b>Required</b>: <code>No</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CxrefLocation.3E"></a><b><a name="xrefLocation"><xrefLocation></a></b></h4> - +<li><strong>Type</strong>: <code>java.io.File</code></li> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="xrefLocation"><section> +<h4><a name="a.3CxrefLocation.3E"></a><xrefLocation></h4><a name="a.3CxrefLocation.3E"></a></a> <div>Location of the Xrefs to link to.</div> - <ul> - -<li><b>Type</b>: <code>java.io.File</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>Default</b>: <code>${project.reporting.outputDirectory}/xref</code></li> - </ul><hr /></section><section> -<h4><a name="a.3CxrefTestLocation.3E"></a><b><a name="xrefTestLocation"><xrefTestLocation></a></b></h4> - +<li><strong>Type</strong>: <code>java.io.File</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>Default</strong>: <code>${project.reporting.outputDirectory}/xref</code></li></ul><hr /></section><a name="xrefTestLocation"><section> +<h4><a name="a.3CxrefTestLocation.3E"></a><xrefTestLocation></h4><a name="a.3CxrefTestLocation.3E"></a></a> <div>Location of the XrefTests to link to.</div> - <ul> - -<li><b>Type</b>: <code>java.io.File</code></li> - -<li><b>Required</b>: <code>No</code></li> - -<li><b>Default</b>: <code>${project.reporting.outputDirectory}/xref-test</code></li> - </ul> - </section></section> - </section> - - +<li><strong>Type</strong>: <code>java.io.File</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>Default</strong>: <code>${project.reporting.outputDirectory}/xref-test</code></li></ul></section></section></section> </main> </div> </div> @@ -1196,7 +657,7 @@ <footer> <div class="container-fluid"> <div class="row-fluid"> - <p>© 2005–2023 + <p>© 2005–2024 <a href="https://www.apache.org/";>The Apache Software Foundation</a> </p> </div>
