BIRT 3.7
Written by: Michael Williams
Featured Refcardz: Top Refcardz:
  1. Scrum
  2. Apache Maven 2
  3. Essential MySQL
  4. Node.js
  5. Groovy
  1. jQuery Selectors
  2. Ajax
  3. Java
  4. Spring Config.
  5. Java Concurrency

Link Details

Do we have to spell it out? Okay... V-O-T-E! Login and vote now.
Link 105899 thumbnail
User 168451 avatar

By aalmiray
via java.dzone.com
Published: Aug 21 2008 / 17:49

This article shows how easy and simple it is to include UML diagrams within your Javadoc and also keep them updated with every change in the source code repository.
  • 71
  • 3
  • 8346
  • 96

Comments

Add your comment
User 325182 avatar

harisgx replied ago:

0 votes Vote down Vote up Reply

this is a good resource

User 217678 avatar

mostlyharmless replied ago:

0 votes Vote down Vote up Reply

It's missing one thing:


<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>
<docletArtifact>
<groupId>org.umlgraph</groupId>
<artifactId>umlgraph</artifactId>
<version>5.0</version>
</docletArtifact>
<additionalparam>
-inferrel -inferdep -quiet -hide java.* -collpackages java.util.* -qualify -postfixpackage -nodefontsize 9 -nodefontpackagesize 7
</additionalparam>
</configuration>
</plugin>
</plugins>
</reporting>

User 185239 avatar

meeras replied ago:

0 votes Vote down Vote up Reply

Thanks, mostlyharmless.

User 172008 avatar

Dan Dyer replied ago:

0 votes Vote down Vote up Reply

Looks interesting. Does it only render inheritance/implementation relationships, or does it also show composition, aggregation, etc?

User 185239 avatar

meeras replied ago:

1 votes Vote down Vote up Reply

Yes, Daniel. It does using the following tags. I could have gone way more detailed in the article, but decided to keep it simple.
1. aggregation relationships (specified using the javadoc @has tag)
2. composition relationships (specified using the javadoc @composed tag)
3. dependency relationships (specified using the javadoc @depend tag)

User 321144 avatar

nitinaggarwalin replied ago:

0 votes Vote down Vote up Reply

I order to get it working using Maven2. Do we need to specify some goals???
I am trying to get it working with maven 2
i have added the
>
>
>
>maven-javadoc-plugin>

>2.3>
>
>org.umlgraph.doclet.UmlGraphDoc>
>
>gr.spinellis>
>UmlGraph>
>5.0>
>
>
-inferrel -inferdep -quiet -hide java.* -collpackages java.util.* -qualify -postfixpackage -nodefontsize 9
-nodefontpackagesize 7
>
>
>
>
>

to my project pom.

User 321144 avatar

nitinaggarwalin replied ago:

0 votes Vote down Vote up Reply

I order to get it working using Maven2. Do we need to specify some goals???
I am trying to get it working with maven 2
i have added the
>
>
>
>maven-javadoc-plugin>

>2.3>
>
>org.umlgraph.doclet.UmlGraphDoc>
>
>gr.spinellis>
>UmlGraph>
>5.0>
>
>
-inferrel -inferdep -quiet -hide java.* -collpackages java.util.* -qualify -postfixpackage -nodefontsize 9
-nodefontpackagesize 7
>
>
>
>
> to my project pom.

User 400505 avatar

joelp replied ago:

0 votes Vote down Vote up Reply

This is a great resource and great add on's in the comments section - thanks

Add your comment


Html tags not supported. Reply is editable for 5 minutes. Use [code lang="java|ruby|sql|css|xml"][/code] to post code snippets.