Automatically generating Javadoc HTML documentation with UML diagram images

You can automatically generate Javadoc HTML documentation with Unified Modeling Language (UML) diagram images by using the default Javadoc options and formats.

You must have installed a Java™ Development Kit (JDK) (Sun JDK Version 1.4.2 or compatible) that contains a Javadoc executable file.
To automatically generate Javadoc HTML documentation with UML diagram images:
  1. In the Package Explorer view, select a Java project and click Project > Generate Javadoc with Diagrams > Automatically.
  2. In the Generate Javadoc wizard, select the Javadoc command (the executable file); then complete the following steps:
    • To include diagram images for packages, click For packages. Every package summary page contains a diagram image showing the content of the packages.
    • To include diagram images for Java types, click For types. Every Java type (class or interface) summary page contains a diagram showing extends, implements, usages, and inner types to one level of depth.
    • Select an Image type. Available formats are GIF, JPG, and BMP.
  3. To place the diagram images in the code and include new diagram image tags, click Contribute diagrams and diagram tags to source.
  4. Click Finish.
Note: This will alter the code and insert UML diagram images into your project. Now you can generate Javadoc HTML documentation by clicking Project > Generate Javadoc with Diagrams > From Existing Tags.
Related tasks
Generating Javadoc HTML documentation with UML diagram images from existing tags
Feedback
(C) Copyright IBM Corporation 2000, 2005. All Rights Reserved.