Doxygen 関数ヘッダの書き方 | かちょうのブログ

かちょうのブログ

ブログの説明を入力します。

御嶽山が噴火したらしい。
先日のNHKの火山爆発の特集では予知できると放送していたと思うけど。。

Doxygenの特殊コマンドはこちら

関数ヘッダに使用した特殊コマンド
/*! \file */

/*
\fn 関数名
\brief 機能名
\par 詳細説明
\author 作者
\date 実装日
\return 戻り値の説明
\param 引数の説明
\note 注意書き
*/

/*! \file */
はcファイルの先頭に

/*
\fn 関数名
途中省略
\note 注意書き
*/
は関数の直前に。

http://www.spread-net.co.jp/contents/company/index.htm