Doxygen 사용법

1. 기본적인 주석 형태

/**

* 기본적인 주석 형태

*/

2. 메인 페이지의 주석 

/**

* @mainpage 메인페이지의 제목을 적는다.

* @brief 간단한 설명

* @details 자세한 설명

* @section intro 소개

* @section Program 프로그램명

* @section INOUTPUT 입출력자료

* @section CREATEINFO 작성정보

* @section MODIFYINFO 수정 정보

*/

3. 각 파일에 들어갈 주석

/**

* @file hello.c

* @brief 간단한 설명

* @detail 자세한 설명

* @date 2018/1/30

*/

4. 각 함수에 대한 주석

/**

* @brief 어떤 기능을 하는 함수

* @param value 연산에 필요한 변수

* @return value 연산 결과를 반환

*/ 

5. 코드 삽입시 

@code

여기에 코드가 들어가면 된다.

@endcode

6. 버그 및 해야할 일 기록

@todo 언제까지 해야할일

@bug 값의 범위를 넘을경우 발생되는 버그가 있을 수 있다.

7. struct(class), enum

 /**  @brief buffer structor   Telnet에서 정송되는 데이터에 대해 프로토콜을 처리해야 하기 위하여,  효율적으로 데이터를 전송해야 할 입출력 버퍼 structor */ 

struct buffer{

  char *buf;   /**< 데이터를 저장할 주소공간   */         
  int size;   /**< buf에 할당된 메모리 크기   */         
  int head;   /**< buf에 저장된 데이터의 처음 Index   */
  int tail;   /**< buf에 저장된 데이터의 마지막 index */
  int count;  /**< buf에 저장된 데이터의 byte 수      */ 
}; 
 /** @brief TRUE FALSE정의. */ 
enum BOOLEAN { FALSE=0, /**< FALSE */    TRUE /**< TRUE */ };

8. define, 전역 변수

#define MAX_READ_BUF   1024    /**< 최대 read buffer size      */
 short  port;                   /**< Telnet port number */