Doxygen 주석 사용법

주로 @how to use를 포함하여 쓴다.

예시.

/**

@fn int func(int a, char b)

@brief test function

@date 2011/06/23

@author WooSeung Lee (fornamoo@gmail.com)

@param a 정수형 변수

@param b 문자형 변수

@return result는 결과 값 리턴 0은 실패 1은 성공

@exception EACCES 파일 접근 에러

@remark 이 함수는 테스트용 합수입니다.

@how to use 

ulRet = func(a, b);

if(TRUE == ulRet)

return FALSE;

else

return TRUE;

*/

int func(int a, char b)

{

int result;

return result;

}

+

Doxygen 주석 명시

1. /* 일반주석
2. ..주석 내용..
3. */

1. /** Doxygen 주석
2. ..주석 내용..
3. */

주석 Item

Item	설명
@author	작성자 이름을 나타낼 때
@brief	간략한 설명을 씀
@bug
@code	중요 코드를 설명할 때 시작 지점 설정
@date	작성날짜를 나타낼 때
@endcode	중요코드 설명할 때 종료 지점 설정
@exception	예외 처리
@file	파일 이름을 구별
@fn	함수를 나타낼 때
@mainpage
@param	함수 파라미터 표시
@remark	자세한 설명을 할 때
@return	함수의 리턴 값을 나타낼 때
@section
@see	참고할 함수나 페이지 지정
@struct	구조체 정의
@todo

File

1. /**
2. @file Main.c
3. @date 2011/06/23
4. @author WooSeung Lee (fornamoo@gmail.com)
5. @version 1.0
6. @brief 메인 프로그램
7. */

Function

1. 
   
2.  
3.  
4. /**
5. @fn int func(int a, char b)
6. @brief test function
7. @date 2011/06/23
8. @author WooSeung Lee (fornamoo@gmail.com)
9. @param a 정수형 변수
10. @param b 문자형 변수
11. @return result는 결과 값 리턴 0은 실패 1은 성공
12. @exception EACCES 파일 접근 에러
13. @remark 이 함수는 테스트용 합수입니다.
14. */
15. int func(int a, char b)
16. {
17. int result;
18. return result;
19. }

Structure

1. /**

   @struct list

   @brief 리스트를 위한 구조체

   */

   struct list

   {

   /**

   @var int m_a

   멤버 변수1

   */

   int m_a;

   /**

   @var char m_b

   멤버 변수2

   */

   char m_b;

   };

   
   

Global Variable

1. /**

2. @var int size

3. 크기 변수

4. */

5. int size;

    

Define

1. /**

   @def BUFSIZE

   buffer size

   */

   #define BUFSIZE // buffer size

   /**

   @def MAX(x,y)

   x값과 y값을 비교하여 더 큰 값을 리턴

   */

   #define MAX(A,B) ((x)>(y)?(y):(x))

출처 : http://seedtale.kr/12050

   http://embedded-imesu.tistory.com/66