@param【引数】
@result・@return・@returns【戻り値】
@retval【戻り値の詳細】
@exception・@throw・@throws【例外】

@param【引数】

メモ

構文

@param [[in]|[in,out]|[out]] 引数名 | 引数名リスト (カンマ区切り) 引数の説明

/// メソッドの説明
/// @param [in]     x 入力値1の説明
/// @param [in,out] y 入力値2・出力値1の説明
/// @param [out]    z 出力値2の説明
void method(int x, int* y, int* z)
{
    // 処理
}

/// メソッドの説明
/// @param x,y 入力値の説明
void method(int x, int y)
{
    // 処理
}

@result・@return・@returns【戻り値】

メモ

構文

@result  戻り値の説明
@return  戻り値の説明
@returns 戻り値の説明

/// メソッドの説明
/// @param x 入力値の説明
/// @return 戻り値の説明
int method(int x)
{
    int result;
    // 処理
    return result;
}

@retval【戻り値の詳細】

メモ

構文

@retval 戻り値 戻り値の詳細

/// @retval true 正常終了
/// @retval false 異常終了

/// @retval 0   正常
/// @retval <0 警告
/// @retval 0< エラー

/// @retval ENUM_OK       正常
/// @retval ENUM_WARNING1 警告1
/// @retval ENUM_WARNING2 警告2
/// @retval ENUM_ERROR1   エラー1
/// @retval ENUM_ERROR2   エラー2

【HTML出力例】

戻り値
true正常終了
false異常終了
戻り値
正常
<0警告
0<エラー
戻り値
ENUM_OK正常
ENUM_WARNING1警告1
ENUM_WARNING2警告2
ENUM_ERROR1エラー1
ENUM_ERROR2エラー2

@exception・@throw・@throws【例外】

メモ

構文

@exception 例外オブジェクト 例外の説明
@throw     例外オブジェクト 例外の説明
@throws    例外オブジェクト 例外の説明