The Grouping Struct Reference

Grouping info. More...

Declaration

struct Grouping { ... }

Included Headers

#include <src/types.h>

Enumerations Index

enum	GroupPri_t { ... }
	Grouping priority. More...

Public Constructors Index

	Grouping (const QCString &gn, GroupPri_t p)

Public Member Attributes Index

QCString	groupname
	name of the group More...
GroupPri_t	pri
	priority of this definition More...

Public Static Functions Index

static const char *	getGroupPriName (GroupPri_t priority)

Description

Grouping info.

Definition at line 226 of file types.h.

Enumerations

GroupPri_t

enum Grouping::GroupPri_t

Grouping priority.

Enumeration values

GROUPING_LOWEST
GROUPING_AUTO_WEAK	membership in group was defined via @weakgroup (= GROUPING_LOWEST)
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)

Definition at line 229 of file types.h.

230 {

231 GROUPING_LOWEST,

232 GROUPING_AUTO_WEAK = GROUPING_LOWEST, //!< membership in group was defined via \@weakgroup

233 GROUPING_AUTO_ADD, //!< membership in group was defined via \@add[to]group

234 GROUPING_AUTO_DEF, //!< membership in group was defined via \@defgroup

235 GROUPING_AUTO_HIGHEST = GROUPING_AUTO_DEF,

236 GROUPING_INGROUP, //!< membership in group was defined by \@ingroup

237 GROUPING_HIGHEST = GROUPING_INGROUP

238 };

Public Constructors

Grouping()

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

inline

Definition at line 256 of file types.h.

256 Grouping( const QCString &gn, GroupPri_t p ) : groupname(gn), pri(p) {}

References groupname and pri.

Public Member Attributes

groupname

QCString Grouping::groupname

name of the group

Definition at line 257 of file types.h.

257 QCString groupname; //!< name of the group

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.

258 GroupPri_t pri; //!< priority of this definition

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

Public Static Functions

getGroupPriName()

const char * Grouping::getGroupPriName (GroupPri_t priority)

inline static

Definition at line 240 of file types.h.

240 static const char *getGroupPriName( GroupPri_t priority )

241 {

242 switch( priority )

243 {

244 case GROUPING_AUTO_WEAK:

245 return "@weakgroup";

246 case GROUPING_AUTO_ADD:

247 return "@addtogroup";

248 case GROUPING_AUTO_DEF:

249 return "@defgroup";

250 case GROUPING_INGROUP:

251 return "@ingroup";

252 }

253 return "???";

254 }

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.

---

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

• types.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.