Skip to content

Instantly share code, notes, and snippets.

@0guzhan
Created August 18, 2023 00:49
Show Gist options
  • Save 0guzhan/c36ebf85d5da55fa45c9c1be9c3cb3c0 to your computer and use it in GitHub Desktop.
Save 0guzhan/c36ebf85d5da55fa45c9c1be9c3cb3c0 to your computer and use it in GitHub Desktop.
How to fully disable javadoc checking with checkstyle maven plugin?
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE suppressions PUBLIC
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
<suppressions>
<!-- Suppressions for Javadoc rules -->
<suppress checks="InvalidJavadocPosition" files="."/>
<suppress checks="JavadocTagContinuationIndentation" files="."/>
<suppress checks="SummaryJavadoc" files="."/>
<suppress checks="JavadocParagraph" files="."/>
<suppress checks="JavadocMethod" files="."/>
<suppress checks="MissingJavadocMethod" files="."/>
<suppress checks="MissingJavadocType" files="."/>
<suppress checks="SingleLineJavadoc" files="."/>
</suppressions>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>${maven-checkstyle-plugin.version}</version>
<dependencies>
<dependency>
<groupId>com.puppycrawl.tools</groupId>
<artifactId>checkstyle</artifactId>
<version>${puppycrawl-checkstyle.version}</version>
</dependency>
</dependencies>
<configuration>
<!--
https://raw.githubusercontent.com/checkstyle/checkstyle/master/src/main/resources/google_checks.xml
-->
<configLocation>google_checks.xml</configLocation>
<suppressionsLocation>google_checks_suppressions.xml</suppressionsLocation>
<inputEncoding>UTF-8</inputEncoding>
<outputEncoding>UTF-8</outputEncoding>
<consoleOutput>true</consoleOutput>
<includeTestSourceDirectory>true</includeTestSourceDirectory>
<linkXRef>false</linkXRef>
<failsOnError>false</failsOnError>
<failOnViolation>false</failOnViolation>
<violationSeverity>warning</violationSeverity>
</configuration>
<executions>
<execution>
<id>validate</id>
<phase>validate</phase>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment