|
1 | 1 | <?xml version="1.0"?> |
2 | 2 | <!DOCTYPE module PUBLIC |
3 | | - "-//Puppy Crawl//DTD Check Configuration 1.3//EN" |
4 | | - "http://www.puppycrawl.com/dtds/configuration_1_3.dtd"> |
| 3 | + "-//Puppy Crawl//DTD Check Configuration 1.3//EN" |
| 4 | + "http://www.puppycrawl.com/dtds/configuration_1_3.dtd"> |
5 | 5 |
|
6 | 6 | <!-- |
7 | | - Checkstyle configuration that checks the Google coding conventions from Google Java Style |
8 | | - that can be found at https://google.github.io/styleguide/javaguide.html. |
| 7 | +
|
| 8 | + Checkstyle configuration that checks the Google coding conventions from: |
| 9 | +
|
| 10 | + - Google Java Style |
| 11 | + https://google-styleguide.googlecode.com/svn-history/r130/trunk/javaguide.html |
9 | 12 |
|
10 | 13 | Checkstyle is very configurable. Be sure to read the documentation at |
11 | 14 | http://checkstyle.sf.net (or in your downloaded distribution). |
12 | 15 |
|
| 16 | + Most Checks are configurable, be sure to consult the documentation. |
| 17 | +
|
13 | 18 | To completely disable a check, just comment it out or delete it from the file. |
14 | 19 |
|
15 | 20 | Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov. |
| 21 | +
|
16 | 22 | --> |
17 | 23 |
|
18 | 24 | <module name = "Checker"> |
|
23 | 29 | <property name="fileExtensions" value="java, properties, xml"/> |
24 | 30 | <!-- Checks for whitespace --> |
25 | 31 | <!-- See http://checkstyle.sf.net/config_whitespace.html --> |
26 | | - <module name="FileTabCharacter"> |
27 | | - <property name="eachLine" value="true"/> |
28 | | - </module> |
| 32 | + <module name="FileTabCharacter"> |
| 33 | + <property name="eachLine" value="true"/> |
| 34 | + </module> |
29 | 35 |
|
30 | 36 | <module name="TreeWalker"> |
31 | 37 | <module name="OuterTypeFilename"/> |
|
65 | 71 | <property name="allowEmptyTypes" value="true"/> |
66 | 72 | <property name="allowEmptyLoops" value="true"/> |
67 | 73 | <message key="ws.notFollowed" |
68 | | - value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/> |
69 | | - <message key="ws.notPreceded" |
70 | | - value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/> |
| 74 | + value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/> |
| 75 | + <message key="ws.notPreceded" |
| 76 | + value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/> |
71 | 77 | </module> |
72 | 78 | <module name="OneStatementPerLine"/> |
73 | 79 | <module name="MultipleVariableDeclarations"/> |
|
91 | 97 | <module name="PackageName"> |
92 | 98 | <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/> |
93 | 99 | <message key="name.invalidPattern" |
94 | | - value="Package name ''{0}'' must match pattern ''{1}''."/> |
| 100 | + value="Package name ''{0}'' must match pattern ''{1}''."/> |
95 | 101 | </module> |
96 | 102 | <module name="TypeName"> |
97 | 103 | <message key="name.invalidPattern" |
98 | | - value="Type name ''{0}'' must match pattern ''{1}''."/> |
| 104 | + value="Type name ''{0}'' must match pattern ''{1}''."/> |
99 | 105 | </module> |
100 | 106 | <module name="MemberName"> |
101 | 107 | <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/> |
102 | 108 | <message key="name.invalidPattern" |
103 | | - value="Member name ''{0}'' must match pattern ''{1}''."/> |
| 109 | + value="Member name ''{0}'' must match pattern ''{1}''."/> |
104 | 110 | </module> |
105 | 111 | <module name="ParameterName"> |
106 | 112 | <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/> |
107 | 113 | <message key="name.invalidPattern" |
108 | | - value="Parameter name ''{0}'' must match pattern ''{1}''."/> |
109 | | - </module> |
110 | | - <module name="CatchParameterName"> |
111 | | - <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/> |
112 | | - <message key="name.invalidPattern" |
113 | | - value="Catch parameter name ''{0}'' must match pattern ''{1}''."/> |
| 114 | + value="Parameter name ''{0}'' must match pattern ''{1}''."/> |
114 | 115 | </module> |
115 | 116 | <module name="LocalVariableName"> |
116 | 117 | <property name="tokens" value="VARIABLE_DEF"/> |
117 | 118 | <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/> |
118 | 119 | <property name="allowOneCharVarInForLoop" value="true"/> |
119 | 120 | <message key="name.invalidPattern" |
120 | | - value="Local variable name ''{0}'' must match pattern ''{1}''."/> |
| 121 | + value="Local variable name ''{0}'' must match pattern ''{1}''."/> |
121 | 122 | </module> |
122 | 123 | <module name="ClassTypeParameterName"> |
123 | 124 | <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/> |
124 | 125 | <message key="name.invalidPattern" |
125 | | - value="Class type name ''{0}'' must match pattern ''{1}''."/> |
| 126 | + value="Class type name ''{0}'' must match pattern ''{1}''."/> |
126 | 127 | </module> |
127 | 128 | <module name="MethodTypeParameterName"> |
128 | 129 | <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/> |
129 | 130 | <message key="name.invalidPattern" |
130 | | - value="Method type name ''{0}'' must match pattern ''{1}''."/> |
| 131 | + value="Method type name ''{0}'' must match pattern ''{1}''."/> |
131 | 132 | </module> |
132 | 133 | <module name="NoFinalizer"/> |
133 | 134 | <module name="GenericWhitespace"> |
134 | 135 | <message key="ws.followed" |
135 | | - value="GenericWhitespace ''{0}'' is followed by whitespace."/> |
136 | | - <message key="ws.preceded" |
137 | | - value="GenericWhitespace ''{0}'' is preceded with whitespace."/> |
138 | | - <message key="ws.illegalFollow" |
139 | | - value="GenericWhitespace ''{0}'' should followed by whitespace."/> |
140 | | - <message key="ws.notPreceded" |
141 | | - value="GenericWhitespace ''{0}'' is not preceded with whitespace."/> |
| 136 | + value="GenericWhitespace ''{0}'' is followed by whitespace."/> |
| 137 | + <message key="ws.preceded" |
| 138 | + value="GenericWhitespace ''{0}'' is preceded with whitespace."/> |
| 139 | + <message key="ws.illegalFollow" |
| 140 | + value="GenericWhitespace ''{0}'' should followed by whitespace."/> |
| 141 | + <message key="ws.notPreceded" |
| 142 | + value="GenericWhitespace ''{0}'' is not preceded with whitespace."/> |
142 | 143 | </module> |
143 | 144 | <module name="Indentation"> |
144 | 145 | <property name="basicOffset" value="4"/> |
|
174 | 175 | </module> |
175 | 176 | <module name="NonEmptyAtclauseDescription"/> |
176 | 177 | <module name="JavadocTagContinuationIndentation"/> |
177 | | - <module name="SummaryJavadoc"> |
| 178 | + <module name="SummaryJavadocCheck"> |
178 | 179 | <property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/> |
179 | 180 | </module> |
180 | 181 | <module name="JavadocParagraph"/> |
|
194 | 195 | <module name="MethodName"> |
195 | 196 | <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/> |
196 | 197 | <message key="name.invalidPattern" |
197 | | - value="Method name ''{0}'' must match pattern ''{1}''."/> |
| 198 | + value="Method name ''{0}'' must match pattern ''{1}''."/> |
198 | 199 | </module> |
199 | 200 | <module name="SingleLineJavadoc"> |
200 | 201 | <property name="ignoreInlineTags" value="false"/> |
|
0 commit comments