Java

Sun Doc Check Doclet

 Javadoc Home Page

The SunTM Doc Check Doclet is an extension to the JavadocTM tool It runs on source code and reviews documentation comments, generating an HTML report that identifies empty comments and other ommissions and irregularities in the documentation comments. The report displays the number of doc errors, categorizes problems according to severity, and suggests text to include. (Those suggestions can then be copied into the code and edited.) It can be instructed to ignore packages and classes using wildcard patterns. An included utility package contains functionality that scans a directory tree to generate a list of packages, as well as pattern-matching classes for filenames.

Support Note - DocCheck is experimental code developed originally for internal use at Sun and released to the developer community for use as-is. It is not a supported product. Use at your own risk. While we have worked to make it useful, bugs might not be fixed and features might not be added. It might not be updated, or might be re-released with a different implementation or options or page design that is incompatible with the current design.

Download

Download the Sun Doc Check Doclet. Requires version 1.2 (or later) of the JavaTM 2 SDK, Standard Edition (J2SE).

Note:
The zip file unzips to create the directory doccheck1.2b2.

Documentation
The documentation is available online, as well as in the download bundle:

Forum

For general discussions of Javadoc issues with other third party developers, go to Forums and click on "Javadoc Tool". We at Java Software will not be monitoring this forum regularly. To send feedback to DocCheck developers, send email to the address below.

Notification of Future Releases
If you would like to be notified of further releases, please join JAVADOC-ANNOUNCE@JAVA.SUN.COM at:
Javadoc-Announce Mailing List

Feedback
Please send questions, suggestions and comments to doccheck-feedback@java.sun.com

Copyright © 2003 Sun Microsystems, Inc. All rights reserved.

Sun
Java Software