给javadoc增加uml类图

2009-08-23 10:56:08 +0800

今天准备开始写点介绍我的contact-list jar包的文章,自然要放些直观的UML图看看,google了一下,找到了一个名叫apiviz的maven插件,可以为javadoc生成uml类图。先上图看看:

uml class diagram for email importer

用起来也很方便,首先安装graphviz包

sudo apt-get install graphviz

然后修改pom.xml文件

1. 增加jboss的repository


    
        jboss.releases
        JBosss releases
        http://repository.jboss.org/maven2 
        
            true
        
        
            false
        
    

2. 修改maven-java-doc的配置


    
        
            org.apache.maven.plugins
            maven-javadoc-plugin
            2.5
            
                org.jboss.apiviz.APIviz
                
                    org.jboss.apiviz
                    apiviz
                    1.3.0.GA
                
                true
                UTF-8
                UTF-8
                UTF-8
                true
                true
                true
                true
                
                    -sourceclasspath ${project.build.outputDirectory}
                
            
        
    

最后,在生成javadoc之前必须先compile

mvn compile javadoc:javadoc

再看看新生成的javadoc吧,头部都有一张类图的哦