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

通过Maven2生成Javadoc的开源工具,带有像ydoc这样的自动UML图,java,maven-2,documentation,uml,javadoc,Java,Maven 2,Documentation,Uml,Javadoc,我想通过maven的站点生成插件生成javadoc,我想在javadoc中创建并嵌入自动UML图 该项目使用生成UML文档,但我认为他们使用的是Maven1。yDoc是一个商业共享软件产品,因此我不确定开源statsvn项目如何与之集成(或者是否有用于生成javadoc的免费版本) 示例svnstat yDoc javadoc: svnstat将ydoc作为插件包含在其Maven1报告生成中: maven ydoc插件 ... 声明说您可以使用Maven2的定制JavadocDoclet

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

该项目使用生成UML文档,但我认为他们使用的是Maven1。yDoc是一个商业共享软件产品,因此我不确定开源statsvn项目如何与之集成(或者是否有用于生成javadoc的免费版本)

示例svnstat yDoc javadoc:

svnstat将ydoc作为插件包含在其Maven1报告生成中:


maven ydoc插件
...
声明说您可以使用Maven2的定制JavadocDoclet方法(但我不知道在哪里下载yDoc或者它是否免费)。看起来statsvn项目正在使用yDoc,所以我猜它是免费的


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

我知道您想要java docs,但您签出了吗?也许它可以做你想做的事。下面是一个比较Javadocs和Doxygen的例子。

它看起来像是支持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>

...
...
org.apache.maven.plugins
maven javadoc插件
2.5
org.jboss.apiviz.apiviz
org.jboss.apiviz
阿皮维兹
1.3.0.GA
真的
UTF-8
UTF-8
UTF-8
真的
真的
真的
真的
-sourceclasspath${project.build.outputDirectory}
...
...

对于Maven 2,看一看哪个描述了如何在代码的javadoc中包含图表(路径上需要Graphviz二进制文件)。下面是使用UmlGraph作为备用文档的示例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>

...
(或)
org.apache.maven.plugins
maven javadoc插件
2.6.1
org.umlgraph.doclet.UmlGraphDoc
org.umlgraph
doclet
5.1
-观点
真的
...
(或)
...
<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>