MemberGroup Class Reference

#include <membergroup.h>

List of all members.

Public Member Functions

MemberGroup ()

MemberGroup (Definition *parent, int id, const char *header, const char *docs, const char *docFile)

~MemberGroup ()

QCString header () const

int groupId () const

void insertMember (MemberDef *md)

void setAnchors (ClassDef *)

void writePlainDeclarations (OutputList &ol, ClassDef *cd, NamespaceDef *nd, FileDef *fd, GroupDef *gd)

void writeDeclarations (OutputList &ol, ClassDef *cd, NamespaceDef *nd, FileDef *fd, GroupDef *gd)

void writeDocumentation (OutputList &ol, const char *scopeName, Definition *container)

void writeDocumentationPage (OutputList &ol, const char *scopeName, Definition *container)

QCString documentation ()

bool allMembersInSameSection ()

void addToDeclarationSection ()

int countDecMembers ()

int countDocMembers ()

void distributeMemberGroupDocumentation ()

void findSectionsInDocumentation ()

int varCount () const

int funcCount () const

int enumCount () const

int enumValueCount () const

int typedefCount () const

int protoCount () const

int defineCount () const

int friendCount () const

int numDecMembers () const

int numDocMembers () const

void setInGroup (bool b)

void addListReferences (Definition *d)

MemberList * members () const

Definition * parent () const

void marshal (StorageIntf *s)

void unmarshal (StorageIntf *s)

Detailed Description

Definition at line 38 of file membergroup.h.

Constructor & Destructor Documentation

MemberGroup::MemberGroup ( )

Definition at line 39 of file membergroup.cpp.

MemberGroup::MemberGroup	(	Definition *	parent,
		int	id,
		const char *	header,
		const char *	docs,
		const char *	docFile
	)

Definition at line 43 of file membergroup.cpp.

References MemberList::memberGroup, and parent().

MemberGroup::~MemberGroup ( )

Definition at line 61 of file membergroup.cpp.

Member Function Documentation

QCString MemberGroup::header ( ) const [inline]

Definition at line 45 of file membergroup.h.

Referenced by PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForNamespace(), MemberDef::visibleMemberGroup(), MemberList::writeDeclarations(), NamespaceDef::writeDocumentation(), FileDef::writeDocumentation(), and VhdlDocGen::writeVHDLDeclarations().

int MemberGroup::groupId ( ) const [inline]

Definition at line 46 of file membergroup.h.

void MemberGroup::insertMember ( MemberDef * md )

Definition at line 66 of file membergroup.cpp.

References MemberList::append(), MemberDef::getGroupDef(), MemberDef::getGroupFileName(), MemberDef::getGroupHasDocs(), MemberDef::getGroupPri(), MemberDef::getGroupStartLine(), MemberDef::getSectionList(), GroupDef::insertMember(), and MemberDef::setGroupDef().

Referenced by addMembersToMemberGroup().

void MemberGroup::setAnchors ( ClassDef * )

Definition at line 99 of file membergroup.cpp.

Referenced by ClassDef::computeAnchors().

void MemberGroup::writePlainDeclarations	(	OutputList &	ol,
		ClassDef *	cd,
		NamespaceDef *	nd,
		FileDef *	fd,
		GroupDef *	gd
	)

Definition at line 111 of file membergroup.cpp.

References MemberList::writePlainDeclarations().

Referenced by ClassDef::writeDeclaration(), and MemberList::writeDeclarations().

void MemberGroup::writeDeclarations	(	OutputList &	ol,
		ClassDef *	cd,
		NamespaceDef *	nd,
		FileDef *	fd,
		GroupDef *	gd
	)

Definition at line 104 of file membergroup.cpp.

References MemberList::writeDeclarations().

Referenced by NamespaceDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), and ClassDef::writeDocumentation().

void MemberGroup::writeDocumentation	(	OutputList &	ol,
		const char *	scopeName,
		Definition *	container
	)

Definition at line 119 of file membergroup.cpp.

References MemberList::writeDocumentation().

Referenced by MemberList::writeDocumentation().

void MemberGroup::writeDocumentationPage	(	OutputList &	ol,
		const char *	scopeName,
		Definition *	container
	)

Definition at line 125 of file membergroup.cpp.

References MemberList::writeDocumentationPage().

Referenced by MemberList::writeDocumentationPage().

QCString MemberGroup::documentation ( ) [inline]

Definition at line 58 of file membergroup.h.

Referenced by MemberList::writeDeclarations(), and VhdlDocGen::writeVHDLDeclarations().

bool MemberGroup::allMembersInSameSection ( ) [inline]

Definition at line 59 of file membergroup.h.

Referenced by NamespaceDef::addMembersToMemberGroup(), FileDef::addMembersToMemberGroup(), ClassDef::addMembersToMemberGroup(), NamespaceDef::writeDocumentation(), FileDef::writeDocumentation(), and ClassDef::writeDocumentation().

void MemberGroup::addToDeclarationSection ( )

Add this group as a subsection of the declaration section, instead of rendering it in its own section

Definition at line 134 of file membergroup.cpp.

References MemberList::addMemberGroup().

Referenced by NamespaceDef::addMembersToMemberGroup(), FileDef::addMembersToMemberGroup(), and ClassDef::addMembersToMemberGroup().

int MemberGroup::countDecMembers ( )

Definition at line 144 of file membergroup.cpp.

References MemberList::countDecMembers(), and MemberList::numDecMembers().

Referenced by MemberList::countDecMembers().

int MemberGroup::countDocMembers ( )

Definition at line 154 of file membergroup.cpp.

References MemberList::countDocMembers(), and MemberList::numDocMembers().

Referenced by MemberList::countDocMembers().

void MemberGroup::distributeMemberGroupDocumentation ( )

Definition at line 164 of file membergroup.cpp.

References Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Definition::docFile(), Definition::docLine(), Definition::documentation(), MemberDef::inbodyDocumentation(), MemberDef::inbodyFile(), MemberDef::inbodyLine(), Definition::setBriefDescription(), Definition::setDocumentation(), and MemberDef::setInbodyDocumentation().

Referenced by NamespaceDef::distributeMemberGroupDocumentation(), GroupDef::distributeMemberGroupDocumentation(), FileDef::distributeMemberGroupDocumentation(), and ClassDef::distributeMemberGroupDocumentation().

void MemberGroup::findSectionsInDocumentation ( )

Definition at line 250 of file membergroup.cpp.

References docFindSections(), and MemberList::findSectionsInDocumentation().

Referenced by NamespaceDef::findSectionsInDocumentation(), MemberList::findSectionsInDocumentation(), GroupDef::findSectionsInDocumentation(), FileDef::findSectionsInDocumentation(), and ClassDef::findSectionsInDocumentation().

int MemberGroup::varCount ( ) const

Definition at line 190 of file membergroup.cpp.

References MemberList::varCount().

Referenced by MemberList::countDecMembers().

int MemberGroup::funcCount ( ) const

Definition at line 195 of file membergroup.cpp.

References MemberList::funcCount().

Referenced by MemberList::countDecMembers().

int MemberGroup::enumCount ( ) const

Definition at line 200 of file membergroup.cpp.

References MemberList::enumCount().

Referenced by MemberList::countDecMembers().

int MemberGroup::enumValueCount ( ) const

Definition at line 205 of file membergroup.cpp.

References MemberList::enumValueCount().

Referenced by MemberList::countDecMembers().

int MemberGroup::typedefCount ( ) const

Definition at line 210 of file membergroup.cpp.

References MemberList::typedefCount().

Referenced by MemberList::countDecMembers().

int MemberGroup::protoCount ( ) const

Definition at line 215 of file membergroup.cpp.

References MemberList::protoCount().

Referenced by MemberList::countDecMembers().

int MemberGroup::defineCount ( ) const

Definition at line 220 of file membergroup.cpp.

References MemberList::defineCount().

Referenced by MemberList::countDecMembers().

int MemberGroup::friendCount ( ) const

Definition at line 225 of file membergroup.cpp.

References MemberList::friendCount().

Referenced by MemberList::countDecMembers().

int MemberGroup::numDecMembers ( ) const

Definition at line 230 of file membergroup.cpp.

References MemberList::numDecMembers().

Referenced by MemberList::countDecMembers().

int MemberGroup::numDocMembers ( ) const

Definition at line 235 of file membergroup.cpp.

References MemberList::numDocMembers().

Referenced by MemberList::countDocMembers().

void MemberGroup::setInGroup ( bool b )

Definition at line 240 of file membergroup.cpp.

References MemberList::setInGroup().

Referenced by GroupDef::addMembersToMemberGroup(), and ClassDef::writeDeclaration().

void MemberGroup::addListReferences ( Definition * d )

Definition at line 245 of file membergroup.cpp.

References MemberList::addListReferences().

Referenced by NamespaceDef::addListReferences(), MemberList::addListReferences(), GroupDef::addListReferences(), FileDef::addListReferences(), and ClassDef::addListReferences().

MemberList* MemberGroup::members ( ) const [inline]

Definition at line 77 of file membergroup.h.

Referenced by PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForNamespace(), and VhdlDocGen::writeVHDLDeclarations().

Definition* MemberGroup::parent ( ) const [inline]

Definition at line 78 of file membergroup.h.

Referenced by MemberGroup().

void MemberGroup::marshal ( StorageIntf * s )

Definition at line 256 of file membergroup.cpp.

References marshalBool(), marshalInt(), marshalMemberList(), marshalObjPointer(), and marshalQCString().

Referenced by MemberList::marshal().

void MemberGroup::unmarshal ( StorageIntf * s )

Definition at line 272 of file membergroup.cpp.

References unmarshalBool(), unmarshalInt(), unmarshalMemberList(), unmarshalObjPointer(), and unmarshalQCString().

The documentation for this class was generated from the following files:

Generated on Mon Mar 31 10:59:01 2008 by

doxygen

1.5.1