[dna-dev] Adding umlgraph to our javadoc

[Randall Hauch]

This is a new rewrite of the UmlGraph library, created by Trustin Lee: http://code.google.com/p/apiviz/ 
.  Stefano, would you mind taking a look and reporting back how this  
compares with UmlGraph?  I suspect it will be added to the JBoss Maven  
repository relatively soon, so the repository fragment in the POM  
sample would not be required.

Best regards,

Randall

On Jun 26, 2008, at 4:36 AM, Stefano Maestri wrote:

> I tried to add UmlGraph generated images to dna project javadocs.
> The result is nice: http://www.javalinuxlabs.org/apidocs/index.html
> I attached here the only modification needed to pom.xml to get this  
> result.
> UmlGraph can also model composition relation with custom javadocs  
> tags, but, IMHO the totally automatic results is fine and easy for  
> all.
> Also public method can be added to the model, but I think it's  
> better to have easy to read structural model and leave to javadoc  
> deeper descriptions of class components and methods.
>
> The only problem with UmlGraph is that it depends on GraphViz, and  
> this dependencies can't be administered by maven, since graphvz  
> isn't a java package. UmlGraph just expect GraphViz instaed on  
> building host and fails if it isn't. I didn't find any elegant and  
> brief way to solve the problem: any suggestion?
>
> BTW have Hudson's host GraphViz installed? Is this strong unmanaged  
> dependency acceptable for javadoc target?
>
> IMHO enriched javadocs is nice and could help a lot community to  
> understand our sw architecture/class hierarchy. At least they helped  
> me :)
>
> best regards
> S.
> Index: pom.xml
> ===================================================================
> --- pom.xml	(revision 306)
> +++ pom.xml	(working copy)
> @@ -182,6 +182,20 @@
> 					<version>2.2</version>
> 					<configuration>
> 						<aggregate>true</aggregate>
> +						
> +                     
> <doclet>gr.spinellis.umlgraph.doclet.UmlGraphDoc</doclet>
> +                    <docletArtifact>
> +                        <groupId>gr.spinellis</groupId>
> +                        <artifactId>UmlGraph</artifactId>
> +                        <version>4.6</version>
> +                    </docletArtifact>
> +                    <additionalparam>
> +                        -inferrel -inferdep -quiet -hide java.* - 
> collpackages java.util.* -qualify
> +                        -postfixpackage -nodefontsize 9
> +                        -nodefontpackagesize 7
> +                    </additionalparam>
> +
> +						
> 					</configuration>
> 				</plugin>
> 			</plugins>
> @@ -425,6 +439,12 @@
> 				<version>10.2.1.6</version>
> 				<scope>test</scope>
> 			</dependency>
> +			<dependency>
> +  <groupId>gr.spinellis</groupId>
> +  <artifactId>UmlGraph</artifactId>
> +  <version>4.8</version>
> +</dependency>
> +			
> 		</dependencies>
> 	</dependencyManagement>
> 	<reporting>
> _______________________________________________
> dna-dev mailing list
> dna-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/dna-dev