Javadoc Inserting UML Diagrams

Question

Is there a way to embed images into my JavaDoc? Basically i want to include some UML diagrams explaining the hierarchy of my classes in some of the documentation.

Thanks!

+1 I wish I would have asked this myself! – KLE Sep 11 '09 at 14:27 — KLE, Sep 11 '09 at 14:27

score 24 · Accepted Answer · edited Jan 16 '21 at 02:29

24

Check out this section of the Javadoc documentation, which explains how to embed images in your Javadoc.

Also, here is an article describing how to reverse engineer UML diagrams and embed them in your Javadoc using UMLGraph.

edited Jan 16 '21 at 02:29

Invitor

125
1
9

answered Sep 11 '09 at 14:24

Adamski

54,009
15
113
152

UML Graph url is broken, changed owner – Mashimom Jun 02 '18 at 22:18

score 8 · Answer 2 · edited Jul 03 '13 at 19:49

8

Yes.

The documentation explains how to embed arbitrary images to javadoc documentation.

If you want to generate UML class diagrams from your Java source, have a look at the UMLGraph doclet.

edited Jul 03 '13 at 19:49

Steve Siebert

1,874
12
18

answered Sep 11 '09 at 14:24

laalto

150,114
66
286
303

Also this article on using UML Graph http://java.dzone.com/articles/reverse-engineer-source-code-u – pjp Sep 11 '09 at 14:35

score 5 · Answer 3 · edited Mar 23 '16 at 10:03

This article shows how to use UMLGraph with Maven Javadoc plugin.

In short:

Install GraphViz.

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

Update 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>

Run mvn javadoc:javadoc.

Clearly the easiest approach! Should add a profile for building these so you don't break other ppl's builds that don't have GraphViz in the path. — Joseph Lust, Aug 16 '13 at 17:49

score 3 · Answer 4 · answered Oct 07 '09 at 10:25

3

ApiViz is a nice doclet too.

answered Oct 07 '09 at 10:25

elhoim

6,705
2
23
29

score 3 · Answer 5 · answered Feb 03 '14 at 03:31

3

Simple Answer:

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

answered Feb 03 '14 at 03:31

Sileria

15,223
4
49
28

score 2 · Answer 6 · answered Jan 04 '11 at 16:39

2

yDoc is an option

answered Jan 04 '11 at 16:39

yegor256

102,010
123
446
597

1

USD 269.00 for a single user license. – liftarn Sep 11 '13 at 14:16
Is there OpenSource/free alternative for C#? – hellboy Jan 20 '14 at 16:30

score 0 · Answer 7 · edited Jul 03 '13 at 19:50

0

This article explains how it can be done by placing your images in a folder accessible to the javadoc tool.

edited Jul 03 '13 at 19:50

Steve Siebert

1,874
12
18

answered Sep 11 '09 at 14:25

Vincent Ramdhanie

102,349
23
137
192

Javadoc Inserting UML Diagrams

7 Answers7

Linked