doxygen 雛型(prototype)

doxygenで関数のコメントを付けるときの雛型(prototype)。

• sakuraエディタのdoxygenコメント方式(Qtスタイル)にする
• ソースとヘッダ両方に記述がある場合、ソースに付ける。
• ヘッダには\brief か非doxygenコメント

/*! \brief 短い説明

関数の詳しい説明

\param[in] 引数名1 引数1の説明
\param[in, out] 引数名2 引数2の説明
\retval 返り値 返り値の説明

\note 注釈
*/

- で箇条書き
-# で番号つき箇条書き