1   <?xml version="1.0"?>
2   <!DOCTYPE module PUBLIC
3           "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
4           "https://checkstyle.org/dtds/configuration_1_3.dtd">
5   
6   <module name = "Checker">
7       <property name="charset" value="UTF-8"/>
8   
9       <!-- do not change severity to 'error', as that will hide errors caused by exceptions -->
10      <property name="severity" value="warning"/>
11  
12      <!-- haltOnException is required for exception fixes and reporting of all exceptions -->
13      <property name="haltOnException" value="false"/>
14  
15      <!-- BeforeExecutionFileFilters is required for sources of java9 -->
16      <module name="BeforeExecutionExclusionFileFilter">
17          <property name="fileNamePattern" value="module\-info\.java$" />
18      </module>
19  
20      <module name="TreeWalker">
21          <!-- We intentionally ignore all Java parse errors in regression reports.
22               Projects often use syntax newer than Checkstyle supports, so parse
23               failures must not appear as diffs or violations. Stacktrace format
24               changes would also create noisy diffs, so we suppress them entirely. -->
25          <property name="skipFileOnJavaParseException" value="true"/>
26          <property name="javaParseExceptionSeverity" value="ignore"/>
27  
28          <module name="JavadocMethod">
29              <property name="id" value="example1"/>
30          </module>
31  
32          <module name="JavadocMethod">
33              <property name="accessModifiers" value="public"/>
34              <property name="allowMissingParamTags" value="true"/>
35              <property name="id" value="example2"/>
36          </module>
37  
38          <module name="JavadocMethod">
39              <property name="accessModifiers" value="private, package"/>
40              <property name="id" value="example3"/>
41          </module>
42  
43          <module name="JavadocMethod">
44              <property name="allowMissingReturnTag" value="true"/>
45              <property name="id" value="example4"/>
46          </module>
47  
48          <module name="JavadocMethod">
49              <property name="allowedAnnotations" value="Deprecated"/>
50              <property name="id" value="example5"/>
51          </module>
52  
53          <module name="JavadocMethod">
54              <property name="id" value="example6"/>
55              <property name="tokens" value="CTOR_DEF"/>
56          </module>
57  
58          <module name="JavadocMethod">
59              <property name="id" value="example7"/>
60              <property name="validateThrows" value="true"/>
61          </module>
62  
63          <module name="JavadocMethod">
64              <property name="allowInlineReturn" value="true"/>
65              <property name="id" value="example8"/>
66          </module>
67  
68          <!-- suppress javadoc parsing errors, as we test Check not a parser -->
69          <module name="SuppressionXpathSingleFilter">
70              <property name="message" value="Javadoc comment at column \d+ has parse error"/>
71          </module>
72      </module>
73  
74  </module>