오픈 소스 도구로 yadoc과 같은 자동 UML 다이어그램으로 Maven2를 통해 Javadocs를 생성합니다.

Question

메이븐 사이트 생성 플러그인을 통해 javadocs를 생성하고 javadoc에 자동 UML 다이어그램을 만들고 싶습니다.

statsvn 프로젝트는 yDoc을 사용하여 UML 문서를 생성하지만 저는 Maven1을 사용하고 있다고 생각합니다. yDoc은 상용 셰어웨어 제품이므로 공개 소스 인 statsvn 프로젝트가 어떻게 통합되는지 (또는 javadoc 생성에 사용할 무료 버전이 있는지) 확실하지 않습니다. yDoc javadoc의 svnstat

예 : ChurnPageMaker.java

svnstat는 Maven1 보고서 생성에 플러그인으로 ydoc을 포함한다 : ( project.xml

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

yDoc documentation 당신이 Maven2의 사용자 정의 javadoc의 도크 렛의 방법을 사용할 수 있다고 전하지만, yDoc을 어디에서 다운로드 할 것인지 또는 무료인지는 알 수 없습니다.) statsvn 프로젝트가 yDoc을 사용하고있어 무료라고 추측하고있는 것 같습니다.

포함 된 클래스 다이어그램이있는 javadoc을 생성하기 위해 Maven2와 통합되는 다른 오픈 소스 Javadoc 도크 렛 생성기가 있습니까?

Answer 1

자바 문서를 원하지만 Doxygen을 체크 아웃 했습니까? 아마도 그것은 당신이 원하는 것을 할 수 있습니다. Javadocs와 Doxygen을 비교하면 question입니다.

Answer 2

javadoc에서 클래스 다이어그램을 생성하는 데는 APIViz doclet Maven2 javadoc 플러그인을 지원하는 것처럼 보입니다.

메이븐 2의

<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 3

은, 코드의 자바 독에 UmlGraph 다이어그램을 포함하는 방법에 대해 설명 http://maven.apache.org/plugins/maven-javadoc-plugin/examples/alternate-doclet.html를 보라 (길에 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>