doxygen 초간단 사용법

소스코드 문서화 프로그램 doxygen의 초간단 사용법을 적어볼까 합니다.

 

doxygen을 사용한 소스코드의 문서화는 다음과 같은 절차로 이루어집니다.

1. 문서화할 소스코드(C 파일들)가 있다
2. doxygen을 다운로드 받는다
3. doxygen용 설정파일(Doxyfile)을 생성한다.
4. doxygen용 설정파일(Doxyfile)을 내 환경에 맞게 편집한다.
5. doxygen을 실행한다.

 

 

자 그럼 각 단계별로 살펴볼까요.

 

문서화할 소스코드(C 파일들)가 있다.

• 기존에 소스코드가 있다면, 문서화할 수 있습니다.
• 하지만 완벽한 문서화를 위해서는 소스코드에 doxygen이 인식할 수 있도록 주석이 달려있어야 합니다.
• 하지만 doxygen용 주석이 달려있지 않아도 문서화된 결과물은 확인할 수 있습니다.

 

 

doxygen을 다운로드 받는다.

• http://www.stack.nl/~dimitri/doxygen/
• doxygen 홈페이지에서 해당 OS에 맞는 설치파일이나 압축 파일을 다운로드 받아서 설치하거나 압축을 풀고 PATH가 연결된 디렉토리에 넣어두면 됩니다.

 

 

doxygen용 설정파일을 생성한다.

• doxygen용 설정파일의 이름은 특별히 주어지지 않으면 Doxyfile입니다.
• 기존에 doxygen으로 문서화를 진행하던 프로젝트 혹은 소스코드라면 doxygen용 설정파일인 Doxyfile이 있을 것입니다.
• 이전 버전의 doxygen용 설정파일을 현재 사용하고 있는 doxygen용 설정파일로 업그레이드하기

 

doxygen -u [configName]

 

 

 

기존에 doxygen용 설정파일이 없어서 새롭게 doxygen용 설정파일인 Doxyfile을 만들기

 

doxygen -g [configName]

 

 

 

 

doxygen용 설정파일(Doxyfile)을 내 환경에 맞게 편집한다.

생성된 Doxyfile을 텍스트 편집기로 열어보면 수많은 설정항목들이 있습니다.

(모두 영어로 되어있고, 정말 많습니다. ^^;)

각 항목들은 영어를 이해하시던지, 매뉴얼을 참고하셔야 합니다.

지금은 Doxyfile을 그대로 사용하는 것으로 하죠.

 

 

이제 doxygen을 실행해서 소스코드의 문서를 생성합니다.

 

doxygen

 

 

 

이제 소스코드에 대한 문서가 생성되었습니다. ^^;

이 글은 스프링노트에서 작성되었습니다.