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

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

メモ

構文

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

/// @par ユーザー定義段落タイトル
///      段落テキストA
///      段落テキストB
/// @par
///      段落テキストC
///      段落テキストD
/// @par ユーザー定義段落タイトル
///      段落テキストE
///      段落テキストF

【HTML出力例】

ユーザー定義段落タイトル
段落テキストA 段落テキストB
段落テキストC 段落テキストD
ユーザー定義段落タイトル
段落テキストE 段落テキストF
/// 関数の説明
/// @user_flow 処理A
/// @user 処理B
/// @user 処理C
void funcParA() {}

/// 関数の説明
void funcParB()
{
    /// @user_flow 処理X
    ;
    /// @user 処理Y
    ;
    /// @user 処理Z
    ;
}

ALIASES【エイリアス】

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

【HTML出力例】


【void funcParA ( ) 出力例】

関数の説明

処理
処理A
処理B
処理C

【void funcParB ( ) 出力例】

関数の説明

処理
処理X
処理Y
処理Z

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

メモ

構文

@parblock
【段落ブロック】
@endparblock

/// @warning 警告A
/// @warning 警告B
/// @warning 警告C
///
/// @par ユーザー定義段落タイトル
///      段落テキストA
/// @par
///      段落テキストB
/// @par
///      段落テキストC
///
/// @warning 警告D (改行)@n
///          警告E (改行)@n
///          警告F
///
/// @par ユーザー定義段落タイトル
///      段落テキストD (改行)@n
///      段落テキストE (改行)@n
///      段落テキストF
///
/// @warning
/// @parblock
/// 警告X (parblock)
///
/// 警告Y (parblock)
///
/// 警告Z (parblock)
/// @endparblock
///
/// @par ユーザー定義段落タイトル
/// @parblock
///      段落テキストX (parblock)
///
///      段落テキストY (parblock)
///
///      段落テキストZ (parblock)
/// @endparblock

【HTML出力例】

警告
警告A
警告B
警告C
ユーザー定義段落タイトル
段落テキストA
段落テキストB
段落テキストC
警告
警告D (改行)
警告E (改行)
警告F
ユーザー定義段落タイトル
段落テキストD (改行)
段落テキストE (改行)
段落テキストF
警告

警告X (parblock)

警告Y (parblock)

警告Z (parblock)

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

段落テキストX (parblock)

段落テキストY (parblock)

段落テキストZ (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 引数1の説明
void funcCopy(int p1) {}

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

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

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

【HTML出力例】


【void funcCopy ( int p1 ) 出力例】

関数の概要

関数の詳細

todo:
TODO
引数
p1引数1の説明

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

関数の概要

関数の詳細

todo:
TODO
引数
p1引数1の説明
p2引数2の説明

全てのコピー有り


【void funcCopyBrief ( int p1 ) 出力例】

関数の概要

引数
p1引数1の説明

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


【void funcCopyDetails ( int p1 ) 出力例】

関数の詳細

todo:
TODO
引数
p1引数1の説明

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