API Specification Errors
Main Page


This report contains the following pages:
Executive Summary
Shows the number of missing comments and the percentage for package groups (e.g. java.awt.*). Also shows the number of minor errors for packages that have no major (missing comment) errors.
Package Summary
For each package, shows the number of missing comments and the number of minor errors, along with percentages.
Package Statistics
Shows the kinds of errors found in each package, the number and kind of items that were inspected (classes, methods, etc.), and provides a statistical breakdown of the errors.


Errors Identified by DocCheck
Requirements for Writing API Specifications
How to Write Doc Comments for Javadoc