Grouping Struct Reference

Grouping info. More...

#include <src/types.h>

Collaboration diagram for Grouping:

Public Types
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. More...

Public Member Functions
	Grouping (const QCString &gn, GroupPri_t p)

Static Public Member Functions
static constexpr const char *	getGroupPriName (GroupPri_t priority) noexcept

Public Attributes
QCString	groupname
	name of the group
GroupPri_t	pri
	priority of this definition

Detailed Description

Grouping info.

Definition at line 226 of file types.h.

Member Enumeration Documentation

GroupPri_t

enum Grouping::GroupPri_t

Grouping priority.

Enumerator
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

Definition at line 229 of file types.h.

  {
    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
  };

Constructor & Destructor Documentation

Grouping()

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

inline

Definition at line 256 of file types.h.

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

References groupname, and pri.

Member Function Documentation

getGroupPriName()

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

inlinestaticconstexprnoexcept

Definition at line 240 of file types.h.

  {
    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 "???";
  }

References GROUPING_AUTO_ADD, GROUPING_AUTO_DEF, GROUPING_AUTO_WEAK, and GROUPING_INGROUP.

Referenced by addClassToGroups(), addConceptToGroups(), addDirToGroups(), addExampleToGroups(), addGroupToGroups(), addMemberToGroups(), addModuleToGroups(), addNamespaceToGroups(), buildFileList(), and tryAddEnumDocsToGroupMember().

Member Data Documentation

groupname

QCString Grouping::groupname

name of the group

Definition at line 257 of file types.h.

Referenced by addClassToGroups(), addConceptToGroups(), addDirToGroups(), addExampleToGroups(), addGroupToGroups(), addMemberToGroups(), addModuleToGroups(), addNamespaceToGroups(), addRelatedPage(), buildFileList(), findUsingDirectives(), and Grouping().

pri

GroupPri_t Grouping::pri

priority of this definition

Definition at line 258 of file types.h.

Referenced by addClassToGroups(), addConceptToGroups(), addDirToGroups(), addExampleToGroups(), addGroupToGroups(), addMemberToGroups(), addModuleToGroups(), addNamespaceToGroups(), buildFileList(), and Grouping().

---

The documentation for this struct was generated from the following file:

• src/types.h