Checkstyle Results

The following document contains the results of Checkstyle 6.18 with config/maven_checks.xml ruleset. 

Summary

Files	Info	Warnings	Errors
6	0	33	0

Files

File	I	W	E
org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java	0	4	0
org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java	0	1	0
org/apache/maven/doxia/siterenderer/Renderer.java	0	20	0
org/apache/maven/doxia/siterenderer/RenderingContext.java	0	3	0
org/apache/maven/doxia/siterenderer/SiteRenderingContext.java	0	1	0
org/apache/maven/doxia/siterenderer/SkinResourceLoader.java	0	4	0

Rules

Category	Rule	Violations	Severity
javadoc	JavadocMethod scope: "protected"	33	Warning

Details

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

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	Unused @param tag for 'sink'.	533
Warning	javadoc	JavadocMethod	Expected an @return tag.	537
Warning	javadoc	JavadocMethod	Expected @param tag for 'renderingContext'.	537
Warning	javadoc	JavadocMethod	Expected an @return tag.	621

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

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	73

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

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	Expected @param tag for 'skin'.	100
Warning	javadoc	JavadocMethod	Expected @param tag for 'attributes'.	100
Warning	javadoc	JavadocMethod	Expected @param tag for 'decoration'.	100
Warning	javadoc	JavadocMethod	Expected @param tag for 'defaultWindowTitle'.	101
Warning	javadoc	JavadocMethod	Expected @param tag for 'locale'.	101
Warning	javadoc	JavadocMethod	Expected @throws tag for 'RendererException'.	102
Warning	javadoc	JavadocMethod	Expected @param tag for 'templateFile'.	119
Warning	javadoc	JavadocMethod	Expected @param tag for 'attributes'.	119
Warning	javadoc	JavadocMethod	Expected @param tag for 'decoration'.	120
Warning	javadoc	JavadocMethod	Expected @param tag for 'defaultWindowTitle'.	120
Warning	javadoc	JavadocMethod	Expected @param tag for 'locale'.	121
Warning	javadoc	JavadocMethod	Expected @param tag for 'siteRenderingContext'.	133
Warning	javadoc	JavadocMethod	Expected @param tag for 'resourcesDirectory'.	133
Warning	javadoc	JavadocMethod	Expected @param tag for 'outputDirectory'.	133
Warning	javadoc	JavadocMethod	Expected @param tag for 'siteRenderingContext'.	144
Warning	javadoc	JavadocMethod	Expected @param tag for 'outputDirectory'.	144
Warning	javadoc	JavadocMethod	Expected @param tag for 'siteRenderingContext'.	156
Warning	javadoc	JavadocMethod	Unused @param tag for 'mark'.	163
Warning	javadoc	JavadocMethod	Expected @param tag for 'siteRenderingContext'.	169
Warning	javadoc	JavadocMethod	Expected @param tag for 'editable'.	169

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

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	58
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	80
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	86

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

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	Expected @param tag for 'rootDirectory'.	469

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

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	44
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	48
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	116
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	121