Generating Javadoc HTML documentation with diagram images from existing tags

In UML visualization, you can generate Javadoc HTML documentation with UML topic diagram images using the existing @viz.diagram tags in your comments for the top-level type of a Java source code file (a class or an interface) or for a package.html file.

You must have installed a Java Development Kit (JDK) (Sun JDK Version 1.4.2 or compatible) that contains a Javadoc executable file. You also have a Java project with Java types (classes and interfaces) or packages that have @viz.diagram tags.

To generate Javadoc HTML documentation with diagram images from existing tags:

1. In the Package Explorer view, select a Java project and click Project > Generate Javadoc with Diagrams > From Existing Tags.

2. In the Generate Javadoc wizard, on the Choose diagram image generation options page, select an image type for the diagrams.

3. To generate an automated ant script, specify a destination for the Ant Script (with diagram support).

4. Click Finish.

 

Parent topic

Generating Javadoc HTML documentation with diagram images

 

Related tasks

Automatically generating Javadoc HTML documentation with diagram images