낚시광준초리의 Blog 세상

오늘은 doxygen 사용하기전 설정에 대하여 언급 하겠습니다. 아직 제가 많이 사용하지 않아 많은 기능을 알지 못하지만 현재까지 사용 하면서 내가 사용 하고 있는 설정을 기준으로 설명 하겠습니다. 자세한것은 KLDP 등의 사이트를 참조 하시면 됩니다.

1. doxygen 위자드 실행 하기.
    doxygen을 설치 하면 시작 > 프로그램 > doxygen메뉴에서 doxygen wizard를 실행 합니다.


   기본 설정을 바꾸시려면 Wizard버튼을 클릭 하고 좀더 상세한 설정으로 가려면 Export 버튼을 클릭 하면 됩니다. wizard 버튼을 클릭 합니다.


문서 생성하기 위한 기본 정보를 설정하는 탭이 Project탭입니다. Project 명을 임의로 입력 하시고 이 Project에 대한 버전을 입력 합니다. 그리고 Destination directory에 문서가 생성될 디렉토리를 지정 합니다.


Mode는 어떻게 결과를 돌출 할 것인지 결정합니다. 그리고 C++로 되어있는지 언어에 따라 설정 하시면 됩니다. PHP도 되는 것으로 알고 있습니다만 과연 어떤것을 선택할지는 안해봐서 모르겠습니다만 Java정도로 하면 되지 않을 까 합니다.


OutPut은 어떤 파일 형태로 저장 할것인지 입니다. 기본적으로 전 HTML로 하고 있습니다. PDF로 변환 하려면 여러가지 툴도 설치 하여야 하고 LaTex로 하였을 시 한글 지원 안된다고 워닝이 나옵니다.


Diagram은 문서에 보면 Class간에 또는 Function간에 구조도를 자동으로 만들어 줍니다.

위와 같이 만들어 주는데 이것을 설정하기 위해선 dot이란 툴을 설치 하여야 합니다. GraphViz 사이트에서 다운받아서 설치하면 사용 하실 수 있습니다. 해당사이트는 본문 아래에 관련글로 링크를 걸겠습니다.

이렇게 하여 위자드에서 Start버튼을 클릭해도 자동으로 만들어 줍니다. 좀더 상세한 설정을 함으로써 원하는 포맷으로 다양하게 작성 할 수 있습니다. Export버튼을 클릭 해보지요.


기본 Winzard에서 설정 한 값이 그대로 있을 겁니다만 메뉴얼 보면서 설정을 약간씨 바꿔 보시기 바랍니다. 설정에 따라 작동이 조금씩 틀려집니다. 빌드 탭으로 이동 해보면 문서를 만들때 문서에 어떤것을 보여 줄것인지 설정 합니다.


가급적 EXTRACT는 기본적으로 몇개반 설정 되어있는데 저같은 경우 다 체크해서 다양한 정보를 봅니다. 그리고 가급젓 HIDE는 시키지 않는데 불필요하다고 판단되면 HIDE시키시면 일부 빠지게 하실 수 있습니다. 자 그리고 위에 언급했지만 dot을 사용하여 이미지를 생성 시 옵션을 설정 할 수 있습니다. 탭메뉴 우측으로 계속 이동 하면 Dot이라는 탭이 있습니다.


가급적 많은 그림 포함을 시키려고 대부분 포함 시켰습니다. 한번 만들어 보시고 조절 하시면 함수 또는 클래스 설명 페이지에 한눈으로 볼수 있게 다이어그램으로 만들어져 한결 훌륭한 문서를 만드러 지게 됩니다.

저는 이툴을 사용한지는 2주정도 되어갑니다만 몇가지 프로젝트에 적용 시켜 보고 따로이 코드상에 커멘트를 달지 않아도 훌륭한 레퍼런스 문서가 되었습니다. 개발자 여러분 따로 문서 작업 하지 마시고 이툴을 사용 하기를 권합니다.

자 완성된 문서에 일부 캡쳐를 떠봤습니다. 후임자에게 따로이 설명 하지 않아도 이 한문서로 처리가 될 수 있을듯 합니다.

- 관련사이트
  1. http://www.doxygen.org/ - 공식 사이트
  2. http://www.stack.nl/~dimitri/doxygen//results.html - 예제 사이트
  3. KLDP
  4. doxbar
  5. doxygen을 아는가? - 낚시광준초리

안내 1 : IT 관련 개인메타블로그 개설 하였습니다. 많은 동참 바랍니다.
안내 2 :
안내 3 :