Generating Javadoc HTML documentation with domain modeling diagram images from existing tags

You can generate Javadoc HTML documentation that contains domain modeling diagram images by 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 inside a Java project.

Before you begin

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

You must be in the Java perspective.

About this task

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

Procedure

  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 Select types for Javadoc generation page, select an image type for the diagrams.
  3. To generate an automated ant script, specify a destination for the Doclet.
  4. Click Finish.

What to do next

Note: If this is the first time you generate a Javadoc HTML documentation with diagram images for your Java project and have not inserted @viz.diagram tags in the source code, you can automatically generate such documentation by clicking Project > Generate Javadoc with Diagrams > Automatically.

Feedback