Automatically generating Javadoc HTML documentation with domain modeling diagram images

You can automatically generate Javadoc HTML documentation that contains domain modeling diagram images by using the default Javadoc options and formats.

Before you begin

You must have installed a Sun Java Development Kit (JDK) Version 1.4.2 or later that contains a Javadoc executable file.

About this task

To automatically generate Javadoc HTML documentation with domain modeling diagram images, complete the following steps:

Procedure

  1. In the Package Explorer view, select a Java project and click Project > Generate Javadoc with Diagrams > Automatically.
  2. In the Generate Javadoc wizard, under Javadoc command, select the Javadoc command (an executable file).
    Note: Only a Sun JDK Version 1.4.2 or later is fully supported and ensure that you select the appropriate Javadoc executable file that comes with the Sun JDK.
  3. Under Diagrams, complete one of the following steps:
    • To include diagram images for packages, click For packages. Each package summary page contains a diagram that shows the contents of the packages.
    • To include diagram images for Java types, click For types. Each Java type (class or interface) summary page contains a diagram that shows extends, implements, usages, and inner types to one level of depth.
    • Select an Image type. Available formats are GIF, JPG, and BMP.
  4. To embed the diagram image tags in the source code, click Contribute diagrams and diagram tags to source.
  5. Click Finish.

What to do next

Note: This will insert UML diagram image tags into your source code. Now you can generate Javadoc HTML documentation by clicking Project > Generate Javadoc with Diagrams > From Existing Tags.

Feedback