Thats why i want to show you a different approach: Letting a Javadoc Doclet draw the Class Diagrams in build phase and embed them into your javadoc automatically. UMLGraph is such a doclet. It analyzes your code, draws Class Diagrams automatically and embed them into your javadoc.
Since maven can run javadoc at build phase it's perfect. You just have to configurate the maven-javadoc-plugin to use UMLGraph.
Configurate Maven to use UMLGraph
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
<reporting> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>2.9</version> <configuration> <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet> <docletArtifact> <groupId>org.umlgraph</groupId> <artifactId>umlgraph</artifactId> <version>5.6</version> </docletArtifact> <additionalparam>-views -all</additionalparam> <useStandardDocletOptions>true</useStandardDocletOptions> </configuration> </plugin> </plugins> </reporting>
Beware that the javadoc doclet api has changed from jdk 1.6 to jdk 1.7 and most of the online tutorials are outdated because of that. UMLGraph adapted to jdk 1.7 since version 5.5.
If we run mvn site right now, we will just get that error:
java.io.IOException: Cannot run program "dot": java.io.IOException: error=2, No such file or directory
This means that the program dot was not found which is a part of the graphviz library.
Install GraphvizFor UMLGraph to run you need graphviz installed. Go to the Download Page, and choose your package. On linux you could even sudo aptget install graphviz. Beware that you might have to reboot or relogin to use graphviz, because the Systems Path is extended during installation.
First ResultRun mvn site, and open target/site/apidocs/index.html afterwards.
As you can see its drawing beautiful and accurate UML Class Diagrams.
Custom ConfigurationIf you dont want attributes/methods or other extras you are totally free to configurate those graphs. See Class Diagram Options. Just add them to the
<additionalparam>-views -all</additionalparam>tag in pom.xml
If you like this, also take a look at plantuml.ReplyDelete
PlantUML allows to create a diagram in pseudo-code. You have a number of ways to generate the actual images from it, including the maven site plugin or in javadoc:
The advantage of this is that you can write the UML in your IDE and include it in your sources, you don't need to switch to a different environment. And if you IDE can detect class names in text files during refactorings, it will also follow class renames in your plantUML files.
Wow, I didnt know that and i totally like it!! Awesome, thx!Delete
Great way to document your source code. I would like to try this in languages other than Java.ReplyDelete