Built by Maven

Checkstyle Results

The following document contains the results of Checkstyle 9.3 with config/maven_checks_nocodestyle.xml ruleset.

Summary

Files  Info  Warnings  Errors
14 23 55 0

Files

File  I  W  E
org/apache/maven/search/api/Record.java 5 14 0
org/apache/maven/search/api/SearchBackend.java 0 2 0
org/apache/maven/search/api/SearchEngine.java 0 2 0
org/apache/maven/search/api/SearchRequest.java 2 6 0
org/apache/maven/search/api/SearchResponse.java 0 4 0
org/apache/maven/search/api/request/BooleanQuery.java 2 5 0
org/apache/maven/search/api/request/Field.java 1 3 0
org/apache/maven/search/api/request/FieldQuery.java 1 4 0
org/apache/maven/search/api/request/Paging.java 2 6 0
org/apache/maven/search/api/request/Query.java 1 3 0
org/apache/maven/search/api/support/SearchBackendSupport.java 2 0 0
org/apache/maven/search/api/support/SearchResponseSupport.java 3 0 0
org/apache/maven/search/api/transport/Java11HttpClientTransport.java 4 0 0
org/apache/maven/search/api/transport/Transport.java 0 6 0

Rules

Category Rule Violations Severity
javadoc JavadocMethod
  • accessModifiers: "public, protected"
 55  Warning
JavadocVariable
  • scope: "protected"
 23  Info

Details

org/apache/maven/search/api/Record.java

Severity Category Rule Message Line
 Info javadoc JavadocVariable Missing a Javadoc comment. 33
 Info javadoc JavadocVariable Missing a Javadoc comment. 35
 Info javadoc JavadocVariable Missing a Javadoc comment. 37
 Info javadoc JavadocVariable Missing a Javadoc comment. 39
 Info javadoc JavadocVariable Missing a Javadoc comment. 41
 Warning javadoc JavadocMethod @return tag should be present and have description. 54
 Warning javadoc JavadocMethod @return tag should be present and have description. 61
 Warning javadoc JavadocMethod @return tag should be present and have description. 69
 Warning javadoc JavadocMethod @return tag should be present and have description. 77
 Warning javadoc JavadocMethod @return tag should be present and have description. 84
 Warning javadoc JavadocMethod @return tag should be present and have description. 91
 Warning javadoc JavadocMethod @return tag should be present and have description. 98
 Warning javadoc JavadocMethod Expected @param tag for 'field'. 98
 Warning javadoc JavadocMethod @return tag should be present and have description. 105
 Warning javadoc JavadocMethod Expected @param tag for 'field'. 105
 Warning javadoc JavadocMethod @return tag should be present and have description. 112
 Warning javadoc JavadocMethod Expected @param tag for 'field'. 112
 Warning javadoc JavadocMethod @return tag should be present and have description. 119
 Warning javadoc JavadocMethod Expected @param tag for 'field'. 119

org/apache/maven/search/api/SearchBackend.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod @return tag should be present and have description. 30
 Warning javadoc JavadocMethod @return tag should be present and have description. 35

org/apache/maven/search/api/SearchEngine.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod @return tag should be present and have description. 30
 Warning javadoc JavadocMethod Expected @param tag for 'searchRequest'. 30

org/apache/maven/search/api/SearchRequest.java

Severity Category Rule Message Line
 Info javadoc JavadocVariable Missing a Javadoc comment. 30
 Info javadoc JavadocVariable Missing a Javadoc comment. 32
 Warning javadoc JavadocMethod Expected @param tag for 'query'. 37
 Warning javadoc JavadocMethod Expected @param tag for 'paging'. 44
 Warning javadoc JavadocMethod Expected @param tag for 'query'. 44
 Warning javadoc JavadocMethod @return tag should be present and have description. 52
 Warning javadoc JavadocMethod @return tag should be present and have description. 59
 Warning javadoc JavadocMethod @return tag should be present and have description. 66

org/apache/maven/search/api/SearchResponse.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod @return tag should be present and have description. 30
 Warning javadoc JavadocMethod @return tag should be present and have description. 35
 Warning javadoc JavadocMethod @return tag should be present and have description. 41
 Warning javadoc JavadocMethod @return tag should be present and have description. 46

org/apache/maven/search/api/request/BooleanQuery.java

Severity Category Rule Message Line
 Info javadoc JavadocVariable Missing a Javadoc comment. 27
 Info javadoc JavadocVariable Missing a Javadoc comment. 29
 Warning javadoc JavadocMethod @return tag should be present and have description. 40
 Warning javadoc JavadocMethod @return tag should be present and have description. 47
 Warning javadoc JavadocMethod @return tag should be present and have description. 66
 Warning javadoc JavadocMethod Expected @param tag for 'left'. 66
 Warning javadoc JavadocMethod Expected @param tag for 'rights'. 66

org/apache/maven/search/api/request/Field.java

Severity Category Rule Message Line
 Info javadoc JavadocVariable Missing a Javadoc comment. 31
 Warning javadoc JavadocMethod @return tag should be present and have description. 40
 Warning javadoc JavadocMethod @return tag should be present and have description. 48
 Warning javadoc JavadocMethod Expected @param tag for 'record'. 48

org/apache/maven/search/api/request/FieldQuery.java

Severity Category Rule Message Line
 Info javadoc JavadocVariable Missing a Javadoc comment. 27
 Warning javadoc JavadocMethod @return tag should be present and have description. 37
 Warning javadoc JavadocMethod @return tag should be present and have description. 49
 Warning javadoc JavadocMethod Expected @param tag for 'fieldName'. 49
 Warning javadoc JavadocMethod Expected @param tag for 'query'. 49

org/apache/maven/search/api/request/Paging.java

Severity Category Rule Message Line
 Info javadoc JavadocVariable Missing a Javadoc comment. 25
 Info javadoc JavadocVariable Missing a Javadoc comment. 27
 Warning javadoc JavadocMethod Expected @param tag for 'pageSize'. 32
 Warning javadoc JavadocMethod Expected @param tag for 'pageOffset'. 32
 Warning javadoc JavadocMethod Expected @param tag for 'pageSize'. 46
 Warning javadoc JavadocMethod @return tag should be present and have description. 53
 Warning javadoc JavadocMethod @return tag should be present and have description. 60
 Warning javadoc JavadocMethod @return tag should be present and have description. 67

org/apache/maven/search/api/request/Query.java

Severity Category Rule Message Line
 Info javadoc JavadocVariable Missing a Javadoc comment. 27
 Warning javadoc JavadocMethod @return tag should be present and have description. 36
 Warning javadoc JavadocMethod @return tag should be present and have description. 48
 Warning javadoc JavadocMethod Expected @param tag for 'queryString'. 48

org/apache/maven/search/api/support/SearchBackendSupport.java

Severity Category Rule Message Line
 Info javadoc JavadocVariable Missing a Javadoc comment. 29
 Info javadoc JavadocVariable Missing a Javadoc comment. 31

org/apache/maven/search/api/support/SearchResponseSupport.java

Severity Category Rule Message Line
 Info javadoc JavadocVariable Missing a Javadoc comment. 33
 Info javadoc JavadocVariable Missing a Javadoc comment. 35
 Info javadoc JavadocVariable Missing a Javadoc comment. 37

org/apache/maven/search/api/transport/Java11HttpClientTransport.java

Severity Category Rule Message Line
 Info javadoc JavadocVariable Missing a Javadoc comment. 40
 Info javadoc JavadocVariable Missing a Javadoc comment. 42
 Info javadoc JavadocVariable Missing a Javadoc comment. 80
 Info javadoc JavadocVariable Missing a Javadoc comment. 82

org/apache/maven/search/api/transport/Transport.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod @return tag should be present and have description. 47
 Warning javadoc JavadocMethod Expected @param tag for 'serviceUri'. 47
 Warning javadoc JavadocMethod Expected @param tag for 'headers'. 47
 Warning javadoc JavadocMethod @return tag should be present and have description. 52
 Warning javadoc JavadocMethod Expected @param tag for 'serviceUri'. 52
 Warning javadoc JavadocMethod Expected @param tag for 'headers'. 52