#include <types.h>

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 }

Public Member Functions
	Grouping (const char *gn, GroupPri_t p)

	Grouping (const Grouping &g)

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

Public Attributes
QCString	groupname
	name of the group

GroupPri_t	pri
	priority of this definition

Detailed Description

Grouping info

Definition at line 61 of file types.h.

Member Enumeration Documentation

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 64 of file types.h.

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

Constructor & Destructor Documentation

Grouping::Grouping	(	const char *	gn,
		GroupPri_t	p
	)

inline

Definition at line 91 of file types.h.

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

Grouping::Grouping ( const Grouping & g )

inline

Definition at line 92 of file types.h.

: groupname(g.groupname), pri(g.pri) {}

Member Function Documentation

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

inlinestatic

Definition at line 75 of file types.h.

References GROUPING_AUTO_ADD, GROUPING_AUTO_DEF, GROUPING_AUTO_WEAK, and GROUPING_INGROUP.

Referenced by addMemberToGroups().

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