outil open source pour générer des Javadocs via Maven2 avec des diagrammes UML automatiques comme ydoc

Question

Je veux générer des javadocs via le plugin de génération de site de maven et je veux que les diagrammes UML automatiques soient créés et intégrés dans le javadoc.

Le projet statsvn utilise yDoc pour générer sa documentation UML mais je pense qu'il utilise Maven1. yDoc est un produit shareware commercial, donc je ne sais pas comment le projet open source statsvn s'intègre avec (ou s'il y a une version gratuite à utiliser pour la génération javadoc).

Exemple svnstat yDoc javadoc: ChurnPageMaker.java

svnstat comprend ydoc comme un plugin pour leur génération de rapport Maven1: project.xml

<reports> 
      <report>maven-ydoc-plugin</report> 
... 
    </reports> 

Le yDoc documentation dit que vous pouvez utiliser l'approche doclet javadoc personnalisé de Maven2 (mais je ne peut pas savoir où télécharger yDoc ou si c'est gratuit). Il semble que le projet statsvn utilise yDoc donc je devine que c'est gratuit? Y a-t-il d'autres générateurs de doclets Javadoc open source qui s'intègrent à Maven2 pour générer des javadocs avec des diagrammes de classes incorporés?

Answer 1

Je sais que vous voulez des documents java, mais avez-vous vérifié Doxygen? Peut-être qu'il peut faire ce que vous voulez. Voici un question comparant Javadocs et Doxygen.

Answer 2

Il semble que le APIViz doclet supporte le plugin javadoc Maven2 pour générer des diagrammes de classes dans javadoc.

<reporting> 
    ... 
    <plugins> 
     ... 
     <plugin> 
     <groupId>org.apache.maven.plugins</groupId> 
     <artifactId>maven-javadoc-plugin</artifactId> 
     <version>2.5</version> 
     <configuration> 
      <doclet>org.jboss.apiviz.APIviz</doclet> 
      <docletArtifact> 
      <groupId>org.jboss.apiviz</groupId> 
      <artifactId>apiviz</artifactId> 
      <version>1.3.0.GA</version> 
      </docletArtifact> 
      <useStandardDocletOptions>true</useStandardDocletOptions> 
      <charset>UTF-8</charset> 
      <encoding>UTF-8</encoding> 
      <docencoding>UTF-8</docencoding> 
      <breakiterator>true</breakiterator> 
      <version>true</version> 
      <author>true</author> 
      <keywords>true</keywords> 
      <additionalparam> 
      -sourceclasspath ${project.build.outputDirectory} 
      </additionalparam> 
     </configuration> 
     </plugin> 
     ... 
    </plugins> 
    ... 
    </reporting> 

Answer 3

Pour Maven 2, un coup d'oeil à http://maven.apache.org/plugins/maven-javadoc-plugin/examples/alternate-doclet.html qui décrit comment inclure UmlGraph diagrammes dans la javadoc de votre code (nécessite binaire Graphviz sur le chemin). Ci-dessous un échantillon POM en utilisant UmlGraph en tant que doclet alternatif:

<project> 
    ... 
    <reporting> (or <build>) 
    <plugins> 
     <plugin> 
     <groupId>org.apache.maven.plugins</groupId> 
     <artifactId>maven-javadoc-plugin</artifactId> 
     <version>2.6.1</version> 
     <configuration> 
      <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet> 
      <!-- <docletPath>/path/to/UmlGraph.jar</docletPath> --> 
      <docletArtifact> 
      <groupId>org.umlgraph</groupId> 
      <artifactId>doclet</artifactId> 
      <version>5.1</version> 
      </docletArtifact> 
      <additionalparam>-views</additionalparam> 
      <useStandardDocletOptions>true</useStandardDocletOptions> 
     </configuration> 
     </plugin> 
    ... 
    </plugins> 
    </reporting> (or </build>) 
    ... 
</project>