Skip to content

Commit 5c9a316

Browse files
committed
Merge pull request #3 from GoogleCloudPlatform/suppress
Ignore JavaDoc rules in test classes.
2 parents ac6ce48 + 8d4b9a3 commit 5c9a316

File tree

3 files changed

+31
-4
lines changed

3 files changed

+31
-4
lines changed

google-checks.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@
3838
<property name="fileExtensions" value="java, properties, xml"/>
3939
<!-- Checks for whitespace -->
4040
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
41-
<module name="FileTabCharacter">
42-
<property name="eachLine" value="true"/>
43-
</module>
41+
<module name="FileTabCharacter">
42+
<property name="eachLine" value="true"/>
43+
</module>
4444

4545
<module name="TreeWalker">
4646
<!-- Make @SuppressWarnings available to checkstyle http://stackoverflow.com/a/22556386/101923 -->

pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ limitations under the License.
6868
<configuration>
6969
<configLocation>google-checks.xml</configLocation>
7070
<consoleOutput>true</consoleOutput>
71-
<excludes>**/AutoValue_*</excludes>
7271
<failOnViolation>true</failOnViolation>
7372
<failsOnError>true</failsOnError>
7473
<includeTestSourceDirectory>true</includeTestSourceDirectory>
74+
<suppressionsLocation>suppressions.xml</suppressionsLocation>
7575
</configuration>
7676
<executions>
7777
<execution><goals><goal>check</goal></goals></execution>

suppressions.xml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?xml version="1.0"?>
2+
<!DOCTYPE suppressions PUBLIC
3+
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
4+
"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
5+
<!--
6+
Copyright 2016 Google Inc. All Rights Reserved.
7+
8+
Licensed under the Apache License, Version 2.0 (the "License");
9+
you may not use this file except in compliance with the License.
10+
You may obtain a copy of the License at
11+
12+
http://www.apache.org/licenses/LICENSE-2.0
13+
14+
Unless required by applicable law or agreed to in writing, software
15+
distributed under the License is distributed on an "AS IS" BASIS,
16+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17+
See the License for the specific language governing permissions and
18+
limitations under the License.
19+
-->
20+
<suppressions>
21+
<!-- For our tests we do not demand API documentation. -->
22+
<suppress files="[/\\]src[/\\]test[/\\]java[/\\].*\.java" checks="Javadoc.*"/>
23+
24+
<!-- Suppress checks for generated code. -->
25+
<suppress files="[/\\]target[/\\]" checks=".+"/>
26+
<suppress files=".*AutoValue_.*\.java$" checks=".+"/>
27+
</suppressions>

0 commit comments

Comments
 (0)