Grouping结构体 参考

Grouping info 更多...

#include <types.h>

Grouping 的协作图:

Public 类型
enum	GroupPri_t {   GROUPING_LOWEST, GROUPING_AUTO_WEAK = GROUPING_LOWEST, GROUPING_AUTO_ADD, GROUPING_AUTO_DEF,   GROUPING_AUTO_HIGHEST = GROUPING_AUTO_DEF, GROUPING_INGROUP, GROUPING_HIGHEST = GROUPING_INGROUP }
	Grouping priority 更多...

Public 成员函数
	Grouping (const QCString &gn, GroupPri_t p)

静态 Public 成员函数
static const char *	getGroupPriName (GroupPri_t priority)

Public 属性
QCString	groupname
	name of the group 更多...
GroupPri_t	pri
	priority of this definition 更多...

详细描述

Grouping info

在文件 types.h 第 64 行定义.

成员枚举类型说明

GroupPri_t

enum Grouping::GroupPri_t

Grouping priority

枚举值
GROUPING_LOWEST
GROUPING_AUTO_WEAK	membership in group was defined via @weakgroup
GROUPING_AUTO_ADD	membership in group was defined via @add[to]group
GROUPING_AUTO_DEF	membership in group was defined via @defgroup
GROUPING_AUTO_HIGHEST
GROUPING_INGROUP	membership in group was defined by @ingroup
GROUPING_HIGHEST

在文件 types.h 第 67 行定义.

  {
    GROUPING_LOWEST,
    GROUPING_AUTO_WEAK = GROUPING_LOWEST,     //!< membership in group was defined via \@weakgroup
    GROUPING_AUTO_ADD,     //!< membership in group was defined via \@add[to]group
    GROUPING_AUTO_DEF,     //!< membership in group was defined via \@defgroup
    GROUPING_AUTO_HIGHEST = GROUPING_AUTO_DEF,
    GROUPING_INGROUP,      //!< membership in group was defined by \@ingroup
    GROUPING_HIGHEST = GROUPING_INGROUP
  };

构造及析构函数说明

Grouping()

Grouping::Grouping ( const QCString &  gn, GroupPri_t  p  )

inline

在文件 types.h 第 94 行定义.

: groupname(gn), pri(p) {}

成员函数说明

getGroupPriName()

static const char* Grouping::getGroupPriName ( GroupPri_t  priority )

inlinestatic

在文件 types.h 第 78 行定义.

  {
    switch( priority )
    {
      case GROUPING_AUTO_WEAK:
        return "@weakgroup";
      case GROUPING_AUTO_ADD:
        return "@addtogroup";
      case GROUPING_AUTO_DEF:
        return "@defgroup";
      case GROUPING_INGROUP:
        return "@ingroup";
    }
    return "???";
  }

引用了 GROUPING_AUTO_ADD, GROUPING_AUTO_DEF, GROUPING_AUTO_WEAK , 以及 GROUPING_INGROUP.

被这些函数引用 addMemberToGroups().

类成员变量说明

groupname

QCString Grouping::groupname

name of the group

在文件 types.h 第 95 行定义.

被这些函数引用 addClassToGroups(), addConceptToGroups(), addDirToGroups(), addExampleToGroups(), addGroupToGroups(), addMemberToGroups(), addNamespaceToGroups(), addRelatedPage(), buildFileList() , 以及 findUsingDirectives().

pri

GroupPri_t Grouping::pri

priority of this definition

在文件 types.h 第 96 行定义.

被这些函数引用 addMemberToGroups().

---

该结构体的文档由以下文件生成:

• src/types.h