|  |
Documentation Enhancer for Java
A tool that enhances Javadoc documentation files with semantic information gathered by analyzing the corresponding class files.
Date Posted: October 7, 2002
|
|
|
|
|
|
This application is intended for Java developers. It provides them with extended information about libraries and applications that they obtain but don't have the source code for.
The application can also be used by Java library developers who wish to provide their clients with a richer documentation of the APIs they develop.
| | |
|
Simply create a pruned version of your Javadoc documentation that contains only the classes and packages you care about. Run the Documentation Enhancer with the pruned version as source, and use the result to overwrite a copy of the source.
| | |
|
(From the file readme.html:) The main cause of failures is erroneous Javadoc HTML files. Errors in the Javadoc HTML files result from the fact that programmers can add their own HTML tags to the Javadoc comments (which are used to generate the Javadoc files), and this is not always done correctly (consider, for example, the documentation of the method toString(double d) of class java.lang.Double in Sun's JDK 1.2.2). Besides that, incorrect parsing may result from version variations in Javadoc's output format or simply (we hate to admit) from our bugs.
When the parsing of a Javadoc HTML file fails, the original (unenhanced) file is copied unchanged to the target location. The file errors.log in the destination folder contains the list of failed files.
| | |
|
The Documentation Enhancer requires the following files:
- the analyzed component's Javadoc HTML files
- the JAR file containing the analyzed component
- the JAR and/or class files that are required by the analyzed component (such as files for classes that are superclasses of those in the analyzed component; files containing classes that are the types of fields in the analyzed component; and so forth.
- the product's own libraries, including toad.jar and serveral other JAR files that are shipped with Documentation Enhancer.
| | |
|
The information added by the Documentation Enhancer includes references to methods that could be private or could have package-level access only. These methods are normally not included in the Javadoc documentation, but they do exist. | | |
|
We have successfully run the Documentation Enhancer on the entire JDK 1.4 run-time library (over 8,000 classes and interfaces, about 2,700 of them public). Realistically, this means that the product will correctly handle almost any existing Java class library.
| | |
|
To learn more about the extension capabilities of the framework, please refer to the framework.html documentation shipped with the tool.
| |
|
|
|
|
| |
|
