JavaDoc with UML Diagram on Eclipse

-

1. 준비

  • Eclipse & commented source project
  • GraphViz 설치
    • https://www.graphviz.org/
    • 예: C:\Program Files (x86)\Graphviz2.38
  • UmlGraph 설치
    • https://www.spinellis.gr/umlgraph/index.html
    • Jar 다운로드 & 이동/복사
    • 예: C:\Workspace.eclipse\Project\lib\UmlGraph-5.7_2.32-SNAPSHOT.jar

2. Using Eclipse Generate Javadoc UI

  • Use standard doclet 선택 <- 가장 중요
  • Extra Javadoc options로 다음 내용 추가
-doclet org.umlgraph.doclet.UmlGraphDoc
-docletpath D:\Workspace.eclipse\Test\lib\UmlGraph-5.7_2.32-SNAPSHOT.jar
-dotexecutable "C:\Program Files (x86)\Graphviz2.38\bin\dot.exe"
-attributes
-operations
-qualify
-types
-visibility
  • Finish로 Javadoc 생성
  • (참고) Ant용 스크립트(.xml)를 저장하면 다음과 같이 나옴
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<project default="javadoc">
    <target name="javadoc">
        <javadoc access="private" additionalparam=" -doclet org.umlgraph.doclet.UmlGraphDoc&#13;&#10;-docletpath D:\Workspace.eclipse\Test\lib\UmlGraph-5.7_2.32-SNAPSHOT.jar&#13;&#10;-dotexecutable &quot;C:\Program Files (x86)\Graphviz2.38\bin\dot.exe&quot;&#13;&#10;-attributes&#13;&#10;-operations&#13;&#10;-qualify&#13;&#10;-types&#13;&#10;-visibility" author="true" classpath="." destdir="doc" doctitle="Document Title" nodeprecated="false" nodeprecatedlist="false" noindex="false" nonavbar="false" notree="false" packagenames="aaa.bbb.ccc.ddd" source="1.8" sourcepath="src" splitindex="true" use="true" version="true"/>
    </target>
</project>

3. Using Ant

  • Eclipse 프로젝트 폴더 아래 Ant용 build.xml 생성
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<project default="javadoc">
  <target name="javadoc" description="Generate javadoc with UML Diagram">
    <property name="src.dir"  value="src"/>
    <property name="javadoc.dir"  value="doc-uml"/>
    <property name="dot.path"  location="C:\Program Files (x86)\Graphviz2.38\bin"/>
    <mkdir dir="${javadoc.dir}"/>
    <javadoc access="private" doctitle="Test" author="true" classpath="." packagenames="kr.re.etri.heat.jms" source="1.8" sourcepath="${src.dir}" destdir="${javadoc.dir}" nodeprecated="false" nodeprecatedlist="false" noindex="false" nonavbar="false" notree="false" splitindex="true" use="true" version="true">
      <doclet name="org.umlgraph.doclet.UmlGraphDoc" path="lib/UmlGraph-5.7_2.32-SNAPSHOT.jar">
        <param name="-attributes" />
        <param name="-operations" />
        <param name="-qualify" />
        <param name="-types" />
        <param name="-visibility" />
        <param name="-dotexecutable" value="${dot.path}/dot.exe" />
      </doclet>
    </javadoc>
  </target>
</project>

4. [Note]

  • UML Diagram들의 형식 변경은 UmlGraphDoc으로 넘기는 옵션 parameter들로 조정

    댓글

    댓글 쓰기

    이 블로그의 인기 게시물

    [DevTip] Windows에서 tail 쓰기...

    -
    Unix, Linux의 콘솔 환경이 익숙하다보니 Windows쪽에서 불편한 게 하나 둘이 아니다... 그 중에 하나 tail. 검색해보니 Windows 서버 계열에서는 지원하는 듯도 한데, Windows 7에는 없는 듯 보인다. 아래는 여러가지 방법들... tail for windows http://tailforwin32.sourceforge.net/ GUI로 되어 있어서 조금 불편한 면이 없지 않다. 계속해서 갱신하고 있다는 것도 맘에 안 들고. 원하는 필터로 특정 텍스트를 하이라이트할 수 있다는 것은 맘에 드는 부분. PowerShell 보조프로그램->Windows PowerShell->Windows Powershell PowerShell 창에서... Get-Content -Path {로그 파일} | Select-Object -Last 10 요건 Unix에서 tail -f 10 {로그 파일}과 동일 효과 또는, PowerShell 창에서... Get-Content -Path {로그 파일} -Wait 요건 tail for windows 로그처럼 나타남 결론은... 모조리 불편해... 사실 간단히 프로그램 짜서 tail.exe를 만들어 쓰면 되긴 하는데, 귀찮기도 하거니와 효과적인 프로그램이 안 될 것 같아서...
    자세한 내용 보기

    환경개선부담금

    -
    이미지
    환경개선부담금 고지서가 날라왔다. 2009년 7월에 등록한 경유차량인데 지금껏 면제되고 있다가 작년 후반기분이 이번에 고지된 듯. 자동차 배기량으로 세금을 산정하는 것도 그렇고, 경유차량이 무조건 안 좋다고 이런 세금을 유지하고 있는 것도 맘에 안 든다. 시대에 맞게 변화할 때가 됐는데... 다행인 것은 빠르면 2016년부터 환경개선부담금이 폐지될 수도 있다는 것. ( http://www.hani.co.kr/arti/economy/car/614664.html ) 디젤 기술의 발달은 인정하고 반영하겠다는 노력이겠지. 차동차, 보험사의 입김에 영향을 받지 않고 제대로 된 정책을 만드는 게 우선인데, 과연 가능할지.. 그런데... 생각보다 금액이 상당하다. 반기별 20,250원, 2013년도 지수 1.992, 오염유발계수 1.0, 차령계수 1.04, 지역계수 1.0, 산정일수 175/184 를 적용하니까 39,899원. 원단위 절사해서 39,980원이 고지됐다. 산정일수를 다 채웠다는 4만 원 남짓. 일  년 기준으로 하면 8만 몇천 원이 나온다는 말인데... 올해가 2014년이니, 최소 2~3년을 더 낸다고 치면 2~30만원을 환경개선부담금으로 내야 한다. 으음... 일 년에 7천 km 정도 밖에 타고 다니질 않으니 주유비로 아끼는 금액으 로 충당하는 것도 조금 애매하네... 더 많이 타고 다녀야 덜 억울한건가...
    자세한 내용 보기

    Electropermanent Magnets: Programmable Magnets with Zero Static Power Consumption Enable Smallest Modular Robots Yet

    -
    이미지
    http://www.hizook.com/blog/2010/12/07/electropermanent-magnets-programmable-magnets-zero-static-power-consumption-enable-s Electropermanent Magnets: Programmable Magnets with Zero Static Power Consumption Enable Smallest Modular Robots Yet December 7, 2010 by Travis Deyle Take a moment and envision an electromagnet: a simple coiled wire driven by a hefty electrical current gives a fully-programmable magnetic field strength (on, off, and everything between).  Electromagnets are ubiquitous, but it turns out that there is a little-known device with similar functionality yet zero static power consumption -- they are called electropermanent magnets, and they've been around and in use since the 1960's!  A 2010 PhD thesis by MIT Media Lab's Ara Knaian examines the physics, scaling, trade-offs, and several new actuator designs (eg. stepper motors) using these little-known wonders.  Recently, electropermanent magnets facilitated an innovation in "programmable matter,...
    자세한 내용 보기