Checkstyle Results

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

Summary

Files  Info  Warnings  Errors
6 1 9 0

Files

File  I  W  E
org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java 1 0 0
org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java 0 2 0
org/apache/maven/doxia/siterenderer/DocumentRenderer.java 0 1 0
org/apache/maven/doxia/siterenderer/DocumentRenderingContext.java 0 2 0
org/apache/maven/doxia/siterenderer/SiteRenderer.java 0 3 0
org/apache/maven/doxia/siterenderer/SiteRenderingContext.java 0 1 0

Rules

Category Rule Violations Severity
coding HiddenField
  • ignoreConstructorParameter: "true"
  • setterCanReturnItsClass: "true"
  • ignoreSetter: "true"
2  Warning
javadoc JavadocMethod
  • accessModifiers: "public, protected"
7  Warning
JavadocVariable
  • scope: "protected"
1  Info

Details

org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java

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

org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java

Severity Category Rule Message Line
 Warning coding HiddenField 'siteRenderer' hides a field. 181
 Warning coding HiddenField 'siteRenderer' hides a field. 212

org/apache/maven/doxia/siterenderer/DocumentRenderer.java

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

org/apache/maven/doxia/siterenderer/DocumentRenderingContext.java

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

org/apache/maven/doxia/siterenderer/SiteRenderer.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod @return tag should be present and have description. 108
 Warning javadoc JavadocMethod Expected @param tag for 'siteRenderingContext'. 110
 Warning javadoc JavadocMethod Expected @param tag for 'editable'. 110

org/apache/maven/doxia/siterenderer/SiteRenderingContext.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Expected @param tag for 'siteDirectory'. 339