Doxygen - a documentation system

http://www.stack.nl/~doxygen/

프로그램
http://www.stack.nl/~dimitri/doxygen/download.html

메뉴얼
http://www.stack.nl/~dimitri/doxygen/manual.html

File Description
/*!
*  @file
*  @brief array 관리를 위한 class를 정의한다.
*  @author mtorange
*  @version $Revision: 1.12 $
*  @date $Date: 2004/03/22 10:44:13 $
*
*  $Id: array.h,v 1.12 2004/03/22 10:44:13 mtorange Exp $
*
*/

Class Description

/*!
    @brief multi-thread 환경에서 사용할 수 있는 container를 정의한다.
    @param CONTAINER는 다음 세가지 method를 가지고 있어야 한다.
        - constructor(size_t size)
        - bool get(T *pdata)
        - bool put(T &data)
*/  
template <class T, class CONTAINER>
class  CMTContainer { ….

//! 고정된 크기의 array에 data를 저장하는 queue
class CQueue { …..

Function/Method Description
    /*!
        @brief array의 중간에 item을 추가한다.
        @param index item을 추가할 index
        @param item 추가할 item
        @remark array중간에 item을 추가하는것은 느린 operation이다.
        @pre array에 index보다 많은 아이템이 들어 있어야 한다.
        @todo 속도 향상을 위해 코드 정리가 필요하다.
        @bug index범위 체크를 하지 않는다.
    */
    void insert(size_t index, T item)

4. Enum 의 경우
   /*!
        각 함수들이 돌려주는 return값을 정의한다.
            - RESULT_SUCCESS : 성공
            - RESULT_FAIL : 실패. (get인 경우 데이터가 없음, put인 경우 slot이 없음)
            - RESULT_TIMEDOUT : 지정된 시간이 경과할 동안 get/put을 완료할 수 없음
            - RESULT_CANCELED : CMTContainer가 shutdown되어서 operation이 cancel됨.
    */  
    enum RESULT {
        RESULT_SUCCESS,  RESULT_FAIL, RESULT_TIMEDOUT,  RESULT_CANCELED
    };