Checkstyle Results
The following document contains the results of Checkstyle 9.3 with config/maven_checks.xml ruleset. 
Summary
| Files | |||
|---|---|---|---|
| 10 | 0 | 50 | 1 |
Files
Rules
| Category | Rule | Violations | Severity |
|---|---|---|---|
| coding | MagicNumber
|
1 | |
| javadoc | JavadocMethod
|
50 |
Details
org/apache/maven/search/Record.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| javadoc | JavadocMethod | @return tag should be present and have description. | 61 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 69 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 78 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 87 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 95 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 103 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 111 | |
| javadoc | JavadocMethod | Expected @param tag for 'field'. | 111 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 119 | |
| javadoc | JavadocMethod | Expected @param tag for 'field'. | 119 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 127 | |
| javadoc | JavadocMethod | Expected @param tag for 'field'. | 127 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 135 | |
| javadoc | JavadocMethod | Expected @param tag for 'field'. | 135 |
org/apache/maven/search/SearchBackend.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| javadoc | JavadocMethod | @return tag should be present and have description. | 32 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 37 |
org/apache/maven/search/SearchEngine.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| javadoc | JavadocMethod | @return tag should be present and have description. | 32 | |
| javadoc | JavadocMethod | Expected @param tag for 'searchRequest'. | 32 |
org/apache/maven/search/SearchRequest.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| javadoc | JavadocMethod | Expected @param tag for 'query'. | 39 | |
| coding | MagicNumber | '50' is a magic number. | 41 | |
| javadoc | JavadocMethod | Expected @param tag for 'paging'. | 47 | |
| javadoc | JavadocMethod | Expected @param tag for 'query'. | 47 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 56 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 64 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 72 |
org/apache/maven/search/SearchResponse.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| javadoc | JavadocMethod | @return tag should be present and have description. | 32 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 37 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 43 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 48 |
org/apache/maven/search/request/BooleanQuery.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| javadoc | JavadocMethod | @return tag should be present and have description. | 43 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 51 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 74 | |
| javadoc | JavadocMethod | Expected @param tag for 'left'. | 74 | |
| javadoc | JavadocMethod | Expected @param tag for 'rights'. | 74 |
org/apache/maven/search/request/Field.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. | 53 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 62 | |
| javadoc | JavadocMethod | Expected @param tag for 'record'. | 62 |
org/apache/maven/search/request/FieldQuery.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| javadoc | JavadocMethod | @return tag should be present and have description. | 44 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 58 | |
| javadoc | JavadocMethod | Expected @param tag for 'fieldName'. | 58 | |
| javadoc | JavadocMethod | Expected @param tag for 'query'. | 58 |
org/apache/maven/search/request/Paging.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| javadoc | JavadocMethod | Expected @param tag for 'pageSize'. | 34 | |
| javadoc | JavadocMethod | Expected @param tag for 'pageOffset'. | 34 | |
| javadoc | JavadocMethod | Expected @param tag for 'pageSize'. | 51 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 59 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 67 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 75 |
org/apache/maven/search/request/Query.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| javadoc | JavadocMethod | @return tag should be present and have description. | 39 | |
| javadoc | JavadocMethod | @return tag should be present and have description. | 53 | |
| javadoc | JavadocMethod | Expected @param tag for 'queryString'. | 53 |





