@par【ユーザ定義 (段落)】
@parblock・@endparblock【段落ブロック】
@internal・@endinternal【内部文書】
@copydoc・@copybrief・@copydetails【ドキュメント複製】

@par【ユーザ定義 (段落)】

メモ

構文

@par [ユーザー定義段落タイトル]
    段落テキスト

例

/// @par ユーザー定義段落タイトル
///      段落テキストＡ
///      段落テキストＢ
/// @par
///      段落テキストＣ
///      段落テキストＤ
/// @par ユーザー定義段落タイトル
///      段落テキストＥ
///      段落テキストＦ

【HTML出力例】

ユーザー定義段落タイトル
段落テキストＡ 段落テキストＢ
段落テキストＣ 段落テキストＤ
ユーザー定義段落タイトル
段落テキストＥ 段落テキストＦ

/// 関数の説明
/// @user_flow 処理Ａ
/// @user 処理Ｂ
/// @user 処理Ｃ
void funcParA() {}

/// 関数の説明
void funcParB()
{
    /// @user_flow 処理Ｘ
    ;
    /// @user 処理Ｙ
    ;
    /// @user 処理Ｚ
    ;
}

ALIASES【エイリアス】

user_flow=@par "処理"
user=@par ""

【HTML出力例：void funcParA ( )】

関数の説明

処理
処理Ａ
処理Ｂ
処理Ｃ

【HTML出力例：void funcParB ( )】

関数の説明

処理
処理Ｘ
処理Ｙ
処理Ｚ

@parblock【段落ブロック (開始)】
@endparblock【段落ブロック (終了)】

メモ

構文

@parblock
段落ブロック
@endparblock

例

/// @warning 警告Ａ
/// @warning 警告Ｂ
/// @warning 警告Ｃ
///
/// @par ユーザー定義段落タイトル
///      段落テキストＡ
/// @par
///      段落テキストＢ
/// @par
///      段落テキストＣ
///
/// @warning 警告Ｄ (改行)@n
///          警告Ｅ (改行)@n
///          警告Ｆ
///
/// @par ユーザー定義段落タイトル
///      段落テキストＤ (改行)@n
///      段落テキストＥ (改行)@n
///      段落テキストＦ
///
/// @warning
/// @parblock
/// 警告Ｘ (parblock)
///
/// 警告Ｙ (parblock)
///
/// 警告Ｚ (parblock)
/// @endparblock
///
/// @par ユーザー定義段落タイトル
/// @parblock
///      段落テキストＸ (parblock)
///
///      段落テキストＹ (parblock)
///
///      段落テキストＺ (parblock)
/// @endparblock

【HTML出力例】

警告
警告Ａ
警告Ｂ
警告Ｃ
ユーザー定義段落タイトル
段落テキストＡ
段落テキストＢ
段落テキストＣ
警告
警告Ｄ (改行)
警告Ｅ (改行)
警告Ｆ
ユーザー定義段落タイトル
段落テキストＤ (改行)
段落テキストＥ (改行)
段落テキストＦ
警告

警告Ｘ (parblock)

警告Ｙ (parblock)

警告Ｚ (parblock)

ユーザー定義段落タイトル

段落テキストＸ (parblock)

段落テキストＹ (parblock)

段落テキストＺ (parblock)

@internal【内部文書 (開始)】
@endinternal【内部文書 (終了)】

メモ

構文

@internal
内部文書
[@endinternal]

コメントブロックの最後で自動終了

例

/// @internal
/// @bug バグ (内部文書)
/// @test テストケース (内部文書)
/// @note メモ (内部文書)
/// @endinternal

@copydoc【ドキュメント複製】
@copybrief【ドキュメント複製 (概要)】
@copydetails【ドキュメント複製 (詳細)】

メモ

  • ドキュメントの複製を記述
    • ドキュメントの重複を回避 (継承・オーバーロード 等で有用)
    • コピー元となるオブジェクト：メンバ(クラス・ファイル・グループ)・クラス・名前空間・グループ・ページ・ファイル (この順でチェック)
    • @copydoc【ドキュメント複製】：全体をコピー (再帰的な使用が可能、相互参照等は不可)
      @copybrief【ドキュメント複製 (概要)】：@brief【概要】部分をコピー
      @copydetails【ドキュメント複製 (詳細)】：@brief【概要】以外をコピー
  • 関連

構文

@copydoc コピー元オブジェクト
@copybrief コピー元オブジェクト
@copydetails コピー元オブジェクト

コピー元オブジェクト：一意となる指定

例

/// @brief 関数の概要
/// @details 関数の詳細
/// @todo TODO
/// @param p1 引数１の説明 (A)
void funcCopy(int p1) {}

/// @copydoc funcCopy(int p1)
/// @param p2 引数２の説明 (B)
/// @details 全てのコピー有り
void funcCopy(int p1, int p2) {}

/// @copybrief funcCopy(int p1)
/// @param p1 引数１の説明 (C)
/// @details 詳細・引数・TODOのコピー無し
void funcCopyBrief(int p1) {}

/// @copydetails funcCopy(int p1)
/// @details 詳細・引数・TODOのコピー有り
void funcCopyDetails(int p1) {}

【HTML出力例：void funcCopy ( int p1 )】

関数の概要

関数の詳細

todo
TODO
引数
p1引数１の説明 (A)

【HTML出力例：void funcCopy ( int p1, int p2 )】

関数の概要

関数の詳細

todo
TODO
引数
p1引数１の説明 (A)
p2引数２の説明 (B)

全てのコピー有り

【HTML出力例：void funcCopyBrief ( int p1 )】

関数の概要

引数
p1引数１の説明 (C)

詳細・引数・TODOのコピー無し

【HTML出力例：void funcCopyDetails ( int p1 )】

関数の詳細

todo
TODO
引数
p1引数１の説明 (A)

詳細・引数・TODOのコピー有り