Checkstyle Results
The following document contains the results of Checkstyle 9.3 with config/maven_checks.xml ruleset. 
Summary
| Files | |||
|---|---|---|---|
| 10 | 7 | 59 | 20 |
Files
Rules
| Category | Rule | Violations | Severity |
|---|---|---|---|
| coding | HiddenField
|
1 | |
MagicNumber
|
20 | ||
| javadoc | JavadocMethod
|
58 | |
JavadocVariable
|
7 |
Details
org/apache/maven/index/reader/ChunkReader.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| coding | MagicNumber | '0xff' is a magic number. | 57 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 64 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 72 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 80 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 88 | |
| coding | MagicNumber | '0xff' is a magic number. | 219 | |
| coding | MagicNumber | '127' is a magic number. | 220 | |
| coding | MagicNumber | '0xff' is a magic number. | 230 | |
| coding | MagicNumber | '0xC0' is a magic number. | 255 | |
| coding | MagicNumber | '0x3F' is a magic number. | 259 | |
| coding | MagicNumber | '0xC0' is a magic number. | 271 | |
| coding | MagicNumber | '0xC0' is a magic number. | 271 | |
| coding | MagicNumber | '0x3F' is a magic number. | 276 | |
| coding | MagicNumber | '0x3F' is a magic number. | 276 |
org/apache/maven/index/reader/ChunkWriter.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| javadoc | JavadocMethod | @return tag should be present and have description. | 70 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 78 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 86 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 94 | |
| javadoc | JavadocMethod | Expected @param tag for 'iterator'. | 94 | |
| coding | MagicNumber | '0x007F' is a magic number. | 148 | |
| coding | MagicNumber | '0x07FF' is a magic number. | 152 | |
| coding | MagicNumber | '0x007F' is a magic number. | 168 | |
| coding | MagicNumber | '0x007F' is a magic number. | 177 | |
| coding | MagicNumber | '0x07FF' is a magic number. | 182 | |
| coding | MagicNumber | '0xE0' is a magic number. | 184 | |
| coding | MagicNumber | '0x3F' is a magic number. | 185 | |
| coding | MagicNumber | '0x3F' is a magic number. | 186 | |
| coding | MagicNumber | '0xC0' is a magic number. | 190 | |
| coding | MagicNumber | '0x3F' is a magic number. | 191 |
org/apache/maven/index/reader/IndexReader.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| javadoc | JavadocMethod | @return tag should be present and have description. | 121 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 129 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 138 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 148 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 182 | |
| coding | HiddenField | 'chunkNames' hides a field. | 204 |
org/apache/maven/index/reader/IndexWriter.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| javadoc | JavadocMethod | @return tag should be present and have description. | 96 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 106 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 126 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 135 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 143 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 151 | |
| javadoc | JavadocMethod | Expected @param tag for 'iterator'. | 151 |
org/apache/maven/index/reader/Record.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| javadoc | JavadocMethod | @return tag should be present and have description. | 382 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 390 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 406 | |
| javadoc | JavadocMethod | Expected @param tag for '<T>'. | 406 | |
| javadoc | JavadocMethod | Expected @param tag for 'entryKey'. | 406 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 414 | |
| javadoc | JavadocMethod | Expected @param tag for '<T>'. | 414 | |
| javadoc | JavadocMethod | Expected @param tag for 'entryKey'. | 414 | |
| javadoc | JavadocMethod | Expected @param tag for 'value'. | 414 |
org/apache/maven/index/reader/RecordCompactor.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| javadoc | JavadocMethod | @return tag should be present and have description. | 43 | |
| javadoc | JavadocMethod | Expected @param tag for 'record'. | 43 |
org/apache/maven/index/reader/RecordExpander.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| javadoc | JavadocMethod | @return tag should be present and have description. | 46 | |
| javadoc | JavadocMethod | Expected @param tag for 'recordMap'. | 46 |
org/apache/maven/index/reader/ResourceHandler.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| javadoc | JavadocMethod | @return tag should be present and have description. | 45 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 54 |
org/apache/maven/index/reader/Utils.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| javadoc | JavadocVariable | Missing a Javadoc comment. | 50 | |
| javadoc | JavadocVariable | Missing a Javadoc comment. | 52 | |
| javadoc | JavadocVariable | Missing a Javadoc comment. | 60 | |
| javadoc | JavadocVariable | Missing a Javadoc comment. | 62 | |
| javadoc | JavadocVariable | Missing a Javadoc comment. | 64 | |
| javadoc | JavadocVariable | Missing a Javadoc comment. | 66 | |
| javadoc | JavadocVariable | Missing a Javadoc comment. | 68 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 73 | |
| javadoc | JavadocMethod | Expected @param tag for 'inputStream'. | 73 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 92 | |
| javadoc | JavadocMethod | Expected @param tag for 'resource'. | 92 | |
| javadoc | JavadocMethod | Expected @param tag for 'outputStream'. | 106 | |
| javadoc | JavadocMethod | Expected @param tag for 'properties'. | 106 | |
| javadoc | JavadocMethod | Expected @param tag for 'writableResource'. | 123 | |
| javadoc | JavadocMethod | Expected @param tag for 'properties'. | 123 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 139 | |
| javadoc | JavadocMethod | Expected @param tag for 'repoId'. | 139 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 149 | |
| javadoc | JavadocMethod | Expected @param tag for 'allGroups'. | 149 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 159 | |
| javadoc | JavadocMethod | Expected @param tag for 'rootGroups'. | 159 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 169 | |
| javadoc | JavadocMethod | Expected @param tag for 'v'. | 169 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 177 | |
| javadoc | JavadocMethod | Expected @param tag for 'v'. | 177 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 185 | |
| javadoc | JavadocMethod | Expected @param tag for 'groupId'. | 185 |
org/apache/maven/index/reader/WritableResourceHandler.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| javadoc | JavadocMethod | @return tag should be present and have description. | 51 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 61 |





