Get a quick overview for development via UML-diagrams embedded into the Javadoc

[Udo Kuehne]

Hint: If you have installed Graphviz on os "windows 7" (maybe too for vista) the check existing of font "HelveticaNeue Extended". Maybe download the Zip-archive here HelveticaNeue. You should use drag and drop copy in the explorer to install the fonts from Zip-archive into the win7-directory "C:\Windows\Fonts".

You should prepare/extend the Maven project configuration first (main) pom.xml file, for more background information see Apache Maven and UmlGraphDoc:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <configuration>
        <show>public</show>
        <quiet>true</quiet>

        <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>
        <docletArtifact>
            <groupId>org.umlgraph</groupId>
            <artifactId>umlgraph</artifactId>
            <version>5.6</version>
        </docletArtifact>

        <useStandardDocletOptions>true</useStandardDocletOptions>
        <additionalparam>
            -inferrel -inferdep -quiet 
            -hide java.* -hide javax.swing.* -hide org.eclipse.*  
            -collpackages java.util.* -postfixpackage 
            -nodefonttagsize 6 -nodefontsize 9 -nodefontpackagesize 8 
            -edgefontname "HelveticaNeue BlackExt" 
            -nodefontabstractname "HelveticaNeue ThinExt" 
            -nodefontclassabstractname "HelveticaNeue LightExt" 
            -nodefontclassname "HelveticaNeue BlackExt"
            -nodefontname "HelveticaNeue Extended" 
            -nodefontpackagename "HelveticaNeue Extended"
            -nodefonttagname "HelveticaNeue ThinExt" 
            -types -visibility -operations -constructors -enumerations 
                       -enumconstants -views
        </additionalparam>
    </configuration>
</plugin>

Then you executes follow command into, see Apache Maven:

  mvn -am -pl modules\jconsole-plugin clean compile javadoc:javadoc

Wait some minutes ..., then go to the generated Javadoc and the double click on "index.html":

  modules\jconsole-plugin\target\site\apidocs\index.html

The generated output sample UML-Image embedded into the javadoc is located at:

  [<DEV_SRC>\modules\jconsole-plugin\target\site\apidocs\net\sf\hibernate\jconsole\AbstractStatisticsContext.png](https://sourceforge.net/p/hibernate-jcons/discussion/1045023/thread/c20db8d4/bdf7/attachment/AbstractStatisticsContext.png)

:D Many THANKS to Graphviz, UMLGraph and Apache Maven :D

[Udo Kuehne]

sample UML-Image AbstractStatisticsContext.png