Generating Javadoc HTML documentation with diagram images

In UML visualization, you can generate Javadoc HTML documentation with UML topic diagram images to provide more information about the source code.

You can integrate diagram images into Javadoc HTML documentation in parallel with the source code inside Java projects by including the @viz.diagram tag. This tag can define a specific diagram image to appear in Javadoc HTML documentation. There is a specific format for the tags, for example, @viz.diagram class_diagram.dnx that inserts an image of the contents of class_diagram.dnx into Javadoc HTML documentation.

For example, you can specify that the tool produces Javadoc HTML documentation for particular classes, shows the author of the code in a prominent way, and displays a simple UML diagram with some aspects of the inheritance hierarchy of the classes. Some of the usage relationships with other classes might help increase your understanding of the source code.

You can generate diagram images in the bitmap format (.bmp), the Graphic Interchange Format (.gif), or the Joint Photographic Experts Group format (.jpeg or .jpg).

Automatically generating Javadoc HTML documentation with diagram images
In UML visualization, you can automatically generate Javadoc HTML documentation with UML topic diagram images by using the default Javadoc options and formats.

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.

 

Parent topic

Examining structures and relationships of Java applications by using UML class diagrams

 

Related tasks

Customizing the Java visual design tool
Creating UML class diagrams
Populating class diagrams
Managing relationships between Java elements