Doxygen

2013.05.27 15:11콤퓨타/Tools

OS : Ubuntu 10.04 LTS 64bit



1. doxygen 다운로드 및 설치

(http://www.stack.nl/~dimitri/doxygen/download.html)


git clone https://github.com/doxygen/doxygen.git

cd doxygen

./configure

make

sudo make install



2. 사용법

문서화하고자 하는 프로젝트 폴더로 들어가서 


doxygen -g


Doxyfile이 생성될 것임.


이 파일이 configuration 파일인데, 원하는 옵션을 설정해 주면되고..

첨부한 매뉴얼 pdf을 통해서 보거나 


http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_include_file_patterns


들어가서 보면 옵션별로 설명이 나와있당



3. 그래프로도 나오게하기

(http://www.stack.nl/~dimitri/doxygen/manual/diagrams.html)


그래프로 표현하고 싶으면 graphviz를 설치해야함 !


sudo apt-get install graphviz


그리고, 이에 맞는 옵션을 Doxyfile에 설정해 줘야된당


SHORT_NAMES = YES //이거안해주면  Error opening map file *.map for inclusion in the docs라는 에러 뜰 것임-ㅁ-

HAVE_DOT = YES

CALL_GRAPH = YES

CALLER_GRAPH = YES

EXTRACT_ALL = YES

EXTRACT_PRIVATE = YES

EXTRACT_PACKAGE = YES

EXTRACT_STATIC = YES

EXTRACT_LOCAL_CLASSES = YES

EXTRACT_LOCAL_METHODS = YES

EXTRACT_ANON_NSPACES = YES






------------------------------------------------------------------------------------------------------------






OS : Mac


Doxygen 다운로드 : http://sourceforge.net/projects/doxygen/

graphviz 다운로드 : http://www.graphviz.org/Download_macos.php



Mac의 Doxyfile 에서 Graphiz 설정


DOT_PATH = /usr/local/bin

으로 설정해줘야한다 !!


'콤퓨타 > Tools' 카테고리의 다른 글

Doxygen  (0) 2013.05.27
1