Handschrifthead

Chapter 7. Generation of Class Diagrams

If you install graphviz on your computer, dbdoclet creates class diagrams of every class for you. The class diagrams show the inheritance path and all implemented interfaces of the class.

Example 7.1. Example for a class diagram


The creation of the class diagrams is controlled by two properties. The first show.inheritancePath controls wether a diagram should be used at all. If this property is set to true (this is the default!) a textual representation of the class and its superclasses is created. Instead of this textual representation you can tell dbdoclet to create the class diagrams as UML diagrams. Therefore you have to set the property program.dot.cmd to a value like "/usr/bin/dot" -T${type} -o${out} ${file}. The property specifies the command line for the dot tool from the graphviz package. If the path to the dot executable contains spaces, you must protect the path with double quotes. dbdoclet will now use the specified dot command line to create the class diagrams.

You can control the formats of created images with the property imagedata.formats,e.g. imagedata.formats=png,jpg. This creates a mediaobject tag with two nested imageobject/imagedata tags, one for png and the other one for jpg. Additionally dbdoclet will use dot to create the class diagrams as png and jpg files. You must keep care not to use formats which dot doesn't support! I use imagedata.formats=png,jpg for HTML and PDF and imagedata.formats=eps for Postscript output. But this can depend on the transformation tools you are using.

java.net