gl5_progのメモ

自分のためのメモとかまとめとか

個人的なDoxygenコメントの書き方

個人的なDoxygenコメントの書き方をメモっておきます。
以下のサンプルは実際にDoxygenを実行させずに書いたので間違っているかもしれません。

/*!
  @mainpage

  Doxygenのメインページ用のドキュメントコメントです。
*/

/*!
    @page aboudhogeframework

    @section 概要
    Hogeフレームワークの解説ページです。
*/

/// Hogeクラスの要約説明です
/**
    Hogeクラスの詳細説明です
    - リスト表記です1
    - リスト表記です2
    - リスト表記です3

    サンプルコードなどの記述
    @code
    Hoge hoge;
    hoge.Func();
    @endcode

    @addtogroup Hogeモジュール
*/
class Hoge
{
public:
    Hoge(){}
    void Func( void  ); ///< Funcの要約説明です。 @brief Funcの詳細説明です。
    void FuncAfter( void  );

    /// FuncBigの要約説明です。
    /**
        FuncBigの詳細説明です。
        @return 戻り値の説明です。
        @param aaa 引数についての説明です。 
        @attention 注意点の記述です
        @warning 警告の記述です
        @note 覚え書きの記述
        @bug バグが存在する場合の記述です
        @todo Todoの記述です
        @deprecated 非推奨であることの説明
        @pre 事前条件の説明
        @post 事後条件の説明
    */
    void FuncBig( int aaa, int bbb  );
    void FuncBig( int aaa, int bbb, int ccc  ); ///<  @see void FuncBig( int aaa, int bbb  ); ( 参照ドキュメントの記述。オーバーロード時などに利用 )

    /// @name カテゴリ1
    //@{
    void FuncCategory1( void  ); ///< 要約説明です。 
    void FuncCategory2( void  ); ///< 要約説明です。 
    //@}

    /// @fn void FuncAfter( void  );
    /// @brief FuncAfterの要約説明です。
    /**
           FuncAfterの詳細説明です。
    */
};

個人的な使用コマンド一覧

全コマンド
http://www.doxygen.jp/commands.html

>>>>>>>>>>>コマンド
@mainpage Doxygenで生成されるドキュメントのメインページになります。
@page Doxygenで生成されるドキュメントのページになります。
@section ページ内でのセクションになります。
@code コードの引用を開始します。
@endcode コードの引用を終了します。
@addtogroup モジュールを指定します。
@brief 要約説明になります。
@detail 詳細説明になります。
@return 戻り値の説明になります。
@param 引数の説明になります。
@attention 注意書きになります。
@warning 警告の記述になります。
@note 覚え書きになります。
@bug バグを記述します。バグはバグページに集約されます。
@todo Todoを記述します。TodoはTodoページに集約されます。
@deprecated 非推奨であることを表します。
@pre 事前条件を記述します。
@post 事後条件を記述します。
@see 参照先を指定します。
@name カテゴリを記述します。
@{ カテゴリの開始を表します。
@} カテゴリの終了を表します。
@fn ドキュメントの対象の関数を指定します。関数宣言位置から離れた場所でドキュメント付けを行いたい場合に利用します。