Generating Javadoc HTML documentation with domain modeling diagram images

You can generate Javadoc HTML documentation that contains domain modeling diagram images to provide more information about the source code inside Java projects.

About this task

You can integrate domain modeling 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 domain modeling diagram with some aspects of the inheritance hierarchy of the classes inside a Java project. Some of the usage relationships with other classes might help increase your understanding of the source code inside the project.

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).


Feedback