It is possible to add UML diagrams to the JavaDoc generated during the build phase.
The first thing to do is to install Graphviz which is an open source graph visualization software.
After installation, add the bin folder (D:\Graphviz\bin for instance) to the PATH environment variable.
Then configure the pom.xml :
<build> <plugins> <plugin> <groupid>org.apache.maven.plugins</groupid> <artifactid>maven-javadoc-plugin</artifactid> <version>3.0.1</version> <configuration> <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet> <docletartifact> <groupid>org.umlgraph</groupid> <artifactid>umlgraph</artifactid> <version>5.6.6</version> </docletartifact> <additionalparam>-views -all</additionalparam> <doclint>none</doclint> <usestandarddocletoptions>true</usestandarddocletoptions> </configuration> <executions> <execution> <id>attach-javadocs</id> <goals> <goal>jar</goal> </goals> </execution> </executions> </plugin> </plugins> </build>
Here i chose to add the maven-javadoc-plugin to the build maven phase. In the configuration of the plugin, i added the UmlGraphDoc doclet.
UMLGraph allows the declarative specification and drawing of UML class and sequence diagrams.
Run mvn install and then check the generated JavaDoc under the folder target/site/apidocs/
Here is a sample :
The code of this project is available on my github repository :
https://github.com/longbeach/eclipseumlgraph