Apache Maven Documentation Checker Plugin – Checkstyle Results

Apache > Maven > Plugins > Apache Maven Documentation Checker Plugin > Checkstyle Results

Last Published: 2015-04-03 | Version: 1.1

Overview

Examples

Sending the output to a file

Project Documentation

Project Information
Project Reports
- Surefire Report
- Checkstyle
- Source Xref
- Tag List
- JavaDocs
- FindBugs
- Sonar
- Plugin Documentation
- Invoker Build Results

Maven Projects

ASF

Built by Maven

Checkstyle Results

The following document contains the results of Checkstyle 5.7.

Summary

Files	Info	Warnings	Errors
9	3	26	0

Files

File	I	W	E
org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java	0	7	0
org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.java	0	2	0
org/apache/maven/plugin/docck/reports/AbstractDocumentationReport.java	0	2	0
org/apache/maven/plugin/docck/reports/DocumentationReport.java	3	2	0
org/apache/maven/plugin/docck/reports/DocumentationReporter.java	0	7	0
org/apache/maven/plugin/docck/reports/ErrorDocumentationReport.java	0	2	0
org/apache/maven/plugin/docck/reports/InfoDocumentationReport.java	0	2	0
org/apache/maven/plugin/docck/reports/WarningDocumentationReport.java	0	2	0

Rules

Category	Rule	Violations	Severity
coding	HiddenField ignoreConstructorParameter: `"true"` ignoreSetter: `"true"`	1	Warning
javadoc	JavadocMethod scope: `"protected"`	25	Warning
	JavadocVariable scope: `"protected"`	3	Info

Details

org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	108
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	120
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	125
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	268
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	531
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	533
Warning	coding	HiddenField	'siteDirectory' hides a field.	533

org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.java

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

org/apache/maven/plugin/docck/reports/AbstractDocumentationReport.java

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

org/apache/maven/plugin/docck/reports/DocumentationReport.java

Severity	Category	Rule	Message	Line
Info	javadoc	JavadocVariable	Missing a Javadoc comment.	27
Info	javadoc	JavadocVariable	Missing a Javadoc comment.	28
Info	javadoc	JavadocVariable	Missing a Javadoc comment.	29
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	31
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	33

org/apache/maven/plugin/docck/reports/DocumentationReporter.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	32
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	37
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	42
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	47
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	62
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	74
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	88

org/apache/maven/plugin/docck/reports/ErrorDocumentationReport.java

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

org/apache/maven/plugin/docck/reports/InfoDocumentationReport.java

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

org/apache/maven/plugin/docck/reports/WarningDocumentationReport.java

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