通过Maven2生成Javadoc的开源工具，带有像ydoc这样的自动UML图

Question

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

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 documentation说你可以使用maven2的自定义javadoc doclet方法(但我不知道从哪里下载yDoc，或者它是否免费)。看起来statsvn项目使用的是yDoc，所以我猜它是免费的？

还有没有其他开源的Javadoc doclet生成器可以与Maven2集成来生成带有嵌入式类图的Javadoc？

Answer 1

看起来像是APIViz doclet支持Maven2 javadoc插件来生成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>

Answer 2

对于Maven2，可以看看http://maven.apache.org/plugins/maven-javadoc-plugin/examples/alternate-doclet.html，它描述了如何在代码的javadoc中包含UmlGraph图(路径中需要Graphviz二进制文件)。下面是一个使用UmlGraph作为替代doclet的示例POM：

<project>
  ...
  <reporting> (or <build>)
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.6.1</version>
        <configuration>
          <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>
          <!-- <docletPath>/path/to/UmlGraph.jar</docletPath> -->
          <docletArtifact>
            <groupId>org.umlgraph</groupId>
            <artifactId>doclet</artifactId>
            <version>5.1</version>
          </docletArtifact>
          <additionalparam>-views</additionalparam>
          <useStandardDocletOptions>true</useStandardDocletOptions>
        </configuration>
      </plugin>
    ...
    </plugins>
  </reporting> (or </build>)
  ...
</project>

Answer 3

我知道你想要java文档，但是你看过Doxygen了吗？也许它可以做你想做的事。这是一个比较Javadoc和Doxygen的question。