开源工具通过Maven2生成Javadoc，使用自动UML图如ydoc [英] open source tool to generate Javadocs through Maven2 with automatic UML diagrams like ydoc

问题描述

我想通过maven的站点生成插件生成javadoc，我想要在javadoc中创建并嵌入自动的UML图。

statsvn 项目使用 yDoc 生成他们的UML文档，但我认为他们使用的是Maven1。 yDoc是一个商业共享软件产品，所以我不确定开源的statsvn项目如何与它集成（或者如果有一个免费版本用于javadoc生成）。

示例svnstat yDoc javadoc：
ChurnPageMaker.java

svnstat包含ydoc作为Maven1报表生成的插件：
project.xml

 < reports> 
< report> maven-ydoc-plugin< / report> 
 ... 
< / reports> 
  

yDoc文档说你可以使用Maven2的自定义javadoc doclet方法（但是我无法确定哪里可以下载yDoc或者是免费的）。似乎statsvn项目正在使用yDoc，所以我猜测它是免费的？

是否有任何其他开源的Javadoc doclet生成器与Maven2集成以生成javadocs嵌入类图。

解决方案

看起来像 APIViz doclet 支持Maven2 javadoc插件，以生成javadoc中的类图。

  ;报告> 
 ... 
< plugins> 
 ... 
< plugin> 
< groupId> org.apache.maven.plugins< / groupId> 
< artifactId> maven-javadoc-plugin< / artifactId> 
< version> 2.5< / version> 
< configuration> 
< doclet> org.jboss.apiviz.APIviz< / doclet> 
< docletArtifact> 
< groupId> org.jboss.apiviz< / groupId> 
< artifactId> apiviz< / artifactId> 
< version> 1.3.0.GA< / version> 
< / docletArtifact> 
< useStandardDocletOptions> true< / useStandardDocletOptions> 
< charset> UTF-8< / charset> 
< encoding> UTF-8< / encoding> 
< docencoding> UTF-8< / docencoding> 
< breakiterator> true< / breakiterator> 
< version> true< / version> 
< author> true< / author> 
< keywords> true< / keywords> 
< additionalparam> 
 -sourceclasspath $ {project.build.outputDirectory} 
< / additionalparam> 
< / configuration> 
< / plugin> 
 ... 
< / plugins> 
 ... 
< / reporting> 
  

I want to generate javadocs through maven's site generation plugin and I want to have automatic UML diagrams created and embedded in the javadoc.

The statsvn project uses yDoc to generate their UML documentation but I think they're using Maven1. yDoc is a commercial shareware product, so I'm unsure how the open source statsvn project integrates with it (or if there is a free version to use for javadoc generation).

Example svnstat yDoc javadoc: ChurnPageMaker.java

svnstat includes ydoc as a plugin to their Maven1 report generation: project.xml

    <reports>
            <report>maven-ydoc-plugin</report>
 ...
    </reports>

The yDoc documentation says you can use Maven2's custom javadoc doclet approach (but I can't figure out where to download yDoc or if it's free). It seems like the statsvn project is using yDoc so I'm guessing it's free?

Are there any other open source Javadoc doclet generators that integrate with Maven2 to generate javadocs with embedded class diagrams.

解决方案

It looks like the APIViz doclet support Maven2 javadoc plugin to generate class diagrams in javadoc.

  <reporting>
    ...
    <plugins>
      ...
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.5</version>
        <configuration>
          <doclet>org.jboss.apiviz.APIviz</doclet>
          <docletArtifact>
            <groupId>org.jboss.apiviz</groupId>
            <artifactId>apiviz</artifactId>
            <version>1.3.0.GA</version>
          </docletArtifact>
          <useStandardDocletOptions>true</useStandardDocletOptions>
          <charset>UTF-8</charset>
          <encoding>UTF-8</encoding>
          <docencoding>UTF-8</docencoding>
          <breakiterator>true</breakiterator>
          <version>true</version>
          <author>true</author>
          <keywords>true</keywords>
          <additionalparam>
            -sourceclasspath ${project.build.outputDirectory}
          </additionalparam>
        </configuration>
      </plugin>
      ...
    </plugins>
    ...
  </reporting>

这篇关于开源工具通过Maven2生成Javadoc，使用自动UML图如ydoc的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！