Doxygen 을 이용한 C++ API 문서 만들기

step 01 : Doxygen Download

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

step 02 : Graphviz Download (선택 사항)

http://www.graphviz.org/Download_windows.php 

step03 : 

Doxygen 문서로 만들 Sample Code 생성 

Doxygen 문서를 만들기 위해서는 하기 초록색 색인 된 주석 부분이 필요하다. 

//----------------------------------------------------------------------------
// @file 파일명, @brief 파일에 대한 설명 해당 주석이 가장 먼저 선언되어야 함
/** @file main.cpp
    @brief doxygen test app
*/
//----------------------------------------------------------------------------

#include <stdio.h>
#include <iostream>

//----------------------------------------------------------------------------
// @brief 함수 설명, @param x : prameter 설명, @return : return 값 설명
// @remark 주의사항 설명
/** @brief a, b 의 두 수의 합을 구해온다.
@param a : int 형 a 변수
@param b : int 형 b 변수 
@return a+b
@remark 주의사항 없음
*/
//----------------------------------------------------------------------------

int sum(int a, int b)
{
return a+b;
}

//----------------------------------------------------------------------------
/** @brief a, b 의 두 수의 차를 구해온다.
@param a : int 형 a 변수
@param b : int 형 b 변수 
@return a-b
@remark 주의사항 없음
*/
//----------------------------------------------------------------------------

int sub(int a, int b)
{
return a-b; 
}

//----------------------------------------------------------------------------
/** @brief a, b 의 두 수의 곱을 구해온다.
@param a : int 형 a 변수
@param b : int 형 b 변수 
@return a*b
@remark 주의사항 없음
*/
//----------------------------------------------------------------------------

int mul(int a, int b)
{
return a*b;
}

//----------------------------------------------------------------------------
/** @brief a / b 의 결과를 구해온다.
@param a : int 형 a 변수
@param b : int 형 b 변수 
@return a-b
@remark 나눗셈 몫이 0 이 되지 않도록 주의 
*/
//----------------------------------------------------------------------------

int divide(int a, int b)
{
return a/b;
}

void main()
{
int a = 20;
int b = 5;
int result = 0;

std::cout<<"aaa"<<std::endl;
result = sum(a,b);
std::cout<<"a+b="<<result<<std::endl;

result = sub(a,b);
std::cout<<"a-b="<<result<<std::endl;

result = mul(a,b);
std::cout<<"a*b="<<result<<std::endl;

result = divide(a,b);
std::cout<<"a/b="<<result<<std::endl;

}

step 04 

Doxygen Project 만들기

 

Wizard - Project

1 : doxygen project 생성 될 경로 

2 : project name, version 정보 

3 : source code directory - 소스 파일 경로 

4 : destination directory - doxygen 문서 생성 될 경로 

 

 

Export - Project

a : encoding type 설정 - 한글 일경우 EUC-KR, 영문 only 일 경우 utf-8 로 설정

b : encoding 설정에 맞는 언어 선택 

 

 

Export - Input 

Input Encoding type 설정 : 한글 EUC-KR, 영어 utf-8 로 설정

 

 

Export - Source Browser 설정

 

 

Export - Dot

step02 에서 graphviz Downlad 받은 경우만 적용 graphviz 경로 및 bin 폴더 설정

 

Run - Run doxygen

위 설정 후 Run doxygen 실행 시 log 결과 나오며 HTML 문서가 생성된다.

Show HTML output 버튼 클릭 시 결과 확인 가능하다. 

 

doxygen 생성 문서 실행 결과다. 

 

 

Doxygen 을 이용 한 C++ API 문서 만들기 : 네이버 블로그 (naver.com)