Javadoc 삽입 UML 다이어그램

StackOverflow https://stackoverflow.com/questions/1411172

  •  05-07-2019
  •  | 
  •  

문제

내 Javadoc에 이미지를 포함시키는 방법이 있습니까? 기본적으로 일부 문서에서 내 클래스의 계층 구조를 설명하는 UML 다이어그램을 포함하고 싶습니다.

감사!

도움이 되었습니까?

해결책

체크 아웃 이번 장 Javadoc 문서의 Javadoc에 이미지를 포함시키는 방법을 설명합니다.

또한 여기에 있습니다 기사 UML 다이어그램을 리버스 엔지니어링하고 사용하는 Javadoc에 포함시키는 방법을 설명합니다. 움 그래프.

다른 팁

예.

문서 임의의 이미지를 Javadoc 문서에 포함시키는 방법을 설명합니다.

Java 소스에서 UML 클래스 다이어그램을 생성하려면 umlgraph doclet.

apiviz 좋은 도클입니다.

간단한 답변 :

/**
 * This class does some stuff (see diagram).
 * <img src="relative/path/to/image.png" />
 * 
 */
 public class SomeClass{
 }

이 기사 Maven Javadoc 플러그인과 함께 umlgraph를 사용하는 방법을 보여줍니다.

요컨대 :

  1. GraphViz를 설치하십시오.

    우분투 : apt-get install graphviz4.
    Windows : 다운로드.

  2. POM.XML 업데이트.

        <plugin>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.7</version>
        <configuration>
            <aggregate>true</aggregate>
            <show>private</show>
            <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>
            <docletArtifact>
                <groupId>org.umlgraph</groupId>
                <artifactId>doclet</artifactId>
                <version>5.1</version>
            </docletArtifact>
            <additionalparam>
                -inferrel -attributes -types -visibility -inferdep -quiet -hide java.* -collpackages java.util.* -qualify -postfixpackage
                -nodefontsize 9
                -nodefontpackagesize 7
            </additionalparam>
        </configuration>
    </plugin>

  3. 운영 mvn javadoc:javadoc.

ydoc 옵션입니다

이것 기사 Javadoc 도구에 액세스 할 수있는 폴더에 이미지를 배치하여 수행 할 수있는 방법을 설명합니다.

라이센스 : CC-BY-SA ~와 함께 속성
제휴하지 않습니다 StackOverflow
scroll top