이 글은 Doxygen을 처음 사용하면서 첫번째 프로젝트에 대한 결과가 제대로 나오기 까지  바꾼 설정들을 정리해 놓은 것입니다.
Doxygen 사용  경험이 없기 때문에 현재 설정 값이 제대로가 아닐 가능성도 있습니다. 그래도 한글로 주석(Comment)를 추가하고  Doxygen 포맷에 맞는 설명을 추가하여 한글 문서가 제대로 생성되는것을 확인했으니까 처음  Doxygen 을 사용하는 사람은 아래 화면 캡쳐를 참고 하면 도움이 될것입니다.

설치 파일은 2개입니다.
doxygen-1.7.4-setup.exe
graphviz-2.26.3.msi

직원들은 회사 FTP서버에서 "ICT 프로그램 설치" 폴더에 들어있는 doxygen.zip 파일을 받아서 압축을 풀면 위 파일 2개가 나옵니다. 다른 파일도 있지만 일단 무시합니다.


파일이 없거나 최신 doxygen 설치 파일은 아래 링크에서 다운로드 하면됩니다.
doxygen 다운로드페이지
 2012.3.17일 현재 1.8.0 버전까지 나와 있습니다.

call, caller그래프를 위한 설치 파일을 아래에서 다운 받을 수 있습니다.
graphviz 다운로드










[한글 문제 때문에 설정]


[한글 문제 때문에 설정] 



[SOURCE_BROWSER] 옵션을 체크해야 doxygen문서에서 소스파일(*.cpp)  보기가 가능하다.
체크 안하면 헤더파일(*.h)은 볼수 있는데 소스 파일은 포함하지 않는다.





[ Call, caller 그래프 그리는 프로그램 연결 설정]



[Run doxygen] 버튼을 클릭하면 문서화를 시작합니다.
작은 프로젝트 일때는 1분 이내이지만.. 좀 복잡하거나 클래스 상속관계가 복잡한 소스일 경우에는 전체 빌드 시간이 길어집니다.. 프로젝트와 PC성능에 따라서는 30분 이상 걸리기도 합니다.





doxygen 문서 생성 결과
아래 그림을 보면..클래스 상속도와 관계도가 깔끔하게 정리되어 표시됩니다.
각각의 멤버함수들도 caller , call 그래프가 정리되어서 나옵니다.
굳이 doxygen 전용 주석을 이용한 설명이 없어도 소스 분석하고 함께 리뷰할때  많은 도움이 될것 같습니다.



 

+ Recent posts