-
Doxygen 을 이용한 Java API PDF, HTML 만들기Programming/JAVA 2014. 2. 7. 14:35
Step1. doxygen 설치
http://www.stack.nl/~dimitri/doxygen/download.html
Step 2. graphviz 설치
http://www.graphviz.org/Download.php
Step 3. KoTeXLive 설치
http://faq.ktug.org/faq/KoTeXLive
ㄴ full버전은 설치시간이 오래걸리므로 small버전으로 설치
Step 4. GhostScript 설치
http://www.ghostscript.com/download/gsdnld.html
ㄴ 설치후 윈도우환경변수 PATH에 "C:\Program Files\gs\gs9.07\bin" 를 등록해준다 (이부분 모르면 Serch하기!!)
Step 5. 이클립스 eclox plugin 설치
"http://download.gna.org/eclox/update" 를 추가하여 eclox 를 설치함
- 이클립스 재실행후 "doxygen"설치Path 설정후 '@'모양 실행
- Basic Tab에서 기본설정
ㄴ Input directories : 문서화할 소스폴더 선택
ㄴ Output directory : 문서출력 폴더
ㄴ Optimize results for : "Java"
ㄴ HTML : plain HTML 체크 // HTML버전으로 만들어줌.
ㄴ LaTeX : as iterem...hyperdlinked PDF 체크 // PDF 버전으로 만들어줌
ㄴ Diagram Generate 적절히 선택 // 다이어그램 삽입 ( PDF는 Built-in 으로 해야 깔끔하게 나옴)
- Advanced Tab에서 고급옵션 설정 (Advanced탭 > Setting > Custom 리스트에서 수정한다)
ㄴ Generate Todo List : YES -> NO
ㄴ Generate Test List : YES -> NO
ㄴ Generate Bug List : YES -> NO
ㄴ Generate Deprecated List : YES -> NO
ㄴ Sort Member Documentations : YES -> NO
ㄴ LaTex Batch Mode : NO -> YES
ㄴ Output Language : English(Default) // Korean 으로 설정가능하다는데 필자는 안되는듯..
1. 설정뒤 '@'를 눌러서 HTML과 LaTeX를 생성해준다.
HTML은 생성된 HTML폴더내 "index.html"로 실행가능
LaTeX는 LaTeX라는 폴더에 알수없는 파일들이 생긴다. LaTeX 파일들을 이용해 Step4 에서 설치한 GhostScript를 이용해 PDF를 만들수 있다.
2. 그전에 주석에 한글이 있다면 파일하나를 수정해줘야한다.
LaTeX 폴더에 "refman.tex" 파일을 편집기로 열어 (바로실행하면 Step3에서 설치한 KoTeXLive 편집기가 실행되는듯)
(변경전) \usepackage[T1]{fontenc} // 이부분의 fontenc를 kotex로 변경해준다
(변경후) \usepackage[T1]{kotex} // 변경후 저장
3. LaTeX폴더에 "make.bat"을 실행하면 콘솔화면이 나오고 잠시뒤 PDF파일이 생성된다.
메서드의 Parameters 들이 약간 깨져나오게 보이지만 (소스파일 원본의 주석 문제인가??;;)
폰트가 그닥 이쁘지는 않지만 (이건 개취이므로..)
그럴듯한 문서가 만들어졌다.
----------------------------참고 링크
doxygen으로 PDF문서 만들기
http://ldevil63.tistory.com/54
doxygen 설치및 실행
http://javaexpert.co.kr/entry/27
doxygen 이클립스 연동
http://blog.naver.com/PostView.nhn?blogId=athena805&logNo=130069223295
