1 about #

문서에 정해진 규칙에 따라서 주석을 달아놓으면 그 주석을 해석해서 문서로 만들어 주는 툴이다.

[edit]

2 link #

[edit]

3 규칙 #

doxygen 이 인식하는 마크에는 간단한 설명 과 자세한 설명 으로 나뉜다.
주석을 달 때는 //, /* */ 를 쓰지 않고, ///, /** */ 를 쓴다.
옆에다가 주석을 달 때는 ///< 를 쓴다.
헤더 파일에는 간단한 주석을, cpp 파일에는 세부 주석을 쓰자.

[edit]

4 쓸만한 특수 명령 #

@mainpage : 메인 페이지에 보여줄 설명
@warning : 경고 문구
@param : 함수의 인자에 대한 설명
@return : 반환값에 대한 설명
@sa : 다른 함수나 클래스로의 링크를 걸어줌

[edit]

5 예제 #

TestDoxygen.cpp 파일

zelon.h 파일

zelon.cpp 파일

#include "StdAfx.h"
#include ".\zelon.h"

CZelon::CZelon(void)
{
}

CZelon::~CZelon(void)
{
}

/*!

        \param a a Integer
        \param b a double

        \return 0 = succeed, other error code

        Details.......
*/
int CZelon::show(int a, double b)
{
        return 9;
}

/*!
        \sa CZelon::show()
*/
void CZelon::showDetail()
{
}

Contents

1 about #

2 link #

3 규칙 #

4 쓸만한 특수 명령 #

5 예제 #