@defgroup【グループ定義】
@addtogroup【グループ定義追加 (優先)】
@weakgroup【グループ定義追加 (通常)】
@{【グループブロック (開始)】・@}【グループブロック (終了)】
@ingroup【グループ化】
@name【メンバのグループ化】
@nosubgrouping【サブグループ化の防止】
@groupgraph【グループ依存関係図の表示】1.9.8
@hidegroupgraph【グループ依存関係図の非表示】1.9.8
@defgroup【グループ定義】
@addtogroup【グループ定義追加 (優先)】
@weakgroup【グループ定義追加 (通常)】
メモ
概要
- グループ定義・グループ定義追加
- 対象は @{【グループブロック (開始)】・@}【グループブロック (終了)】で囲む
- 入れ子可能
- 同一グループ名でタイトル不一致の場合、警告メッセージ
- @see【参照】・@ref【インライン参照】 で参照可
優先順位
〔 例 〕- 優先順位が高い順に
- @ingroup【グループ化】
- @defgroup【グループ定義】〔 例 〕
- @addtogroup【グループ定義追加 (優先)】〔 例 〕
- @weakgroup【グループ定義追加 (通常)】〔 例 〕
関連
外部リンク
構文
@defgroup グループ名 グループタイトル
@{
グループ化対象
@}
@addtogroup グループ名 [グループタイトル]
@{
グループ化対象
@}
@weakgroup グループ名 [グループタイトル]
@{
グループ化対象
@}
例:@defgroup
HTML出力例:GROUP_DEFGROUP
概要 (GROUP_DEFGROUP) [詳解]
クラス | |
class | ClassDefGroup |
概要 (ClassDefGroup) [詳解] | |
変数 | |
int | defGroup |
変数 (defGroup) | |
詳解
概要 (GROUP_DEFGROUP)
詳細 (GROUP_DEFGROUP)
- 覚え書き
- インライン参照 タイトル DefGroup 入れ子:親
- インライン参照 リンクテキスト (GROUP_DEFGROUP_PARENT)
- インライン参照 タイトル DefGroup 入れ子:子
- インライン参照 リンクテキスト (GROUP_DEFGROUP_CHILD)
【以下省略】
HTML出力例:GROUP_DEFGROUP_PARENT
概要 (GROUP_DEFGROUP_PARENT) [詳解]
モジュール | |
タイトル DefGroup 入れ子:子 | |
概要 (GROUP_DEFGROUP_CHILD) | |
変数 | |
int | defGroupParent |
変数 (defGroupParent) | |
詳解
概要 (GROUP_DEFGROUP_PARENT)
詳細 (GROUP_DEFGROUP_PARENT)
【以下省略】
HTML出力例:GROUP_DEFGROUP_CHILD
概要 (GROUP_DEFGROUP_CHILD) [詳解]
クラス | |
class | ClassDefGroupChild |
概要 (ClassDefGroupChild) [詳解] | |
詳解
概要 (GROUP_DEFGROUP_CHILD)
詳細 (GROUP_DEFGROUP_CHILD)
【以下省略】
例:@addtogroup
HTML出力例:GROUP_ADDTOGROUP
概要 (GROUP_ADDTOGROUP) [詳解]
クラス | |
class | ClassAddToGroup |
概要 (ClassAddToGroup) [詳解] | |
詳解
概要 (GROUP_ADDTOGROUP)
詳細 (GROUP_ADDTOGROUP)
【以下省略】
HTML出力例:GROUP_ADDTOGROUP_PARENT
概要 (GROUP_ADDTOGROUP_PARENT) [詳解]
モジュール | |
タイトル AddToGroup 入れ子:子 | |
概要 (GROUP_ADDTOGROUP_CHILD) | |
変数 | |
int | addToGroupParent |
変数 (addToGroupParent) | |
詳解
概要 (GROUP_ADDTOGROUP_PARENT)
詳細 (GROUP_ADDTOGROUP_PARENT)
【以下省略】
HTML出力例:GROUP_ADDTOGROUP_CHILD
概要 (GROUP_ADDTOGROUP_CHILD) [詳解]
クラス | |
class | ClassAddToGroupChild |
概要 (ClassAddToGroupChild) [詳解] | |
詳解
概要 (GROUP_ADDTOGROUP_CHILD)
詳細 (GROUP_ADDTOGROUP_CHILD)
【以下省略】
例:@weakgroup
HTML出力例:
概要 (GROUP_WEAKGROUP) [詳解]
クラス | |
class | ClassWeakGroup |
概要 (ClassWeakGroup) [詳解] | |
詳解
概要 (GROUP_WEAKGROUP)
詳細 (GROUP_WEAKGROUP)
【以下省略】
HTML出力例:GROUP_WEAKGROUP_PARENT
概要 (GROUP_WEAKGROUP_PARENT) [詳解]
モジュール | |
タイトル WeakGroup 入れ子:子 | |
概要 (GROUP_WEAKGROUP_CHILD) | |
変数 | |
int | weakGroupParent |
変数 (weakGroupParent) | |
詳解
概要 (GROUP_WEAKGROUP_PARENT)
詳細 (GROUP_WEAKGROUP_PARENT)
【以下省略】
HTML出力例:GROUP_WEAKGROUP_CHILD
概要 (GROUP_WEAKGROUP_CHILD) [詳解]
クラス | |
class | ClassWeakGroupChild |
概要 (ClassWeakGroupChild) [詳解] | |
詳解
概要 (GROUP_WEAKGROUP_CHILD)
詳細 (GROUP_WEAKGROUP_CHILD)
【以下省略】
例:優先順位
HTML出力例:GROUP_PRIORITY_INGROUP
概要 (GROUP_PRIORITY_INGROUP) [詳解]
int | group_priority_ingroup_vs_defgroup |
int | group_priority_ingroup |
int | group_priority_defgroup_vs_ingroup |
詳解
概要 (GROUP_PRIORITY_INGROUP)
詳細 (GROUP_PRIORITY_INGROUP)
【以下省略】
HTML出力例:GROUP_PRIORITY_DEFGROUP
概要 (GROUP_PRIORITY_DEFGROUP) [詳解]
変数 | |
int | group_priority_defgroup_vs_addtogroup |
int | group_priority_defgroup_vs_weakgroup |
int | group_priority_defgroup |
int | group_priority_addtogroup_vs_defgroup |
int | group_priority_weakgroup_vs_defgroup |
詳解
概要 (GROUP_PRIORITY_DEFGROUP)
詳細 (GROUP_PRIORITY_DEFGROUP)
【以下省略】
HTML出力例:GROUP_PRIORITY_ADDTOGROUP
概要 (GROUP_PRIORITY_ADDTOGROUP) [詳解]
変数 | |
int | group_priority_addtogroup_vs_weakgroup |
int | group_priority_addtogroup |
int | group_priority_weakgroup_vs_addtogroup |
詳解
概要 (GROUP_PRIORITY_ADDTOGROUP)
詳細 (GROUP_PRIORITY_ADDTOGROUP)
【以下省略】
HTML出力例:GROUP_PRIORITY_WEAKGROUP
概要 (GROUP_PRIORITY_WEAKGROUP) [詳解]
変数 | |
int | group_priority_weakgroup |
詳解
概要 (GROUP_PRIORITY_WEAKGROUP)
詳細 (GROUP_PRIORITY_WEAKGROUP)
【以下省略】
@{【グループブロック (開始)】・@}【グループブロック (終了)】
メモ
概要
- グループ化対象を囲む
- 以下で使用
外部リンク
構文
@{
グループ化対象
@}
例
@ingroup【グループ化】
メモ
概要
- 追加するグループを記述 (複数グループ指定可)
- @defgroup【グループ定義】・@addtogroup【グループ定義追加 (優先)】・@weakgroup【グループ定義追加 (通常)】 で定義されたグループに追加
- 複合体 (クラス・ファイル・名前空間 等) は複数のグループに追加可能
- メンバ (変数・関数・typedef・列挙型 等) は複数のグループに追加不可 (複数グループ指定は警告メッセージ)
優先順位
〔例:@defgroup【グループ定義】の 例 〕- 優先順位が高い順に
- @ingroup【グループ化】
- @defgroup【グループ定義】
- @addtogroup【グループ定義追加 (優先)】
- @weakgroup【グループ定義追加 (通常)】
外部リンク
構文
@ingroup グループ名1 [グループ名2 [... グループ名N]]
例
HTML出力例:GROUP_INGROUP
概要 (GROUP_INGROUP) [詳解]
クラス | |
class | ClassInGroup_defgroup |
概要 (ClassInGroup_defgroup) [詳解] | |
class | ClassInGroup_ingroup |
概要 (ClassInGroup_ingroup) 複数グループ [詳解] | |
詳解
概要 (GROUP_INGROUP)
詳細 (GROUP_INGROUP)
HTML出力例:GROUP_INGROUP_2
概要 (GROUP_INGROUP_2) [詳解]
クラス | |
class | ClassInGroup_addtogroup |
概要 (ClassInGroup_addtogroup) [詳解] | |
class | ClassInGroup_ingroup |
概要 (ClassInGroup_ingroup) 複数グループ [詳解] | |
変数 | |
int | inGroup |
詳解
概要 (GROUP_INGROUP_2)
詳細 (GROUP_INGROUP_2)
【以下省略】
HTML出力例:GROUP_INGROUP_3
概要 (GROUP_INGROUP_3) [詳解]
クラス | |
class | ClassInGroup_weakgroup |
概要 (ClassInGroup_weakgroup) [詳解] | |
class | ClassInGroup_ingroup |
概要 (ClassInGroup_ingroup) 複数グループ [詳解] | |
詳解
概要 (GROUP_INGROUP_3)
詳細 (GROUP_INGROUP_3)
@name【メンバのグループ化】
@nosubgrouping【サブグループ化の防止】
メモ
@name【メンバのグループ化】
- 複合体メンバのグループ化
- 次の @name【メンバのグループ化】が出現するか、複合体の定義が終わるまで有効
- 明示的に範囲を指定するには @{【グループブロック (開始)】・@}【グループブロック (終了)】 で範囲指定
@nosubgrouping【サブグループ化の防止】
- @name【メンバのグループ化】で指定したメンバグループが、アクセスレベル(public・protected・private) のサブグループになることを防止
- 複合体定義に記述
外部リンク
構文
@name [ヘッダー ]
@nosubgrouping
例:@name (1/2)
HTML出力例
概要 (ClassGroupName) [詳解]
公開メンバ関数 | |
void | method5 () |
概要 (method5) | |
GroupName1 | |
概要 (GroupName1) 詳細 (GroupName1) | |
void | method1 () |
概要 (method1) | |
void | method2 () |
概要 (method2) | |
GroupName2 | |
概要 (GroupName2) 詳細 (GroupName2) | |
void | method3 () |
void | method4 () |
概要 (ヘッダーなし) 詳細 (ヘッダーなし) | |
void | method6 () |
void | method7 () |
詳解
概要 (ClassGroupName)
詳細 (ClassGroupName)
【以下省略】
例:@name (2/2)
HTML出力例
概要 (structGroupName) [詳解]
公開変数類 | |
int | item_5 |
概要 (item_5) | |
GroupName1 | |
int | item_1 |
概要 (item_1) | |
int | item_2 |
概要 (item_2) | |
GroupName2 | |
int | item_3 |
概要 (item_3) | |
int | item_4 |
概要 (item_4) | |
GroupName3 | |
int | item_6 |
概要 (item_6) | |
詳解
概要 (structGroupName)
詳細 (structGroupName)
【以下省略】
例:@name + @nosubgrouping
HTML出力例
概要 (ClassGroupName2) [詳解]
公開変数類 | |
int | item_public_3 |
概要 (item_public_3) | |
限定公開変数類 | |
int | item_protected_3 |
概要 (item_protected_3) | |
非公開変数類 | |
int | item_private_3 |
概要 (item_private_3) | |
GroupName1 | |
int | item_public_1 |
概要 (item_public_1) | |
int | item_protected_1 |
概要 (item_protected_1) | |
int | item_private_1 |
概要 (item_private_1) | |
GroupName2 | |
int | item_public_2 |
概要 (item_public_2) | |
int | item_protected_2 |
概要 (item_protected_2) | |
int | item_private_2 |
概要 (item_private_2) | |
詳解
概要 (ClassGroupName2)
詳細 (ClassGroupName2)
【以下省略】
@groupgraph【グループ依存関係図の表示】1.9.8
@hidegroupgraph【グループ依存関係図の非表示】1.9.8
メモ
概要
- グループ依存関係図の表示・非表示を指定
外部リンク
構文
@groupgraph 1.9.8
@hidegroupgraph 1.9.8
例
HTML出力例:
概要 (GroupGraph) [詳解]
モジュール | |
TITLE GroupGraph_1 | |
概要 (GroupGraph_1) | |
TITLE GroupGraph_2 | |
概要 (GroupGraph_2) | |
クラス | |
class | ClassGroupGraph |
概要 (ClassGroupGraph) [詳解] | |
詳解
概要 (GroupGraph)
詳細 (GroupGraph)
HTML出力例:
概要 (GroupGraph_1) [詳解]
変数 | |
int | groupGraph_1 |
変数1 | |
詳解
概要 (GroupGraph_1)
詳細 (GroupGraph_1)
【以下省略】
HTML出力例:
概要 (GroupGraph_2) [詳解]
変数 | |
int | groupGraph_2 |
変数2 | |
詳解
概要 (GroupGraph_2)
詳細 (GroupGraph_2)
【以下省略】