API Specification Errors
Executive Summary
for DocCheck Sample Code
Generated by DocCheck doclet, version 1.2b2,
Fri, 11 Jul 2003.
For a summary by package, see
Package Summary
For a statistical breakdown, see
Package Statistics
| Missing Comments |
|
Minor Errors Only |
|
|
|
| Package |
Number |
Percent |
| All Packages |
67 |
27% |
|
okpkg.* |
1 |
33% |
|
No Errors Found:
Explanation of Columns
- Missing Comments
- Shows the number of items that have no comment
or which have tags but no text.
- Missing Comments Percentage
- Shows the percentage for a group of packages.
For example, 1% for java.security means that.
1% of the security APIs are missing comments.
- Minor Errors
- Shows the number of items that have minor errors.
For example, a method counts as one item, although
it could be missing multiple tags.
- Minor Error Percentages
- Shows the number of items that have minor errors
divided by the total number of items.
- Note:
- The Minor Errors table contains only package groups
that have no major errors.
(The total line, however,
shows the total of all minor errors.)