Checkstyle Results

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

Summary

Files  Info  Warnings  Errors
13 11 17 7

Files

File  I  W  E
org/apache/maven/doxia/index/IndexEntry.java 9 1 0
org/apache/maven/doxia/index/IndexingSink.java 0 2 0
org/apache/maven/doxia/parser/AbstractParser.java 0 1 0
org/apache/maven/doxia/parser/AbstractParserTest.java 0 2 0
org/apache/maven/doxia/parser/AbstractXmlParser.java 0 2 0
org/apache/maven/doxia/parser/Xhtml5BaseParser.java 0 0 3
org/apache/maven/doxia/parser/Xhtml5BaseParserTest.java 0 0 1
org/apache/maven/doxia/sink/impl/AbstractSink.java 0 1 0
org/apache/maven/doxia/sink/impl/AbstractSinkTest.java 0 3 0
org/apache/maven/doxia/sink/impl/SinkEventElement.java 0 1 0
org/apache/maven/doxia/sink/impl/Xhtml5BaseSink.java 0 0 3
org/apache/maven/doxia/sink/impl/Xhtml5BaseSinkTest.java 0 3 0
org/apache/maven/doxia/xsd/AbstractXmlValidator.java 2 1 0

Rules

Category Rule Violations Severity
coding HiddenField
  • ignoreConstructorParameter: "true"
  • setterCanReturnItsClass: "true"
  • ignoreSetter: "true"
8  Warning
javadoc JavadocMethod
  • accessModifiers: "public, protected"
9  Warning
JavadocVariable
  • scope: "protected"
11  Info
naming MethodName 4  Error
sizes MethodLength 3  Error

Details

org/apache/maven/doxia/index/IndexEntry.java

Severity Category Rule Message Line
 Info javadoc JavadocVariable Missing a Javadoc comment. 68
 Info javadoc JavadocVariable Missing a Javadoc comment. 69
 Info javadoc JavadocVariable Missing a Javadoc comment. 70
 Info javadoc JavadocVariable Missing a Javadoc comment. 71
 Info javadoc JavadocVariable Missing a Javadoc comment. 72
 Info javadoc JavadocVariable Missing a Javadoc comment. 73
 Info javadoc JavadocVariable Missing a Javadoc comment. 74
 Info javadoc JavadocVariable Missing a Javadoc comment. 75
 Info javadoc JavadocVariable Missing a Javadoc comment. 76
 Warning coding HiddenField 'hasAnchor' hides a field. 195

org/apache/maven/doxia/index/IndexingSink.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Expected @param tag for 'rootEntry'. 69
 Warning coding HiddenField 'type' hides a field. 262

org/apache/maven/doxia/parser/AbstractParser.java

Severity Category Rule Message Line
 Warning coding HiddenField 'emitAnchors' hides a field. 128

org/apache/maven/doxia/parser/AbstractParserTest.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Unused @param tag for 'file'. 272
 Warning javadoc JavadocMethod Expected @param tag for 'text'. 276

org/apache/maven/doxia/parser/AbstractXmlParser.java

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

org/apache/maven/doxia/parser/Xhtml5BaseParser.java

Severity Category Rule Message Line
 Error sizes MethodLength Method baseStartTag length is 276 lines (max allowed is 150). 200
 Error sizes MethodLength Method baseEndTag length is 163 lines (max allowed is 150). 494
 Error naming MethodName Name 'verbatim_' must match pattern '^[a-z][a-zA-Z0-9]*$'. 916

org/apache/maven/doxia/parser/Xhtml5BaseParserTest.java

Severity Category Rule Message Line
 Error sizes MethodLength Method semanticTags length is 156 lines (max allowed is 150). 621

org/apache/maven/doxia/sink/impl/AbstractSink.java

Severity Category Rule Message Line
 Warning coding HiddenField 'locator' hides a field. 429

org/apache/maven/doxia/sink/impl/AbstractSinkTest.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Unused @param tag for 'text'. 1648
 Warning javadoc JavadocMethod Expected @param tag for 'comment'. 1653
 Warning javadoc JavadocMethod Expected @param tag for 'paragraph'. 1653

org/apache/maven/doxia/sink/impl/SinkEventElement.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Expected @param tag for 'lineNumber'. 48

org/apache/maven/doxia/sink/impl/Xhtml5BaseSink.java

Severity Category Rule Message Line
 Error naming MethodName Name 'onSection_' must match pattern '^[a-z][a-zA-Z0-9]*$'. 351
 Error naming MethodName Name 'onSectionTitle_' must match pattern '^[a-z][a-zA-Z0-9]*$'. 398
 Error naming MethodName Name 'tableCell_' must match pattern '^[a-z][a-zA-Z0-9]*$'. 1131

org/apache/maven/doxia/sink/impl/Xhtml5BaseSinkTest.java

Severity Category Rule Message Line
 Warning coding HiddenField 'attributes' hides a field. 1196
 Warning coding HiddenField 'attributes' hides a field. 1212
 Warning coding HiddenField 'attributes' hides a field. 1222

org/apache/maven/doxia/xsd/AbstractXmlValidator.java

Severity Category Rule Message Line
 Info javadoc JavadocVariable Missing a Javadoc comment. 58
 Info javadoc JavadocVariable Missing a Javadoc comment. 60
 Warning coding HiddenField 'xmlReader' hides a field. 192