ヘルプファイルの作り方 第二回「doxygen基本書式」
私が使用している doxygen の基本的な書き方を説明します。
開始は
と記述し、終端は
/*! もしくは /**
と記述します。
*/
次に各コマンドについて説明します。
コマンドは、コマンド名の最初に「@」か「\」をつけることで
コマンドとして認識します。
私は @派 なので各コマンドの説明は@マークを使用します。
次に、実際に一つのヘッダーファイルをdoxygen形式にした場合の例を記述します。
@file ファイルに対して使用します。
@brief 簡易記述として使うことのできるパラグラフを開始します。
@param 関数引数についての説明を開始します。
@return 関数の戻り値についての記述を開始します。
@b 強調表示を行います。
/*!
* @file
*
* @brief テストクラスを提供します。
*/
#ifndef INCLUDE_CTEST_H
#define INCLUDE_CTEST_H/*!
* @brief テストクラスです。
*/
class CTest
{
public :
/*!
* @brief コンストラクタ
*
* @param なし
*/
CTest();
/*!
* @brief デストラクタ
*/
~CTest();
/*!
* @brief 値を加算し、その合計を返します。
*
* @param val1 値1を指定します。
* @param val2 値2を指定します。
*
* @return @b val1 と @b val2 の合計を返します。
*/
int Sum(int val1, int val2);
};#endif // INCLUDE_CTEST_H
