checkstyle-suppressions.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
  ~ Copyright (c) 2020 Wasiq Bhamla
  ~
  ~ Licensed under the Apache License, Version 2.0 (the "License");
  ~ you may not use this file except in compliance with the License.
  ~ You may obtain a copy of the License at
  ~
  ~     http://www.apache.org/licenses/LICENSE-2.0
  ~
  ~ Unless required by applicable law or agreed to in writing, software
  ~ distributed under the License is distributed on an "AS IS" BASIS,
  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  ~ See the License for the specific language governing permissions and
  ~ limitations under the License.
  -->
<!DOCTYPE suppressions PUBLIC
        "-//Checkstyle//DTD SuppressionFilter Configuration 1.1//EN"
        "https://checkstyle.org/dtds/suppressions_1_1.dtd">
<suppressions>
  <!-- ##### Suppressions for Javadoc in Test classes ##### -->
  <suppress checks="JavadocMethod" files="src[/\\]test[/\\]java"/>
  <suppress checks="JavadocType" files="src[/\\]test[/\\]java"/>
  <!-- Disables 'final' keyword rule on variables and method parameters -->
  <suppress checks="FinalLocalVariable" files="src[/\\]test[/\\]java"/>
  <suppress checks="FinalParameters" files="src[/\\]test[/\\]java"/>

  <!-- ##### Suppressions for generated source files ##### -->
  <suppress checks=".*" files="[/\\]target[/\\]"/>

  <!-- Disables Javadoc requirement for all public methods. This suppression
       is not recommended, but may be needed (temporarily) to allow checkstyle
       to be applied to existing codebases. -->
  <suppress checks="JavadocMethod" files="src[/\\]main[/\\]java"/>

  <!-- Disables 'final' keyword rule on variables and method parameters -->
  <!-- <suppress checks="FinalLocalVariable" files="src[/\\]main[/\\]java"/>
  <suppress checks="FinalParameters" files="src[/\\]main[/\\]java"/> -->
</suppressions>