My Project
|
#include <membergroup.h>
Public Member Functions | |
MemberGroup () | |
MemberGroup (Definition *parent, int id, const char *header, const char *docs, const char *docFile, int docLine) | |
~MemberGroup () | |
QCString | header () const |
int | groupId () const |
void | insertMember (MemberDef *md) |
void | setAnchors () |
void | writePlainDeclarations (OutputList &ol, ClassDef *cd, NamespaceDef *nd, FileDef *fd, GroupDef *gd, ClassDef *inheritedFrom, const char *inheritId) |
void | writeDeclarations (OutputList &ol, ClassDef *cd, NamespaceDef *nd, FileDef *fd, GroupDef *gd, bool showInline=FALSE) |
void | writeDocumentation (OutputList &ol, const char *scopeName, Definition *container, bool showEnumValues, bool showInline) |
void | writeDocumentationPage (OutputList &ol, const char *scopeName, Definition *container) |
void | writeTagFile (FTextStream &) |
void | addGroupedInheritedMembers (OutputList &ol, ClassDef *cd, MemberListType lt, ClassDef *inheritedFrom, const QCString &inheritId) |
const QCString & | documentation () const |
bool | allMembersInSameSection () const |
void | addToDeclarationSection () |
int | countDecMembers (GroupDef *gd=0) |
int | countDocMembers () |
int | countGroupedInheritedMembers (MemberListType lt) |
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 |
int | countInheritableMembers (ClassDef *inheritedFrom) const |
void | setInGroup (bool b) |
void | addListReferences (Definition *d) |
void | setRefItems (const QList< ListItemInfo > *sli) |
MemberList * | members () const |
Definition * | parent () const |
QCString | anchor () const |
QCString | docFile () const |
int | docLine () const |
void | marshal (StorageIntf *s) |
void | unmarshal (StorageIntf *s) |
Private Attributes | |
MemberList * | memberList |
MemberList * | inDeclSection |
int | grpId |
QCString | grpHeader |
QCString | fileName |
Definition * | scope |
QCString | doc |
bool | inSameSection |
int | m_numDecMembers |
int | m_numDocMembers |
Definition * | m_parent |
QCString | m_docFile |
int | m_docLine |
QList< ListItemInfo > * | m_xrefListItems |
A class representing a group of members.
Definition at line 40 of file membergroup.h.
MemberGroup::MemberGroup | ( | ) |
Definition at line 40 of file membergroup.cpp.
MemberGroup::MemberGroup | ( | Definition * | parent, |
int | id, | ||
const char * | header, | ||
const char * | docs, | ||
const char * | docFile, | ||
int | docLine | ||
) |
Definition at line 44 of file membergroup.cpp.
References doc, docFile(), docLine(), grpHeader, grpId, inDeclSection, inSameSection, m_docFile, m_docLine, m_numDecMembers, m_numDocMembers, m_parent, m_xrefListItems, memberList, MemberListType_memberGroup, parent(), and scope.
MemberGroup::~MemberGroup | ( | ) |
void MemberGroup::addGroupedInheritedMembers | ( | OutputList & | ol, |
ClassDef * | cd, | ||
MemberListType | lt, | ||
ClassDef * | inheritedFrom, | ||
const QCString & | inheritId | ||
) |
Definition at line 140 of file membergroup.cpp.
References MemberList::append(), MemberDef::getSectionList(), MemberList::listType(), m_parent, memberList, and MemberList::writePlainDeclarations().
Referenced by ClassDef::addGroupedInheritedMembers().
void MemberGroup::addListReferences | ( | Definition * | d | ) |
Definition at line 322 of file membergroup.cpp.
References MemberList::addListReferences(), addRefItem(), anchor(), Definition::getOutputFileBase(), grpHeader, m_xrefListItems, memberList, theTranslator, and Translator::trGroup().
Referenced by GroupDef::addListReferences(), NamespaceDef::addListReferences(), MemberList::addListReferences(), FileDef::addListReferences(), and ClassDef::addListReferences().
void MemberGroup::addToDeclarationSection | ( | ) |
Add this group as a subsection of the declaration section, instead of rendering it in its own section
Definition at line 182 of file membergroup.cpp.
References MemberList::addMemberGroup(), and inDeclSection.
Referenced by NamespaceDef::addMembersToMemberGroup(), FileDef::addMembersToMemberGroup(), and ClassDef::addMembersToMemberGroup().
|
inline |
Definition at line 67 of file membergroup.h.
References inSameSection.
Referenced by ClassDef::addGroupedInheritedMembers(), NamespaceDef::addMembersToMemberGroup(), FileDef::addMembersToMemberGroup(), ClassDef::addMembersToMemberGroup(), ClassDef::countMembersIncludingGrouped(), MemberGroupListContext::MemberGroupListContext(), NamespaceDef::writeMemberGroups(), FileDef::writeMemberGroups(), and ClassDef::writeMemberGroups().
QCString MemberGroup::anchor | ( | ) | const |
Definition at line 311 of file membergroup.cpp.
References grpHeader.
Referenced by addListReferences(), MemberGroupInfoContext::Private::groupAnchor(), and writeDeclarations().
int MemberGroup::countDecMembers | ( | GroupDef * | gd = 0 | ) |
Definition at line 192 of file membergroup.cpp.
References MemberList::countDecMembers(), m_numDecMembers, memberList, and MemberList::numDecMembers().
Referenced by MemberList::countDecMembers().
int MemberGroup::countDocMembers | ( | ) |
Definition at line 202 of file membergroup.cpp.
References MemberList::countDocMembers(), m_numDocMembers, memberList, and MemberList::numDocMembers().
Referenced by MemberList::countDocMembers().
int MemberGroup::countGroupedInheritedMembers | ( | MemberListType | lt | ) |
Definition at line 160 of file membergroup.cpp.
References MemberDef::getSectionList(), MemberList::listType(), m_parent, and memberList.
Referenced by ClassDef::countMemberDeclarations(), and ClassDef::countMembersIncludingGrouped().
int MemberGroup::countInheritableMembers | ( | ClassDef * | inheritedFrom | ) | const |
Definition at line 212 of file membergroup.cpp.
References MemberList::countInheritableMembers(), and memberList.
Referenced by MemberList::countInheritableMembers().
int MemberGroup::defineCount | ( | ) | const |
Definition at line 286 of file membergroup.cpp.
References MemberList::defineCount(), and memberList.
Referenced by MemberList::countDecMembers().
void MemberGroup::distributeMemberGroupDocumentation | ( | ) |
Definition at line 218 of file membergroup.cpp.
References MemberDef::briefDescription(), Definition::briefFile(), Definition::briefLine(), Definition::docFile(), Definition::docLine(), MemberDef::documentation(), Definition::inbodyDocumentation(), Definition::inbodyFile(), Definition::inbodyLine(), memberList, MemberDef::setBriefDescription(), MemberDef::setDocumentation(), and MemberDef::setInbodyDocumentation().
Referenced by GroupDef::distributeMemberGroupDocumentation(), NamespaceDef::distributeMemberGroupDocumentation(), FileDef::distributeMemberGroupDocumentation(), and ClassDef::distributeMemberGroupDocumentation().
|
inline |
Definition at line 92 of file membergroup.h.
References m_docFile.
Referenced by MemberGroup(), and MemberList::writeDeclarations().
|
inline |
Definition at line 93 of file membergroup.h.
References m_docLine.
Referenced by MemberGroup(), and MemberList::writeDeclarations().
|
inline |
Definition at line 66 of file membergroup.h.
References doc.
Referenced by MemberGroupInfoContext::Private::docs(), and MemberList::writeDeclarations().
int MemberGroup::enumCount | ( | ) | const |
Definition at line 266 of file membergroup.cpp.
References MemberList::enumCount(), and memberList.
Referenced by MemberList::countDecMembers().
int MemberGroup::enumValueCount | ( | ) | const |
Definition at line 271 of file membergroup.cpp.
References MemberList::enumValueCount(), and memberList.
Referenced by MemberList::countDecMembers().
void MemberGroup::findSectionsInDocumentation | ( | ) |
Definition at line 336 of file membergroup.cpp.
References doc, docFindSections(), MemberList::findSectionsInDocumentation(), m_docFile, and memberList.
Referenced by GroupDef::findSectionsInDocumentation(), NamespaceDef::findSectionsInDocumentation(), MemberList::findSectionsInDocumentation(), FileDef::findSectionsInDocumentation(), and ClassDef::findSectionsInDocumentation().
int MemberGroup::friendCount | ( | ) | const |
Definition at line 291 of file membergroup.cpp.
References MemberList::friendCount(), and memberList.
Referenced by MemberList::countDecMembers().
int MemberGroup::funcCount | ( | ) | const |
Definition at line 261 of file membergroup.cpp.
References MemberList::funcCount(), and memberList.
Referenced by MemberList::countDecMembers().
|
inline |
Definition at line 48 of file membergroup.h.
References grpId.
Referenced by MemberGroupSDict::compareValues().
|
inline |
Definition at line 47 of file membergroup.h.
References grpHeader.
Referenced by MemberGroupInfoContext::Private::groupTitle(), MemberDef::visibleMemberGroup(), MemberList::writeDeclarations(), NamespaceDef::writeMemberGroups(), FileDef::writeMemberGroups(), and VhdlDocGen::writeVHDLDeclarations().
void MemberGroup::insertMember | ( | MemberDef * | md | ) |
Definition at line 69 of file membergroup.cpp.
References MemberList::append(), MemberList::getFirst(), MemberDef::getGroupDef(), MemberDef::getGroupFileName(), MemberDef::getGroupHasDocs(), MemberDef::getGroupPri(), MemberDef::getGroupStartLine(), MemberDef::getSectionList(), inDeclSection, inSameSection, GroupDef::insertMember(), m_parent, memberList, and MemberDef::setGroupDef().
Referenced by addMembersToMemberGroup().
void MemberGroup::marshal | ( | StorageIntf * | s | ) |
Definition at line 342 of file membergroup.cpp.
References doc, fileName, grpHeader, grpId, inDeclSection, inSameSection, m_docFile, m_numDecMembers, m_numDocMembers, m_parent, m_xrefListItems, marshalBool(), marshalInt(), marshalItemInfoList(), marshalMemberList(), marshalObjPointer(), marshalQCString(), memberList, scope, and Doxygen::symbolStorage.
Referenced by MemberList::marshal().
|
inline |
Definition at line 88 of file membergroup.h.
References memberList.
Referenced by MemberGroupInfoContext::Private::members(), and writeBoxMemberList().
int MemberGroup::numDecMembers | ( | ) | const |
Definition at line 296 of file membergroup.cpp.
References memberList, and MemberList::numDecMembers().
Referenced by MemberList::countDecMembers().
int MemberGroup::numDocMembers | ( | ) | const |
Definition at line 301 of file membergroup.cpp.
References memberList, and MemberList::numDocMembers().
Referenced by MemberList::countDocMembers().
|
inline |
Definition at line 89 of file membergroup.h.
References m_parent.
Referenced by MemberGroup().
int MemberGroup::protoCount | ( | ) | const |
Definition at line 281 of file membergroup.cpp.
References memberList, and MemberList::protoCount().
Referenced by MemberList::countDecMembers().
void MemberGroup::setAnchors | ( | ) |
Definition at line 104 of file membergroup.cpp.
References memberList.
Referenced by ClassDef::computeAnchors().
void MemberGroup::setInGroup | ( | bool | b | ) |
Definition at line 306 of file membergroup.cpp.
References memberList, and MemberList::setInGroup().
Referenced by GroupDef::addMembersToMemberGroup(), and ClassDef::writeDeclaration().
void MemberGroup::setRefItems | ( | const QList< ListItemInfo > * | sli | ) |
Definition at line 376 of file membergroup.cpp.
References m_xrefListItems.
Referenced by addMembersToMemberGroup().
int MemberGroup::typedefCount | ( | ) | const |
Definition at line 276 of file membergroup.cpp.
References memberList, and MemberList::typedefCount().
Referenced by MemberList::countDecMembers().
void MemberGroup::unmarshal | ( | StorageIntf * | s | ) |
Definition at line 359 of file membergroup.cpp.
References doc, fileName, grpHeader, grpId, inDeclSection, inSameSection, m_docFile, m_numDecMembers, m_numDocMembers, m_parent, m_xrefListItems, memberList, scope, Doxygen::symbolStorage, unmarshalBool(), unmarshalInt(), unmarshalItemInfoList(), unmarshalMemberList(), unmarshalObjPointer(), and unmarshalQCString().
Referenced by MemberList::unmarshal().
int MemberGroup::varCount | ( | ) | const |
Definition at line 256 of file membergroup.cpp.
References memberList, and MemberList::varCount().
Referenced by MemberList::countDecMembers().
void MemberGroup::writeDeclarations | ( | OutputList & | ol, |
ClassDef * | cd, | ||
NamespaceDef * | nd, | ||
FileDef * | fd, | ||
GroupDef * | gd, | ||
bool | showInline = FALSE |
||
) |
Definition at line 109 of file membergroup.cpp.
References anchor(), doc, grpHeader, memberList, and MemberList::writeDeclarations().
Referenced by NamespaceDef::writeMemberGroups(), GroupDef::writeMemberGroups(), FileDef::writeMemberGroups(), and ClassDef::writeMemberGroups().
void MemberGroup::writeDocumentation | ( | OutputList & | ol, |
const char * | scopeName, | ||
Definition * | container, | ||
bool | showEnumValues, | ||
bool | showInline | ||
) |
Definition at line 128 of file membergroup.cpp.
References memberList, and MemberList::writeDocumentation().
Referenced by MemberList::writeDocumentation().
void MemberGroup::writeDocumentationPage | ( | OutputList & | ol, |
const char * | scopeName, | ||
Definition * | container | ||
) |
Definition at line 134 of file membergroup.cpp.
References memberList, and MemberList::writeDocumentationPage().
Referenced by MemberList::writeDocumentationPage().
void MemberGroup::writePlainDeclarations | ( | OutputList & | ol, |
ClassDef * | cd, | ||
NamespaceDef * | nd, | ||
FileDef * | fd, | ||
GroupDef * | gd, | ||
ClassDef * | inheritedFrom, | ||
const char * | inheritId | ||
) |
Definition at line 119 of file membergroup.cpp.
References memberList, and MemberList::writePlainDeclarations().
Referenced by ClassDef::writeDeclaration(), and MemberList::writeDeclarations().
void MemberGroup::writeTagFile | ( | FTextStream & | tagFile | ) |
Definition at line 395 of file membergroup.cpp.
References memberList, and MemberList::writeTagFile().
Referenced by NamespaceDef::writeTagFile(), GroupDef::writeTagFile(), MemberList::writeTagFile(), FileDef::writeTagFile(), and ClassDef::writeTagFile().
|
private |
Definition at line 105 of file membergroup.h.
Referenced by documentation(), findSectionsInDocumentation(), marshal(), MemberGroup(), unmarshal(), and writeDeclarations().
|
private |
Definition at line 103 of file membergroup.h.
Referenced by marshal(), unmarshal(), res2cc_cmd.VerbatimFile::writeDirEntry(), res2cc_cmd.CSSFile::writeDirEntry(), res2cc_cmd.LumFile::writeDirEntry(), and res2cc_cmd.LumaFile::writeDirEntry().
|
private |
Definition at line 102 of file membergroup.h.
Referenced by addListReferences(), anchor(), header(), marshal(), MemberGroup(), unmarshal(), and writeDeclarations().
|
private |
Definition at line 101 of file membergroup.h.
Referenced by groupId(), marshal(), MemberGroup(), and unmarshal().
|
private |
Definition at line 100 of file membergroup.h.
Referenced by addToDeclarationSection(), insertMember(), marshal(), MemberGroup(), and unmarshal().
|
private |
Definition at line 106 of file membergroup.h.
Referenced by allMembersInSameSection(), insertMember(), marshal(), MemberGroup(), and unmarshal().
|
private |
Definition at line 110 of file membergroup.h.
Referenced by docFile(), findSectionsInDocumentation(), marshal(), MemberGroup(), and unmarshal().
|
private |
Definition at line 111 of file membergroup.h.
Referenced by docLine(), and MemberGroup().
|
private |
Definition at line 107 of file membergroup.h.
Referenced by countDecMembers(), marshal(), MemberGroup(), and unmarshal().
|
private |
Definition at line 108 of file membergroup.h.
Referenced by countDocMembers(), marshal(), MemberGroup(), and unmarshal().
|
private |
Definition at line 109 of file membergroup.h.
Referenced by addGroupedInheritedMembers(), countGroupedInheritedMembers(), insertMember(), marshal(), MemberGroup(), parent(), and unmarshal().
|
private |
Definition at line 112 of file membergroup.h.
Referenced by addListReferences(), marshal(), MemberGroup(), setRefItems(), and unmarshal().
|
private |
Definition at line 99 of file membergroup.h.
Referenced by addGroupedInheritedMembers(), addListReferences(), countDecMembers(), countDocMembers(), countGroupedInheritedMembers(), countInheritableMembers(), defineCount(), distributeMemberGroupDocumentation(), enumCount(), enumValueCount(), findSectionsInDocumentation(), friendCount(), funcCount(), insertMember(), marshal(), MemberGroup(), members(), numDecMembers(), numDocMembers(), protoCount(), setAnchors(), setInGroup(), typedefCount(), unmarshal(), varCount(), writeDeclarations(), writeDocumentation(), writeDocumentationPage(), writePlainDeclarations(), writeTagFile(), and ~MemberGroup().
|
private |
Definition at line 104 of file membergroup.h.
Referenced by marshal(), MemberGroup(), and unmarshal().