@tparam【テンプレート引数】
@concept【コンセプト (C++20)】1.9.2
@tparam【テンプレート引数】
メモ
- template 宣言の テンプレート引数を記述
- 複数指定可 (1つの段落に結合)
- コマンド内に複数指定可 (1行に結合)
- 別の位置に記述する場合は用途に合わせて、 @fn【関数・メソッド】・@class【クラス】を併用
- 関連
- 外部リンク
構文
@tparam テンプレート引数名 | テンプレート引数名リスト (カンマ区切り) テンプレート引数の説明
例
/// @brief テンプレート関数の概要
/// @details テンプレート関数の詳細
/// @tparam T1 テンプレート引数1の説明
/// @tparam T2 テンプレート引数2の説明
/// @param p1 引数1の説明
/// @param p2 引数2の説明
template <typename T1, typename T2>
void funcTemplateA(T1 p1, T2 p2)
{
// 処理
}
【HTML出力例】
テンプレート関数の概要
テンプレート関数の詳細
- テンプレート引数
T1 テンプレート引数1の説明 T2 テンプレート引数2の説明
- 引数
p1 引数1の説明 p2 引数2の説明
template <typename T1, typename T2>
void funcTemplateB(T1 p1, T2 p2)
{
// 処理
}
/// @fn funcTemplateB(T1, T2)
/// @brief テンプレート関数の概要
/// @details テンプレート関数の詳細
/// @tparam T1, T2 テンプレート引数の説明
/// @param p1 引数1の説明
/// @param p2 引数2の説明
【HTML出力例】
テンプレート関数の概要
テンプレート関数の詳細
- テンプレート引数
T1,T2 テンプレート引数の説明
- 引数
p1 引数1の説明 p2 引数2の説明
/// @brief テンプレートクラスの概要
/// @details テンプレートクラスの詳細
/// @tparam T テンプレート引数の説明
template<class T>
class CTemplateA {
T flag;
public:
CTemplateA(T flagValue)
{
flag = flagValue;
}
};
【HTML出力例】
テンプレートクラスの概要
テンプレートクラスの詳細
- テンプレート引数
T テンプレート引数の説明
template<class T>
class CTemplateB {
T flag;
public:
CTemplateB(T flagValue)
{
flag = flagValue;
}
};
/// @class CTemplateB
/// @brief テンプレートクラスの概要
/// @details テンプレートクラスの詳細
/// @tparam T テンプレート引数の説明
【HTML出力例】
テンプレートクラスの概要
テンプレートクラスの詳細
- テンプレート引数
T テンプレート引数の説明
@concept【コンセプト (C++20)】1.9.2
メモ
- C++20 (ISO/IEC 14882:2020) で追加された concept (コンセプト) を記述
- 通常は省略可
- 別の位置に記述する場合に使用
- 関連
- 外部リンク
構文
@concept コンセプト名
例
/// @brief コンセプトの概要
/// @details コンセプトの詳細 (@@concept 省略)
/// @tparam T テンプレート引数の説明
template <class T>
concept MyConceptA = requires (T& x) {
x.myMethod();
};
【HTML出力例】
コンセプトの概要
コンセプトの詳細 (@concept 省略)
- テンプレート引数
T テンプレート引数の説明
template <class T>
concept MyConceptB = std::is_integral_v<T>;
/// @concept MyConceptB
/// @brief コンセプトの概要
/// @details コンセプトの詳細
/// @tparam T テンプレート引数の説明
【HTML出力例】
コンセプトの概要
コンセプトの詳細
- テンプレート引数
T テンプレート引数の説明