Question

我想通过maven的网站生成插件生成javadocs，我希望在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 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

对于Maven 2，请查看http://maven.apache.org/plugins/maven-javadoc-plugin/examples/alternate-doclet.html，其中介绍了如何在代码的javadoc中包含UmlGraph图表（在PATH上需要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吗？也许它可以做你想要的。这是question比较Javadocs和Doxygen。

开源工具，通过Maven2生成Javadocs，使用自动UML图表，如ydoc

3 个答案: