Comment générer des diagrammes de classe UML dans la Javadoc avec Maven

Nous allons voir dans cet article comment générer avec Maven des diagrammes de classe UML.
Ces diagrammes seront ensuite accessible directement dans la Javadoc.

Installer Graphviz

Cf. http://www.graphviz.org/
L’exécutable « dot » doit se trouver ensuite dans votre Path. C’est cet utilitaire qui va générer les images .png.

Ajouter la configuration suivante dans votre pom.xml

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<source>1.6</source>
<aggregate>true</aggregate>
<doclet>gr.spinellis.umlgraph.doclet.UmlGraphDoc</doclet>
<docletArtifact>
<groupId>gr.spinellis</groupId>
<artifactId>UmlGraph</artifactId>
<version>4.6</version>
</docletArtifact>
<additionalparam>
-inferrel
-inferdep
-quiet
-constructors
-visibility
-types
-postfixpackage
-nodefontsize 9
-nodefontpackagesize 7
</additionalparam>
</configuration>
</plugin>
</plugins>
</build>

Lancer la commande « mvn javadoc:javadoc »

Et le tour est joué 🙂

Vous devriez trouver dans la javadoc générée les diagrammes UML des classes de votre application…

Poster un commentaire ou un rétrolien.

Commentaires

  • Fabrice L.  De décembre 21, 2009 à 12:50

    Tutorial simple et rapide merci!
    Si comme moi vous ne lisez que le code maven, pensez vraiment à installer Graphviz, ça fait gagner du temps (erreur map)…

    Sinon voici un petit paramètre qui peut être pratique si vous ne souhaitez pas voir s’afficher les classes String, Long etc…

    -hide java.lang.*

  • François Petitit  De décembre 21, 2009 à 1:31

    Merci pour votre commentaire et pour l’astuce, indispensable 🙂

Répondre

Entrez vos coordonnées ci-dessous ou cliquez sur une icône pour vous connecter:

Logo WordPress.com

Vous commentez à l’aide de votre compte WordPress.com. Déconnexion /  Changer )

Photo Google

Vous commentez à l’aide de votre compte Google. Déconnexion /  Changer )

Image Twitter

Vous commentez à l’aide de votre compte Twitter. Déconnexion /  Changer )

Photo Facebook

Vous commentez à l’aide de votre compte Facebook. Déconnexion /  Changer )

Connexion à %s

%d blogueurs aiment cette page :