@mgroup tag

This tag specifies a custom member group for a declaration. Default is to group declarations in members list using predefined categories according to symbol type and access level. This tag can be used to declare a custom member group and list the declaration in that group.

See also @mgrouporder tag.

Syntax  

@mgroup {<group name>}

Example  

These declarations:

class MGroup
{
public:

typedef int foo_type_t;

int foo();
int bar();

/** @mgroup {Accessors} */
int get_a() const;

/** @mgroup {Accessors} */
void set_a(int a);

generate the following members list for the MGroup class:

Type  

  • typedef [...] foo_type_t

Functions  

  • int bar()
  • int foo()

Accessors  

  • int get_a() const
  • void set_a(int a)

Valid XHTML 1.0 StrictGenerated by diaxen on Sun Jan 8 22:43:00 2012 using MkDoc