살아가는 이야기

doxygen 간단 사용법 본문

컴퓨터, 풀어그림

doxygen 간단 사용법

우균 2010. 8. 11. 15:14

1. 다음 사이트에서 doxygen for windows를 다운로드한다.

http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc

2. 같은 사이트에서 매뉴얼도 다운로드한다. pdf와 chm 중 아무 거나 상관 없다.

3. 단계 1에서 다운로드 받은 파일을 실행하여 기본 위치에 설치한다.

4. 자신이 작성한 C++ 소스코드에 매뉴얼을 참고하여 doxygen 주석을 추가한다. 이 때, 단계 2에서 다운로드한 매뉴얼의 3장을 참고한다.

5. 설치된 프로그램 그룹에서 Doxywizard를 실행한다.

6. (Doxywizard Step 1) 작업 디렉토리를 설정한다. 단계 4에서 작성한 파일들이 있는 폴더를 선택해도 된다.

7. (Doxywizard Step 2) Wizart 탭: 프로젝트 이름, 버전, 소스코드 폴더(단계 4에서 작성한 폴더), 생성한 문서를 저장할 폴더(단계 4의 폴더를 그대로 써도 됨)를 차례로 정한다. 소스 폴더가 중첩되어 있다면 "Scan recursively"를 선택한다.

8. (Doxywizard Step 2) Expert 탭: 변경할 내용이 있다면 변경한다. 예컨대 파일 인코딩(UTF-8이 기본이지만 EUC-KR로 변경할 수 있음. 또 OUTPUT_LANGUAGE를 Korean으로 변경할 수 있음) 등을 변경할 수 있다. EUC-KR을 사용하려면 다음 사이트에서 libiconv를 설치하고 설치 폴더의 bin 디렉토리를 PATH에 추가해 주어야 한다.

http://gnuwin32.sourceforge.net/packages/libiconv.htm

9. (Doxywizard Step 2) Run 탭: Run doxygen을 실행한다.

10. 단계 7에서 정한 문서 디렉토리로 이동하여 html 문서와 latex 문서가 생성되어 있음을 확인한다. html 내용을 확인해 본다. latex을 컴파일하려면 refman.tex 파일을 컴파일한다.



Comments