FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
java-docs-samples/checkstyle-checker.xml at master · elad2109/java-docs-samples · GitHub
elad2109
/
java-docs-samples
Public
forked from
GoogleCloudPlatform/java-docs-samples
Notifications
You must be signed in to change notification settings
Fork
0
Star
0
Code
Pull requests
0
Actions
Projects
Wiki
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Wiki
Security and quality
Insights
Expand file tree
Breadcrumbs
java-docs-samples
/
checkstyle-checker.xml
Copy path
More file actions
More file actions
Latest commit
History
History
History
201 lines (153 loc) · 7.93 KB
Breadcrumbs
java-docs-samples
/
checkstyle-checker.xml
Copy path
File metadata and controls
201 lines (153 loc) · 7.93 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
<?
xml
version
=
"
1.0
"
?>
<!
DOCTYPE
module
PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.2//EN"
"http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
<!--
Checkstyle configuration that checks the sun coding conventions from:
- the Java Language Specification at
http://java.sun.com/docs/books/jls/second_edition/html/index.html
- the Sun Code Conventions at http://java.sun.com/docs/codeconv/
- the Javadoc guidelines at
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
- the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html
- some best practices
Checkstyle is very configurable. Be sure to read the documentation at
http://checkstyle.sf.net (or in your downloaded distribution).
Most Checks are configurable, be sure to consult the documentation.
To completely disable a check, just comment it out or delete it from the file.
Finally, it is worth reading the documentation.
-->
<
module
name
=
"
Checker
"
>
<!--
If you set the basedir property below, then all reported file
names will be relative to the specified directory. See
http://checkstyle.sourceforge.net/5.x/config.html#Checker
<property name="basedir" value="${basedir}"/>
-->
<!--
Checks whether files end with a new line.
-->
<!--
See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile
-->
<
module
name
=
"
NewlineAtEndOfFile
"
/>
<!--
Checks that property files contain the same keys.
-->
<!--
See http://checkstyle.sf.net/config_misc.html#Translation
-->
<
module
name
=
"
Translation
"
/>
<
module
name
=
"
FileLength
"
/>
<!--
Following interprets the header file as regular expressions.
-->
<!--
<module name="RegexpHeader"/>
-->
<
module
name
=
"
FileTabCharacter
"
>
<
property
name
=
"
eachLine
"
value
=
"
true
"
/>
</
module
>
<
module
name
=
"
RegexpSingleline
"
>
<!--
\s matches whitespace character, $ matches end of line.
-->
<
property
name
=
"
format
"
value
=
"
\s+$
"
/>
<
property
name
=
"
message
"
value
=
"
Line has trailing spaces.
"
/>
</
module
>
<
module
name
=
"
TreeWalker
"
>
<
property
name
=
"
cacheFile
"
value
=
"
${checkstyle.cache.file}
"
/>
<!--
required for SuppressWarningsFilter (and other Suppress* rules not used here)
-->
<!--
see http://checkstyle.sourceforge.net/config_annotation.html#SuppressWarningsHolder
-->
<
module
name
=
"
SuppressWarningsHolder
"
/>
<!--
required for SuppressWithNearbyCommentFilter
-->
<
module
name
=
"
FileContentsHolder
"
/>
<!--
Checks for Javadoc comments.
-->
<!--
See http://checkstyle.sf.net/config_javadoc.html
-->
<
module
name
=
"
JavadocMethod
"
/>
<
module
name
=
"
JavadocType
"
/>
<
module
name
=
"
JavadocVariable
"
/>
<
module
name
=
"
JavadocStyle
"
/>
<!--
Checks for Naming Conventions.
-->
<!--
See http://checkstyle.sf.net/config_naming.html
-->
<
module
name
=
"
ConstantName
"
/>
<
module
name
=
"
LocalFinalVariableName
"
/>
<
module
name
=
"
LocalVariableName
"
/>
<
module
name
=
"
MemberName
"
/>
<
module
name
=
"
MethodName
"
/>
<
module
name
=
"
PackageName
"
/>
<
module
name
=
"
ParameterName
"
/>
<
module
name
=
"
StaticVariableName
"
/>
<
module
name
=
"
TypeName
"
/>
<!--
Checks for Headers
-->
<!--
See http://checkstyle.sf.net/config_header.html
-->
<!--
<module name="Header">
-->
<!--
The follow property value demonstrates the ability
-->
<!--
to have access to ANT properties. In this case it uses
-->
<!--
the ${basedir} property to allow Checkstyle to be run
-->
<!--
from any directory within a project. See property
-->
<!--
expansion,
-->
<!--
http://checkstyle.sf.net/config.html#properties
-->
<!--
<property
-->
<!--
name="headerFile"
-->
<!--
value="${basedir}/java.header"/>
-->
<!--
</module>
-->
<!--
Checks for imports
-->
<!--
See http://checkstyle.sf.net/config_import.html
-->
<
module
name
=
"
AvoidStarImport
"
/>
<
module
name
=
"
IllegalImport
"
/>
<!--
defaults to sun.* packages
-->
<
module
name
=
"
RedundantImport
"
/>
<
module
name
=
"
UnusedImports
"
/>
<!--
Checks for Size Violations.
-->
<!--
See http://checkstyle.sf.net/config_sizes.html
-->
<
module
name
=
"
LineLength
"
/>
<
module
name
=
"
MethodLength
"
/>
<
module
name
=
"
ParameterNumber
"
/>
<!--
Checks for whitespace
-->
<!--
See http://checkstyle.sf.net/config_whitespace.html
-->
<
module
name
=
"
EmptyForIteratorPad
"
/>
<
module
name
=
"
MethodParamPad
"
/>
<
module
name
=
"
NoWhitespaceAfter
"
/>
<
module
name
=
"
NoWhitespaceBefore
"
/>
<
module
name
=
"
OperatorWrap
"
/>
<
module
name
=
"
ParenPad
"
/>
<
module
name
=
"
TypecastParenPad
"
/>
<
module
name
=
"
WhitespaceAfter
"
/>
<
module
name
=
"
WhitespaceAround
"
/>
<!--
Modifier Checks
-->
<!--
See http://checkstyle.sf.net/config_modifiers.html
-->
<
module
name
=
"
ModifierOrder
"
/>
<
module
name
=
"
RedundantModifier
"
/>
<!--
Checks for blocks. You know, those {}'s
-->
<!--
See http://checkstyle.sf.net/config_blocks.html
-->
<
module
name
=
"
AvoidNestedBlocks
"
/>
<
module
name
=
"
EmptyBlock
"
/>
<
module
name
=
"
LeftCurly
"
/>
<
module
name
=
"
NeedBraces
"
/>
<
module
name
=
"
RightCurly
"
/>
<!--
Checks for common coding problems
-->
<!--
See http://checkstyle.sf.net/config_coding.html
-->
<
module
name
=
"
AvoidInlineConditionals
"
/>
<
module
name
=
"
EmptyStatement
"
/>
<
module
name
=
"
EqualsHashCode
"
/>
<
module
name
=
"
HiddenField
"
/>
<
module
name
=
"
IllegalInstantiation
"
/>
<
module
name
=
"
InnerAssignment
"
/>
<
module
name
=
"
MagicNumber
"
/>
<
module
name
=
"
MissingSwitchDefault
"
/>
<
module
name
=
"
SimplifyBooleanExpression
"
/>
<
module
name
=
"
SimplifyBooleanReturn
"
/>
<!--
Checks for class design
-->
<!--
See http://checkstyle.sf.net/config_design.html
-->
<
module
name
=
"
FinalClass
"
/>
<
module
name
=
"
HideUtilityClassConstructor
"
/>
<
module
name
=
"
InterfaceIsType
"
/>
<
module
name
=
"
VisibilityModifier
"
/>
<!--
Miscellaneous other checks.
-->
<!--
See http://checkstyle.sf.net/config_misc.html
-->
<
module
name
=
"
ArrayTypeStyle
"
/>
<
module
name
=
"
FinalParameters
"
/>
<
module
name
=
"
TodoComment
"
/>
<
module
name
=
"
UpperEll
"
/>
<
module
name
=
"
HiddenField
"
>
<
property
name
=
"
ignoreSetter
"
value
=
"
true
"
/>
<
property
name
=
"
ignoreConstructorParameter
"
value
=
"
true
"
/>
</
module
>
</
module
>
<!--
Support @SuppressWarnings (added in Checkstyle 5.7)
-->
<!--
see http://checkstyle.sourceforge.net/config.html#SuppressWarningsFilter
-->
<
module
name
=
"
SuppressWarningsFilter
"
/>
<!--
Similar to SuppressWarningsFilter, but via comment rather than
annotation. This is needed to suppress warnings on imports, which
SuppressWarnings doesn't support.
-->
<
module
name
=
"
SuppressWithNearbyCommentFilter
"
/>
<!--
Checks properties file for a duplicated properties.
-->
<!--
See http://checkstyle.sourceforge.net/config_misc.html#UniqueProperties
-->
<
module
name
=
"
UniqueProperties
"
/>
</
module
>
Back
|
FazBrowse Home
|
New Git URL