forked from prometheus/client_java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcheckstyle-suppressions.xml
More file actions
32 lines (24 loc) · 1.46 KB
/
Copy pathcheckstyle-suppressions.xml
File metadata and controls
32 lines (24 loc) · 1.46 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
"-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
"https://checkstyle.org/dtds/suppressions_1_2.dtd">
<suppressions>
<!-- Suppress Javadoc paragraph formatting (empty line before <p> tag) globally. This is a
stylistic check that would require fixing hundreds of locations. We still enforce that
public APIs have documentation via other Javadoc checks. -->
<suppress checks="JavadocParagraph" files="."/>
<!-- Suppress all Javadoc checks for internal implementation packages -->
<suppress checks="Javadoc" files=".*[/\\]internal[/\\].*"/>
<!-- Suppress all Javadoc checks for example code -->
<suppress checks="Javadoc" files=".*[/\\]examples[/\\].*"/>
<!-- Suppress all Javadoc checks for benchmark code -->
<suppress checks="Javadoc" files=".*[/\\]benchmarks[/\\].*"/>
<!-- Suppress all Javadoc checks for integration tests -->
<suppress checks="Javadoc" files=".*[/\\]integration-tests[/\\].*"/>
<!-- Preserve the repository's main-source-only Checkstyle policy when Flint invokes the
standalone CLI with explicit Java files. -->
<suppress checks=".*" files=".*[/\\]src[/\\]test[/\\]java[/\\].*"/>
<suppress checks=".*" files=".*[/\\]src[/\\]archive[/\\]java[/\\].*"/>
<!-- Example setup intentionally groups declarations before the simulated work that uses them. -->
<suppress checks="VariableDeclarationUsageDistance" files=".*[/\\]examples[/\\].*"/>
</suppressions>