|
20 | 20 | - some best practices |
21 | 21 |
|
22 | 22 | Checkstyle is very configurable. Be sure to read the documentation at |
23 | | - http://checkstyle.sf.net (or in your downloaded distribution). |
| 23 | + https://checkstyle.sourceforge.io (or in your downloaded distribution). |
24 | 24 |
|
25 | 25 | Most Checks are configurable, be sure to consult the documentation. |
26 | 26 |
|
|
42 | 42 | <property name="fileExtensions" value="java, properties, xml"/> |
43 | 43 |
|
44 | 44 | <!-- Checks that a package-info.java file exists for each package. --> |
45 | | - <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage |
| 45 | + <!-- See https://checkstyle.sourceforge.io/config_javadoc.html#JavadocPackage |
46 | 46 | <module name="JavadocPackage"/> |
47 | 47 | --> |
48 | 48 |
|
49 | 49 | <!-- Checks whether files end with a new line. --> |
50 | | - <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile --> |
| 50 | + <!-- See https://checkstyle.sourceforge.io/config_misc.html#NewlineAtEndOfFile --> |
51 | 51 | <module name="NewlineAtEndOfFile"/> |
52 | 52 |
|
53 | 53 | <!-- Checks that property files contain the same keys. --> |
54 | | - <!-- See http://checkstyle.sf.net/config_misc.html#Translation --> |
| 54 | + <!-- See https://checkstyle.sourceforge.io/config_misc.html#Translation --> |
55 | 55 | <module name="Translation"/> |
56 | 56 |
|
57 | 57 | <!-- Checks for Size Violations. --> |
58 | | - <!-- See http://checkstyle.sf.net/config_sizes.html --> |
| 58 | + <!-- See https://checkstyle.sourceforge.io/config_sizes.html --> |
59 | 59 | <module name="FileLength"/> |
60 | 60 |
|
61 | 61 | <!-- Checks for whitespace --> |
62 | | - <!-- See http://checkstyle.sf.net/config_whitespace.html --> |
| 62 | + <!-- See https://checkstyle.sourceforge.io/config_whitespace.html --> |
63 | 63 | <module name="FileTabCharacter"/> |
64 | 64 |
|
65 | 65 | <!-- Miscellaneous other checks. --> |
66 | | - <!-- See http://checkstyle.sf.net/config_misc.html --> |
| 66 | + <!-- See https://checkstyle.sourceforge.io/config_misc.html --> |
67 | 67 | <module name="RegexpSingleline"> |
68 | 68 | <property name="format" value="\s+$"/> |
69 | 69 | <property name="minimum" value="0"/> |
70 | 70 | <property name="maximum" value="0"/> |
71 | 71 | <property name="message" value="Line has trailing spaces."/> |
72 | 72 | </module> |
73 | 73 |
|
74 | | - <!-- See http://checkstyle.sf.net/config_sizes.html --> |
| 74 | + <!-- See https://checkstyle.sourceforge.io/config_sizes.html --> |
75 | 75 | <module name="LineLength"> |
76 | 76 | <property name="max" value="100"/> |
77 | 77 | <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://|^\\*"/> |
78 | 78 | </module> |
79 | 79 |
|
80 | 80 | <!-- Checks for Headers --> |
81 | | - <!-- See http://checkstyle.sf.net/config_header.html --> |
| 81 | + <!-- See https://checkstyle.sourceforge.io/config_header.html --> |
82 | 82 | <!-- <module name="Header"> --> |
83 | 83 | <!-- <property name="headerFile" value="${checkstyle.header.file}"/> --> |
84 | 84 | <!-- <property name="fileExtensions" value="java"/> --> |
|
87 | 87 | <module name="TreeWalker"> |
88 | 88 |
|
89 | 89 | <!-- Checks for Javadoc comments. --> |
90 | | - <!-- See http://checkstyle.sf.net/config_javadoc.html --> |
| 90 | + <!-- See https://checkstyle.sourceforge.io/config_javadoc.html --> |
91 | 91 | <module name="JavadocMethod"> |
92 | | - <property name="scope" value="public" /> |
| 92 | + <property name="accessModifiers" value="public" /> |
93 | 93 | </module> |
94 | 94 | <module name="MissingJavadocMethod"> |
95 | 95 | <property name="scope" value="public" /> |
|
103 | 103 | <module name="JavadocStyle"/> |
104 | 104 |
|
105 | 105 | <!-- Checks for Naming Conventions. --> |
106 | | - <!-- See http://checkstyle.sf.net/config_naming.html --> |
| 106 | + <!-- See https://checkstyle.sourceforge.io/config_naming.html --> |
107 | 107 | <!-- <module name="ConstantName"/> --> |
108 | 108 | <module name="LocalFinalVariableName"/> |
109 | 109 | <module name="LocalVariableName"/> |
|
115 | 115 | <module name="TypeName"/> |
116 | 116 |
|
117 | 117 | <!-- Checks for imports --> |
118 | | - <!-- See http://checkstyle.sf.net/config_import.html --> |
| 118 | + <!-- See https://checkstyle.sourceforge.io/config_import.html --> |
119 | 119 | <module name="AvoidStarImport"/> |
120 | 120 | <module name="IllegalImport"/> <!-- defaults to sun.* packages --> |
121 | 121 | <module name="RedundantImport"/> |
|
137 | 137 | </module> |
138 | 138 |
|
139 | 139 | <!-- Checks for whitespace --> |
140 | | - <!-- See http://checkstyle.sf.net/config_whitespace.html --> |
| 140 | + <!-- See https://checkstyle.sourceforge.io/config_whitespace.html --> |
141 | 141 | <module name="EmptyForIteratorPad"/> |
142 | 142 | <module name="GenericWhitespace"/> |
143 | 143 | <module name="MethodParamPad"/> |
|
150 | 150 | <module name="WhitespaceAround"/> |
151 | 151 |
|
152 | 152 | <!-- Modifier Checks --> |
153 | | - <!-- See http://checkstyle.sf.net/config_modifiers.html --> |
| 153 | + <!-- See https://checkstyle.sourceforge.io/config_modifiers.html --> |
154 | 154 | <module name="ModifierOrder"/> |
155 | 155 | <module name="RedundantModifier"/> |
156 | 156 |
|
157 | 157 | <!-- Checks for blocks. You know, those {}'s --> |
158 | | - <!-- See http://checkstyle.sf.net/config_blocks.html --> |
| 158 | + <!-- See https://checkstyle.sourceforge.io/config_blocks.html --> |
159 | 159 | <module name="AvoidNestedBlocks"/> |
160 | 160 | <module name="EmptyBlock"/> |
161 | 161 | <module name="LeftCurly"/> |
162 | 162 | <module name="NeedBraces"/> |
163 | 163 | <module name="RightCurly"/> |
164 | 164 |
|
165 | 165 | <!-- Checks for common coding problems --> |
166 | | - <!-- See http://checkstyle.sf.net/config_coding.html --> |
| 166 | + <!-- See https://checkstyle.sourceforge.io/config_coding.html --> |
167 | 167 | <!--<module name="AvoidInlineConditionals"/> --> |
168 | 168 | <module name="EmptyStatement"/> |
169 | 169 | <module name="EqualsHashCode"/> |
|
177 | 177 | <module name="SimplifyBooleanReturn"/> |
178 | 178 |
|
179 | 179 | <!-- Checks for class design --> |
180 | | - <!-- See http://checkstyle.sf.net/config_design.html --> |
| 180 | + <!-- See https://checkstyle.sourceforge.io/config_design.html --> |
181 | 181 | <!-- <module name="DesignForExtension"/> --> |
182 | 182 | <module name="FinalClass"/> |
183 | 183 | <module name="HideUtilityClassConstructor"/> |
184 | 184 | <module name="InterfaceIsType"/> |
185 | 185 | <!--<module name="VisibilityModifier"/> --> |
186 | 186 |
|
187 | 187 | <!-- Miscellaneous other checks. --> |
188 | | - <!-- See http://checkstyle.sf.net/config_misc.html --> |
| 188 | + <!-- See https://checkstyle.sourceforge.io/config_misc.html --> |
189 | 189 | <module name="ArrayTypeStyle"/> |
190 | 190 | <!--<module name="TodoComment"/> --> |
191 | 191 | <module name="UpperEll"/> |
|
0 commit comments