![자바 API, Javadoc 만들기 - APIviz[API,Javadoc,Java,자바]](http://images.google.com/images?q=tbn:3yVTst6xCedawM::blogs.sun.com/theplanetarium/resource/java-logo.jpg){kind=logo}
이미지출처 : blogs.sun.com
인수인계를 위해, 어떠한 형태의 문서가 좋을까 고민을 하다가,
내가 참여한 클래스와 메소드들에 대한 설명을 적어서 Javadoc으로 뽑고,
메인페이지에 필요한 사항을 수정하였다.
다이어그램을 자동으로 그려주는 APIviz(http://code.google.com/p/apiviz/)를 사용하였는데,
사용법은 이클립스에서 export시에 다음과 같이 doclet설정을 해주면 된다. (APIviz How to use)
Use Custom Doclet
Doclet Name : org.jboss.apiviz.APIviz
Doclet Class-Path : APIvizPath\jar\apiviz-1.3.0.GA.jar
이후 Vm Option에서 Graphviz 경로 설정 (and Graphviz path setting in VM options)
Doclet Name : org.jboss.apiviz.APIviz
Doclet Class-Path : APIvizPath\jar\apiviz-1.3.0.GA.jar
이후 Vm Option에서 Graphviz 경로 설정 (and Graphviz path setting in VM options)
아래와 같이 필요한 Vm 옵션도 몇가지 추가하였다. (My custom vm options)
VM options
-encoding UTF-8 -charset UTF-8 -docencoding UTF-8 (한글 Javadoc을 만들기 위해[for unicode document])
-J-Dgraphviz.home=GraphvizPath\bin (Graphviz 설정 [Graphviz Setting])
-J-Xmx512m (내보낼 문서의 양이 많을때 메모리 부족 에러가 난다. [Prevent out of memory error during export Javadoc])
Extra Javadoc options
-d OutputPath (내보낼 경로 [Output Path])
-tag author:a:"Author:" (작성자 정보를 문서에 포함시킨다. [include author information in document])
-encoding UTF-8 -charset UTF-8 -docencoding UTF-8 (한글 Javadoc을 만들기 위해[for unicode document])
-J-Dgraphviz.home=GraphvizPath\bin (Graphviz 설정 [Graphviz Setting])
-J-Xmx512m (내보낼 문서의 양이 많을때 메모리 부족 에러가 난다. [Prevent out of memory error during export Javadoc])
Extra Javadoc options
-d OutputPath (내보낼 경로 [Output Path])
-tag author:a:"Author:" (작성자 정보를 문서에 포함시킨다. [include author information in document])
마지막으로 스타일시트는 검색을 하다가, (I used custom stylesheet in follow link.)
http://applegrew.blogspot.com/2008/05/get-my-javadoc-stylesheet-red-n-black.html 를 사용했다.
그동안 주석을 잘 안달아놔서 꽤 바쁜 작업이 되긴 했지만,
막상 문서작성을 마치고 보니, 꽤 만족스럽다.:D
by 月風
