Javadoc Inserción de diagramas UML

Question

¿Hay alguna manera de incrustar imágenes en mi JavaDoc? Básicamente, quiero incluir algunos diagramas UML que explican la jerarquía de mis clases en algunos de los documentos.

Gracias!

Answer 1

Consulte this section de la documentación de Javadoc, que explica cómo incrustar imágenes en su Javadoc.

También, aquí hay un article que describe cómo aplicar ingeniería inversa a los diagramas UML e incrustarlos en su Javadoc usando UMLGraph.

Answer 2

Sí.

The documentation explica cómo incrustar imágenes arbitrarias en la documentación de javadoc.

Si desea generar diagramas de clases UML desde su fuente Java, eche un vistazo al UMLGraph doclet.

Answer 3

Este article explica cómo se puede hacer colocando las imágenes en una carpeta accesible para la herramienta javadoc.

Answer 4

ApiViz es un buen doclet también.

Answer 5

yDoc es una opción

Answer 6

This article muestra cómo utilizar UMLGraph con Maven plugin de Javadoc.

En resumen:

1. Instalar GraphViz.

   Ubuntu: apt-get install graphviz4.
   Windows: download.

2. Actualización pom.xml.

   <plugin> 
        <artifactId>maven-javadoc-plugin</artifactId> 
        <version>2.7</version> 
        <configuration> 
         <aggregate>true</aggregate> 
         <show>private</show> 
         <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet> 
         <docletArtifact> 
          <groupId>org.umlgraph</groupId> 
          <artifactId>doclet</artifactId> 
          <version>5.1</version> 
         </docletArtifact> 
         <additionalparam> 
          -inferrel -attributes -types -visibility -inferdep -quiet -hide java.* -collpackages java.util.* -qualify -postfixpackage 
          -nodefontsize 9 
          -nodefontpackagesize 7 
         </additionalparam> 
        </configuration> 
       </plugin> 
   

3. Run mvn javadoc:javadoc.

Answer 7

respuesta simple:

/** 
* This class does some stuff (see diagram). 
* <img src="relative/path/to/image.png" /> 
* 
*/ 
public class SomeClass{ 
}