@defgroup【グループ定義】
@addtogroup【グループ定義追加 (優先)】
@weakgroup【グループ定義追加 (通常)】
@{【グループブロック (開始)】・@}【グループブロック (終了)】
@ingroup【グループ化】
@name【メンバのグループ化】
@nosubgrouping【サブグループ化の防止】
@groupgraph【グループ依存関係図の表示】1.9.8
@hidegroupgraph【グループ依存関係図の非表示】1.9.8

@defgroup【グループ定義】
@addtogroup【グループ定義追加 (優先)】
@weakgroup【グループ定義追加 (通常)】

メモ

概要

優先順位

  • 優先順位が高い順に

関連

外部リンク

構文

@defgroup グループ名 グループタイトル
@{
グループ化対象
@}

@addtogroup グループ名 [グループタイトル]
@{
グループ化対象
@}

@weakgroup グループ名 [グループタイトル]
@{
グループ化対象
@}

例:@defgroup

/// @defgroup GROUP_DEFGROUP タイトル DefGroup
/// @brief 概要 (GROUP_DEFGROUP)
/// @details 詳細 (GROUP_DEFGROUP)
/// @see GROUP_DEFGROUP_PARENT
/// @see GROUP_DEFGROUP_CHILD
/// @note インライン参照 @ref GROUP_DEFGROUP_PARENT
/// @note インライン参照 @ref GROUP_DEFGROUP_PARENT "リンクテキスト (GROUP_DEFGROUP_PARENT)"
/// @note インライン参照 @ref GROUP_DEFGROUP_CHILD
/// @note インライン参照 @ref GROUP_DEFGROUP_CHILD "リンクテキスト (GROUP_DEFGROUP_CHILD)"
/// @{

int defGroup;  ///< 変数 (defGroup)

/// @brief 概要 (ClassDefGroup)
/// @details 詳細 (ClassDefGroup)
class ClassDefGroup { };

/// @}


/// @defgroup GROUP_DEFGROUP_PARENT タイトル DefGroup 入れ子:親
/// @brief 概要 (GROUP_DEFGROUP_PARENT)
/// @details 詳細 (GROUP_DEFGROUP_PARENT)
/// @{

int defGroupParent;  ///< 変数 (defGroupParent)

/// @defgroup GROUP_DEFGROUP_CHILD タイトル DefGroup 入れ子:子
/// @brief 概要 (GROUP_DEFGROUP_CHILD)
/// @details 詳細 (GROUP_DEFGROUP_CHILD)
/// @{

/// @brief 概要 (ClassDefGroupChild)
/// @details 詳細 (ClassDefGroupChild)
class ClassDefGroupChild { };

/// @}

/// @}

HTML出力例:GROUP_DEFGROUP

タイトル DefGroup

概要 (GROUP_DEFGROUP) [詳解]

クラス
class  ClassDefGroup
 概要 (ClassDefGroup) [詳解]
 
変数
int defGroup
 変数 (defGroup)
 
詳解

概要 (GROUP_DEFGROUP)

詳細 (GROUP_DEFGROUP)

参照
タイトル DefGroup 入れ子:親
タイトル DefGroup 入れ子:子
覚え書き
インライン参照 タイトル DefGroup 入れ子:親
インライン参照 リンクテキスト (GROUP_DEFGROUP_PARENT)
インライン参照 タイトル DefGroup 入れ子:子
インライン参照 リンクテキスト (GROUP_DEFGROUP_CHILD)

【以下省略】

HTML出力例:GROUP_DEFGROUP_PARENT

タイトル DefGroup 入れ子:親

概要 (GROUP_DEFGROUP_PARENT) [詳解]

モジュール
 タイトル DefGroup 入れ子:子
 概要 (GROUP_DEFGROUP_CHILD)
 
変数
int defGroupParent
 変数 (defGroupParent)
 
詳解

概要 (GROUP_DEFGROUP_PARENT)

詳細 (GROUP_DEFGROUP_PARENT)

【以下省略】

HTML出力例:GROUP_DEFGROUP_CHILD

タイトル DefGroup 入れ子:子

概要 (GROUP_DEFGROUP_CHILD) [詳解]

クラス
class  ClassDefGroupChild
 概要 (ClassDefGroupChild) [詳解]
 
詳解

概要 (GROUP_DEFGROUP_CHILD)

詳細 (GROUP_DEFGROUP_CHILD)

【以下省略】


例:@addtogroup

/// @addtogroup GROUP_ADDTOGROUP タイトル AddToGroup
/// @brief 概要 (GROUP_ADDTOGROUP)
/// @details 詳細 (GROUP_ADDTOGROUP)
/// @{

/// @brief 概要 (ClassAddToGroup)
/// @details 詳細 (ClassAddToGroup)
class ClassAddToGroup { };

/// @}


/// @addtogroup GROUP_ADDTOGROUP_PARENT タイトル AddToGroup 入れ子:親
/// @brief 概要 (GROUP_ADDTOGROUP_PARENT)
/// @details 詳細 (GROUP_ADDTOGROUP_PARENT)
/// @{

int addToGroupParent;  ///< 変数 (addToGroupParent)

/// @addtogroup GROUP_ADDTOGROUP_CHILD タイトル AddToGroup 入れ子:子
/// @brief 概要 (GROUP_ADDTOGROUP_CHILD)
/// @details 詳細 (GROUP_ADDTOGROUP_CHILD)
/// @{

/// @brief 概要 (ClassAddToGroupChild)
/// @details 詳細 (ClassAddToGroupChild)
class ClassAddToGroupChild { };

/// @}

/// @}

HTML出力例:GROUP_ADDTOGROUP

タイトル AddToGroup

概要 (GROUP_ADDTOGROUP) [詳解]

クラス
class  ClassAddToGroup
 概要 (ClassAddToGroup) [詳解]
 
詳解

概要 (GROUP_ADDTOGROUP)

詳細 (GROUP_ADDTOGROUP)

【以下省略】

HTML出力例:GROUP_ADDTOGROUP_PARENT

タイトル AddToGroup 入れ子:親

概要 (GROUP_ADDTOGROUP_PARENT) [詳解]

モジュール
 タイトル AddToGroup 入れ子:子
 概要 (GROUP_ADDTOGROUP_CHILD)
 
変数
int addToGroupParent
 変数 (addToGroupParent)
 
詳解

概要 (GROUP_ADDTOGROUP_PARENT)

詳細 (GROUP_ADDTOGROUP_PARENT)

【以下省略】

HTML出力例:GROUP_ADDTOGROUP_CHILD

タイトル AddToGroup 入れ子:子

概要 (GROUP_ADDTOGROUP_CHILD) [詳解]

クラス
class  ClassAddToGroupChild
 概要 (ClassAddToGroupChild) [詳解]
 
詳解

概要 (GROUP_ADDTOGROUP_CHILD)

詳細 (GROUP_ADDTOGROUP_CHILD)

【以下省略】


例:@weakgroup

/// @weakgroup GROUP_WEAKGROUP タイトル WeakGroup
/// @brief 概要 (GROUP_WEAKGROUP)
/// @details 詳細 (GROUP_WEAKGROUP)
/// @{

/// @brief 概要 (ClassWeakGroup)
/// @details 詳細 (ClassWeakGroup)
class ClassWeakGroup { };

/// @}


/// @weakgroup GROUP_WEAKGROUP_PARENT タイトル WeakGroup 入れ子:親
/// @brief 概要 (GROUP_WEAKGROUP_PARENT)
/// @details 詳細 (GROUP_WEAKGROUP_PARENT)
/// @{

int weakGroupParent;  ///< 変数 (weakGroupParent)

/// @weakgroup GROUP_WEAKGROUP_CHILD タイトル WeakGroup 入れ子:子
/// @brief 概要 (GROUP_WEAKGROUP_CHILD)
/// @details 詳細 (GROUP_WEAKGROUP_CHILD)
/// @{

/// @brief 概要 (ClassWeakGroupChild)
/// @details 詳細 (ClassWeakGroupChild)
class ClassWeakGroupChild { };

/// @}

/// @}

HTML出力例:

タイトル WeakGroup

概要 (GROUP_WEAKGROUP) [詳解]

クラス
class  ClassWeakGroup
 概要 (ClassWeakGroup) [詳解]
 
詳解

概要 (GROUP_WEAKGROUP)

詳細 (GROUP_WEAKGROUP)

【以下省略】

HTML出力例:GROUP_WEAKGROUP_PARENT

タイトル WeakGroup 入れ子:親

概要 (GROUP_WEAKGROUP_PARENT) [詳解]

モジュール
 タイトル WeakGroup 入れ子:子
 概要 (GROUP_WEAKGROUP_CHILD)
 
変数
int weakGroupParent
 変数 (weakGroupParent)
 
詳解

概要 (GROUP_WEAKGROUP_PARENT)

詳細 (GROUP_WEAKGROUP_PARENT)

【以下省略】

HTML出力例:GROUP_WEAKGROUP_CHILD

タイトル WeakGroup 入れ子:子

概要 (GROUP_WEAKGROUP_CHILD) [詳解]

クラス
class  ClassWeakGroupChild
 概要 (ClassWeakGroupChild) [詳解]
 
詳解

概要 (GROUP_WEAKGROUP_CHILD)

詳細 (GROUP_WEAKGROUP_CHILD)

【以下省略】


例:優先順位

/// @defgroup GROUP_PRIORITY_INGROUP グループ 優先比較 ingroup
/// @brief 概要 (GROUP_PRIORITY_INGROUP)
/// @details 詳細 (GROUP_PRIORITY_INGROUP)
/// @{
// 空
/// @}

/// @ingroup GROUP_PRIORITY_INGROUP
/// @{
extern int group_priority_ingroup_vs_defgroup;
/// @}

/// @defgroup GROUP_PRIORITY_DEFGROUP グループ 優先比較 defgroup
/// @brief 概要 (GROUP_PRIORITY_DEFGROUP)
/// @details 詳細 (GROUP_PRIORITY_DEFGROUP)
/// @{
extern int group_priority_defgroup_vs_addtogroup;
extern int group_priority_defgroup_vs_weakgroup;
/// @}

/// @addtogroup GROUP_PRIORITY_ADDTOGROUP グループ 優先比較 addtogroup
/// @brief 概要 (GROUP_PRIORITY_ADDTOGROUP)
/// @details 詳細 (GROUP_PRIORITY_ADDTOGROUP)
/// @{
extern int group_priority_addtogroup_vs_defgroup;
extern int group_priority_addtogroup_vs_weakgroup;
/// @}

/// @weakgroup GROUP_PRIORITY_WEAKGROUP グループ 優先比較 weakgroup
/// @brief 概要 (GROUP_PRIORITY_WEAKGROUP)
/// @details 詳細 (GROUP_PRIORITY_WEAKGROUP)
/// @{
extern int group_priority_weakgroup_vs_defgroup;
extern int group_priority_weakgroup_vs_addtogroup;
/// @}


/// @ingroup GROUP_PRIORITY_INGROUP
/// @{
int group_priority_ingroup;
int group_priority_defgroup_vs_ingroup;
/// @}

/// @defgroup GROUP_PRIORITY_DEFGROUP グループ 優先比較 defgroup
/// @{
int group_priority_defgroup;
int group_priority_addtogroup_vs_defgroup;
int group_priority_weakgroup_vs_defgroup;
/// @}

/// @addtogroup GROUP_PRIORITY_ADDTOGROUP
/// @{
int group_priority_addtogroup;
int group_priority_defgroup_vs_addtogroup;
int group_priority_weakgroup_vs_addtogroup;
/// @}

/// @weakgroup GROUP_PRIORITY_WEAKGROUP
/// @{
int group_priority_weakgroup;
int group_priority_defgroup_vs_weakgroup;
int group_priority_addtogroup_vs_weakgroup;
/// @}

HTML出力例:GROUP_PRIORITY_INGROUP

グループ 優先比較 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

グループ 優先比較 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

グループ 優先比較 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

グループ 優先比較 weakgroup

概要 (GROUP_PRIORITY_WEAKGROUP) [詳解]

変数
int group_priority_weakgroup
 
詳解

概要 (GROUP_PRIORITY_WEAKGROUP)

詳細 (GROUP_PRIORITY_WEAKGROUP)

【以下省略】


@{【グループブロック (開始)】・@}【グループブロック (終了)】

メモ

概要

外部リンク

構文

@{
グループ化対象
@}


@ingroup【グループ化】

メモ

概要

優先順位

〔例:@defgroup【グループ定義】

外部リンク

構文

@ingroup グループ名1 [グループ名2 [... グループ名N]]

/// @defgroup GROUP_INGROUP タイトル InGroup
/// @brief 概要 (GROUP_INGROUP)
/// @details 詳細 (GROUP_INGROUP)
/// @{

/// @brief 概要 (ClassInGroup_defgroup)
/// @details 詳細 (ClassInGroup_defgroup)
class ClassInGroup_defgroup {};

/// @}

/// @addtogroup GROUP_INGROUP_2 タイトル InGroup (2)
/// @brief 概要 (GROUP_INGROUP_2)
/// @details 詳細 (GROUP_INGROUP_2)
/// @{

/// @brief 概要 (ClassInGroup_addtogroup)
/// @details 詳細 (ClassInGroup_addtogroup)
class ClassInGroup_addtogroup {};

/// @}

/// @weakgroup GROUP_INGROUP_3 タイトル InGroup (3)
/// @brief 概要 (GROUP_INGROUP_3)
/// @details 詳細 (GROUP_INGROUP_3)
/// @{

/// @brief 概要 (ClassInGroup_weakgroup)
/// @details 詳細 (ClassInGroup_weakgroup)
class ClassInGroup_weakgroup {};

/// @}

/// @ingroup GROUP_INGROUP_2
int inGroup;  ///< 変数 (inGroup)

/// @ingroup GROUP_INGROUP GROUP_INGROUP_2 GROUP_INGROUP_3
/// @brief 概要 (ClassInGroup_ingroup) 複数グループ
/// @details 詳細 (ClassInGroup_ingroup)
class ClassInGroup_ingroup {};

HTML出力例:GROUP_INGROUP

タイトル InGroup

概要 (GROUP_INGROUP) [詳解]

クラス
class  ClassInGroup_defgroup
 概要 (ClassInGroup_defgroup) [詳解]
 
class  ClassInGroup_ingroup
 概要 (ClassInGroup_ingroup) 複数グループ [詳解]
 
詳解

概要 (GROUP_INGROUP)

詳細 (GROUP_INGROUP)

HTML出力例:GROUP_INGROUP_2

タイトル 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

タイトル InGroup (3)

概要 (GROUP_INGROUP_3) [詳解]

クラス
class  ClassInGroup_weakgroup
 概要 (ClassInGroup_weakgroup) [詳解]
 
class  ClassInGroup_ingroup
 概要 (ClassInGroup_ingroup) 複数グループ [詳解]
 
詳解

概要 (GROUP_INGROUP_3)

詳細 (GROUP_INGROUP_3)


@name【メンバのグループ化】
@nosubgrouping【サブグループ化の防止】

メモ

@name【メンバのグループ化】

@nosubgrouping【サブグループ化の防止】

  • @name【メンバのグループ化】で指定したメンバグループが、アクセスレベル(publicprotectedprivate) のサブグループになることを防止
  • 複合体定義に記述

外部リンク

構文

@name [ヘッダー ]

@nosubgrouping

例:@name (1/2)

/// @brief 概要 (ClassGroupName)
/// @details 詳細 (ClassGroupName)
class ClassGroupName {
public:
    void method1();
    void method2();
    void method3();
    void method4();
    void method5();
    void method6();
    void method7();
};

/// @brief 概要 (GroupName1)
/// @details 詳細 (GroupName1)
/// @name GroupName1

/// @brief 概要 (method1)
/// @details 詳細 (method1)
void ClassGroupName::method1() {}

/// @brief 概要 (method2)
/// @details 詳細 (method2)
void ClassGroupName::method2() {}

/// @name GroupName2
/// @brief 概要 (GroupName2)
/// @details 詳細 (GroupName2)
/// @{
void ClassGroupName::method3() {}
void ClassGroupName::method4() {}
/// @}

/// @brief 概要 (method5)
/// @details 詳細 (method5)
void ClassGroupName::method5() {}

/// @name 
/// @brief 概要 (ヘッダーなし)
/// @details 詳細 (ヘッダーなし)
/// @{
void ClassGroupName::method6() {}
void ClassGroupName::method7() {}
/// @}

HTML出力例

ClassGroupName クラス

概要 (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)

/// @brief 概要 (structGroupName)
/// @details 詳細 (structGroupName)
struct structGroupName {
    /// @name GroupName1
    int item_1;  ///< 概要 (item_1)
    int item_2;  ///< 概要 (item_2)

    /// @name GroupName2
    /// @{
int item_3;  ///< 概要 (item_3)
    int item_4;  ///< 概要 (item_4)
    /// @}

int item_5;  ///< 概要 (item_5)

    /// @name GroupName3
    int item_6;  ///< 概要 (item_6)
};

HTML出力例

structGroupName 構造体

概要 (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

/// @brief 概要 (ClassGroupName2)
/// @details 詳細 (ClassGroupName2)
/// @nosubgrouping
class ClassGroupName2 {
public:
    /// @name GroupName1
    /// @{
    int item_public_1;  ///< 概要 (item_public_1)
    /// @}

/// @name GroupName2
    /// @{
    int item_public_2;  ///< 概要 (item_public_2)
    /// @}

int item_public_3;  ///< 概要 (item_public_3)

protected:
    /// @name GroupName1
    /// @{
    int item_protected_1;  ///< 概要 (item_protected_1)
    /// @}

/// @name GroupName2
    /// @{
    int item_protected_2;  ///< 概要 (item_protected_2)
    /// @}

int item_protected_3;  ///< 概要 (item_protected_3)

private:
    /// @name GroupName1
    /// @{
    int item_private_1;  ///< 概要 (item_private_1)
    /// @}

/// @name GroupName2
    /// @{
    int item_private_2;  ///< 概要 (item_private_2)
    /// @}

int item_private_3;  ///< 概要 (item_private_3)
};

HTML出力例

ClassGroupName2 クラス

概要 (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

/// @defgroup GroupGraph TITLE GroupGraph
/// @brief 概要 (GroupGraph)
/// @details 詳細 (GroupGraph)
/// @{
/// @groupgraph

/// @brief 概要 (ClassGroupGraph)
/// @details 詳細 (ClassGroupGraph)
class ClassGroupGraph { };

/// @defgroup GroupGraph_1 TITLE GroupGraph_1
/// @brief 概要 (GroupGraph_1)
/// @details 詳細 (GroupGraph_1)
/// @{
/// @hidegroupgraph
int groupGraph_1;  ///< 変数1
/// @}

/// @defgroup GroupGraph_2 TITLE GroupGraph_2
/// @brief 概要 (GroupGraph_2)
/// @details 詳細 (GroupGraph_2)
/// @{
/// @groupgraph
int groupGraph_2;  ///< 変数2
/// @}

/// @}

HTML出力例:

TITLE GroupGraph

概要 (GroupGraph) [詳解]

TITLE GroupGraph 連携図
モジュール
 TITLE GroupGraph_1
 概要 (GroupGraph_1)
 
 TITLE GroupGraph_2
 概要 (GroupGraph_2)
 
クラス
class  ClassGroupGraph
 概要 (ClassGroupGraph) [詳解]
 
詳解

概要 (GroupGraph)

詳細 (GroupGraph)

HTML出力例:

TITLE GroupGraph_1

概要 (GroupGraph_1) [詳解]

変数
int groupGraph_1
 変数1
 
詳解

概要 (GroupGraph_1)

詳細 (GroupGraph_1)

【以下省略】

HTML出力例:

TITLE GroupGraph_2

概要 (GroupGraph_2) [詳解]

TITLE GroupGraph_2 連携図
変数
int groupGraph_2
 変数2
 
詳解

概要 (GroupGraph_2)

詳細 (GroupGraph_2)

【以下省略】