출처: http://woohaha.egloos.com/260149 Doxygen으로 프로젝트 문서화하기 |
필요한 프로그램 다운로드 받기
1. Doxygen : 다운로드-윈도우용(doxygen-1.3.5-setup.exe)
2. Graphviz : 다운로드-윈도우용(graphviz-1.10.exe)
3. Doxbar : 다운로드-윈도우용 (doxbar-0.35-bin.zip)
4. html help compiler (version 1.3) : 다운로드(htmlhelp.exe)
1. doxygen 설치하기
* 다운로드받은 doxygen-1.3.5-setup.exe 파일은 윈도우용 설치 프로그램 파일이다. 실행시킨 뒤 원하는 폴더에 설치한다.(디폴트값 : C:Program Filesdoxygen)
* doxygen이 설치된 경로 아래의 bin 디렉토리에서 다음과 같은 도스 명령을 실행시킨다.
doxygen -g [템플릿파일명]
위 도스 명령에서 템플릿파일명을 지정하지 않으면 Doxyfile이라는 이름의 파일이 생성된다.
* 생성된 템플릿 파일을 편집한다. 편집하기를 추천하는 부분은 다음과 같다.
OUTPUT_LANGUAGE = Korean
OUTPUT_LANGUAGE의 디폴트값은 English로 되어 있는데 Korean으로 변경하면 한글화된 문서를 얻을 수 있다.
EXTRACT_ALL = YES
생성 후 비어있는 문서항목들도 모두 표시한다.
EXTRACT_PRIVATE = YES
private 멤버들을 문서화할 것인지 여부.
EXTRACT_STATIC = YES
static 멤버들을 문서화할 것인지 여부
SOURCE_BROWSER = YES
소스에 대한 직접적인 정보링크를 만들것인지 여부
HAVE_DOT = YES
다음에 설명하게 될 클래스관계 그림 생성 여부(by graphviz)
2. graphviz 설치하기
이 프로그램은 클래스간의 관계를 알아보기 쉽게 그림으로 만들어내는 기능을 수행한다.
위에서 다운로드 받은 파일(graphviz-1.10.exe)은 윈도우용 설치 프로그램 파일이다. 그대로 실행시키면 디폴트값으로 "C:Program FilesATTGraphviz" 경로에 설치가 된다.
3. Doxbar 설치하기
이 프로그램은 Visual Studio 6.0에서 Doxygen을 사용하기 쉽게 해주는 애드인 프로그램이다.
다운로드받은 파일(doxbar-0.35-bin.zip)의 압축을 풀면 다음과 같은 두 개의 파일을 볼 수 있다.
doxbar.chm, doxbar.dll
위 두 개의 파일을 적당한 디렉토리에 복사한다. 예를 들어 C:Program FilesdoxygenDoxbar 디렉토리를 새로 만들어서 그 안에 집어넣는다.
4. Doxbar 설정하기
지금까지 doxygen, graphviz, doxbar를 모두 설치 완료하였다. 이제부터는 doxygen을 사용하여 프로젝트를 문서화하기 위한 설정 방법을 알아보도록 하겠다.
* Visual Studio 6.0을 실행시키고 Tools - Customize... 메뉴를 선택한다. 그리고 Add-ins and Macro Files 탭을 선택한 뒤 Browse 버튼을 눌러서 Doxbar.dll을 선택해주도록 한다.
그림 1.
Doxbar.dll을 등록시키면 위 그림에서와 같이 Doxbar.DSAddIn.1이 추가된다. 이 항목을 선택하고 Close 버튼을 누르면 다음과 같은 툴바가 Visual Studio에 추가된다.
그림 2.
* 다시 Visual Studio의 Tools - Customize 메뉴를 선택하고 Tools 탭을 선택한다.
그림 3.
위 그림에 나와있는 것과 같이 Doxygen이라는 항목을 추가하고 Command 항목값으로 C:Temp undoxy.bat 을 등록한다.
여기에서 등록한 rundoxy.bat 파일을 실제로 존재하지 않는 입력값이다. 따라서 Close 버튼을 누르면 실제로 존재하지 않으므로 수정하겠느냐라는 메시지박스가 나타나는데 아니오로 선택하고 종료하면 된다.
* 그림 2.에서 보이는 Doxbar 툴바 버튼들 중에서 왼쪽에서 두 번째 위치한 버튼이 Doxygen에 대한 환경설정 기능을 수행한다.
환경설정을 수행하기에 앞서 Visual Studio의 Tools 메뉴를 선택하여 방금 전 추가한 Doxygen 툴의 번호가 몇인지를 확인하도록 한다.
그림 4.
위 그림에서는 10으로 표시되고 있다.
* Doxbar 툴바의 두 번째 버튼을 선택하면 다음과 같은 환경설정 대화상자가 나타난다.
그림 5.
앞에서 추가한 Doxygen 툴 메뉴의 번호대로 UserTool<번호>를 입력한다.
그림 6.
위 그림에서는 Doxygen이 실행될 때 실시간으로 만들어지는 배치파일의 경로, doxygen.exe의 경로, 디폴트 템플릿 파일의 경로, 도움말 컴파일러의 경로 등을 설정하고 있는 모습을 보여주고 있다.
그림 7.
위 그림에서 보이고 있는 값들은 디폴트값이다. 그대로 사용하면 된다.
5. Doxygen 실행하기
이제 마지막으로 doxygen을 실행시켜서 프로젝트 문서화를 해볼 차례이다. Doxbar의 맨 왼쪽 버튼을 누르면 Output 윈도우에 주르륵 표시되면서 문서화가 이루어진다.