Javadoc Вставка UML-диаграмм

Question

Есть ли способ встроить изображения в мой JavaDoc? По сути, я хочу включить некоторые UML-диаграммы, объясняющие иерархию моих классов, в некоторую документацию.

Спасибо!

Answer 1

Ознакомьтесь с этим разделом документации Javadoc, в котором объясняется, как вставлять изображения в Javadoc.

Кроме того, вот статья, описывающая, как перепроектировать UML-диаграммы и встраивать их в ваш Javadoc с помощью UMLGraph.

Answer 2

Да.

В документации объясняется, как встраивать произвольные изображения в документацию Javadoc.

Если вы хотите сгенерировать диаграммы классов UML из своего исходного кода Java, взгляните на доклет UMLGraph.

Answer 3

В этой статье показано, как использовать UMLGraph с плагином Maven Javadoc.

Короче:

1. Установите GraphViz.

   Ubuntu: apt-get install graphviz4,
   Windows: скачать.

2. Обновите 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. Бежать mvn javadoc:javadoc,

Answer 4

Простой ответ:

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

Answer 5

ApiViz тоже хороший доклет.

Answer 6

yDoc - это опция

Answer 7

В этой статье объясняется, как это можно сделать, поместив изображения в папку, доступную для инструмента Javadoc.