The MemberGroup Class Reference

A class representing a group of members. More...

Declaration

class MemberGroup { ... }

Included Headers

#include <src/membergroup.h>

Public Constructors Index

	MemberGroup (const Definition *container, int id, const QCString &header, const QCString &docs, const QCString &docFile, int docLine, MemberListContainer con)

Public Member Functions Index

QCString	header () const
int	groupId () const
void	insertMember (MemberDef *md)
void	setAnchors ()
void	writePlainDeclarations (OutputList &ol, bool inGroup, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod, int indentLevel, const ClassDef *inheritedFrom, const QCString &inheritId) const
void	writeDeclarations (OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod, bool showInline=FALSE) const
void	writeDocumentation (OutputList &ol, const QCString &scopeName, const Definition *container, bool showEnumValues, bool showInline) const
void	writeDocumentationPage (OutputList &ol, const QCString &scopeName, const DefinitionMutable *container) const
void	writeTagFile (TextStream &, bool qualifiedName=false)
void	addGroupedInheritedMembers (OutputList &ol, const ClassDef *cd, MemberListType lt, const ClassDef *inheritedFrom, const QCString &inheritId) const
void	setAnonymousEnumType ()
const QCString &	documentation () const
bool	allMembersInSameSection () const
void	addToDeclarationSection ()
void	countDecMembers ()
void	countDocMembers ()
int	countGroupedInheritedMembers (MemberListType lt)
void	distributeMemberGroupDocumentation ()
void	findSectionsInDocumentation (const Definition *d)
int	numDecMembers () const
int	numDecEnumValues () const
int	numDocMembers () const
int	numDocEnumValues () const
const Definition *	container () const
const Definition *	memberContainer () const
int	countInheritableMembers (const ClassDef *inheritedFrom) const
void	addListReferences (Definition *d)
void	setRefItems (const RefItemVector &sli)
const MemberList &	members () const
QCString	docFile () const
int	docLine () const

Private Member Attributes Index

const Definition *	m_container
std::unique_ptr< MemberList >	memberList
MemberList *	inDeclSection = nullptr
int	grpId = 0
QCString	grpHeader
QCString	fileName
QCString	doc
bool	inSameSection = true
QCString	m_docFile
int	m_docLine
RefItemVector	m_xrefListItems

Description

A class representing a group of members.

Definition at line 42 of file membergroup.h.

Public Constructors

MemberGroup()

MemberGroup::MemberGroup (const Definition * container, int id, const QCString & header, const QCString & docs, const QCString & docFile, int docLine, MemberListContainer con)

Declaration at line 46 of file membergroup.h, definition at line 32 of file membergroup.cpp.

32MemberGroup::MemberGroup(const Definition *container,int id,const QCString &hdr,

33 const QCString &d,const QCString &docFile,int docLine,

34 MemberListContainer con)

35 : m_container(container),

36 memberList(std::make_unique<MemberList>(MemberListType::MemberGroup(),con)),

37 grpId(id), grpHeader(hdr), doc(d), m_docFile(docFile), m_docLine(docLine)

38{

39 //printf("New member group id=%d header=%s desc=%s\n",id,hdr,d);

40 memberList->setNeedsSorting(Config_getBool(SORT_BRIEF_DOCS)); // detailed sections are already sorted elsewhere.

41 //printf("Member group docs='%s'\n",qPrint(doc));

42}

References Config_getBool, container, doc, docFile, docLine, grpHeader, grpId, m_container, m_docFile, m_docLine, MemberGroup and memberList.

Referenced by MemberGroup.

Public Member Functions

addGroupedInheritedMembers()

void MemberGroup::addGroupedInheritedMembers (OutputList & ol, const ClassDef * cd, MemberListType lt, const ClassDef * inheritedFrom, const QCString & inheritId)

Declaration at line 63 of file membergroup.h, definition at line 121 of file membergroup.cpp.

121void MemberGroup::addGroupedInheritedMembers(OutputList &ol,const ClassDef *cd,

122 MemberListType lt,

123 const ClassDef *inheritedFrom,const QCString &inheritId) const

124{

125 //printf("** addGroupedInheritedMembers()\n");

126 for (const auto &md : *memberList)

127 {

128 //printf("matching %d == %d\n",lt,md->getSectionList()->listType());

129 const MemberList *ml = md->getSectionList(m_container);

130 if (ml && lt==ml->listType())

131 {

132 MemberList mml(lt,MemberListContainer::Class);

133 mml.push_back(md);

134 mml.countDecMembers();

135 mml.writePlainDeclarations(ol,false,cd,nullptr,nullptr,nullptr,nullptr,0,inheritedFrom,inheritId);

136 }

137 }

138}

References Class, MemberList::countDecMembers, MemberList::listType, m_container, memberList, MemberVector::push_back and MemberList::writePlainDeclarations.

addListReferences()

void MemberGroup::addListReferences (Definition * d)

Declaration at line 84 of file membergroup.h, definition at line 267 of file membergroup.cpp.

267void MemberGroup::addListReferences(Definition *def)

268{

269 memberList->addListReferences(def);

270}

Reference memberList.

addToDeclarationSection()

void MemberGroup::addToDeclarationSection ()

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

Declaration at line 70 of file membergroup.h, definition at line 160 of file membergroup.cpp.

160void MemberGroup::addToDeclarationSection()

161{

162 if (inDeclSection)

163 {

164 //printf("Adding group %p to list %p (type=%d) memberList=%p\n",this,

165 // inDeclSection,inDeclSection->listType(),memberList);

166 inDeclSection->addMemberGroup(this);

167 }

168}

Reference inDeclSection.

allMembersInSameSection()

bool MemberGroup::allMembersInSameSection ()

inline

Definition at line 69 of file membergroup.h.

69 bool allMembersInSameSection() const { return inSameSection; }

Reference inSameSection.

container()

const Definition * MemberGroup::container ()

Declaration at line 80 of file membergroup.h, definition at line 180 of file membergroup.cpp.

180const Definition *MemberGroup::container() const

181{

182 return m_container;

183}

Reference m_container.

Referenced by MemberGroup, writeDocumentation and writeDocumentationPage.

countDecMembers()

void MemberGroup::countDecMembers ()

Declaration at line 71 of file membergroup.h, definition at line 170 of file membergroup.cpp.

170void MemberGroup::countDecMembers()

171{

172 memberList->countDecMembers();

173}

Reference memberList.

countDocMembers()

void MemberGroup::countDocMembers ()

Declaration at line 72 of file membergroup.h, definition at line 175 of file membergroup.cpp.

175void MemberGroup::countDocMembers()

176{

177 memberList->countDocMembers();

178}

Reference memberList.

countGroupedInheritedMembers()

int MemberGroup::countGroupedInheritedMembers (MemberListType lt)

Declaration at line 73 of file membergroup.h, definition at line 140 of file membergroup.cpp.

140int MemberGroup::countGroupedInheritedMembers(MemberListType lt)

141{

142 //printf("** countGroupedInheritedMembers()\n");

143 int count=0;

144 for (const auto &md : *memberList)

145 {

146 //printf("matching %d == %d\n",lt,md->getSectionList()->listType());

147 const MemberList *ml = md->getSectionList(m_container);

148 if (ml && lt==ml->listType())

149 {

150 count++;

151 }

152 }

153 return count;

154}

References MemberList::listType, m_container and memberList.

countInheritableMembers()

int MemberGroup::countInheritableMembers (const ClassDef * inheritedFrom)

Declaration at line 83 of file membergroup.h, definition at line 202 of file membergroup.cpp.

202int MemberGroup::countInheritableMembers(const ClassDef *inheritedFrom) const

203{

204 return memberList->countInheritableMembers(inheritedFrom);

205}

Reference memberList.

distributeMemberGroupDocumentation()

void MemberGroup::distributeMemberGroupDocumentation ()

Declaration at line 74 of file membergroup.h, definition at line 208 of file membergroup.cpp.

208void MemberGroup::distributeMemberGroupDocumentation()

209{

210 //printf("MemberGroup::distributeMemberGroupDocumentation() %s\n",qPrint(grpHeader));

211 const MemberDef *md = nullptr;

212 for (const auto &smd : *memberList)

213 {

214 //printf("checking md=%s\n",qPrint(md->name()));

215 // find the first member of the group with documentation

216 if (!smd->documentation().isEmpty() ||

217 !smd->briefDescription().isEmpty() ||

218 !smd->inbodyDocumentation().isEmpty()

219 )

220 {

221 //printf("found it!\n");

222 md = smd;

223 break;

224 }

225 }

226 if (md) // distribute docs of md to other members of the list

227 {

228 //printf("Member %s has documentation!\n",qPrint(md->name()));

229 for (const auto &iomd : *memberList)

230 {

231 MemberDefMutable *omd = toMemberDefMutable(iomd);

232 if (omd && md!=omd && omd->documentation().isEmpty() &&

233 omd->briefDescription().isEmpty() &&

234 omd->inbodyDocumentation().isEmpty()

235 )

236 {

237 //printf("Copying documentation to member %s\n",qPrint(omd->name()));

238 omd->setBriefDescription(md->briefDescription(),md->briefFile(),md->briefLine());

239 omd->setDocumentation(md->documentation(),md->docFile(),md->docLine());

240 omd->setInbodyDocumentation(md->inbodyDocumentation(),md->inbodyFile(),md->inbodyLine());

241 }

242 }

243 }

244}

References Definition::briefDescription, Definition::briefFile, Definition::briefLine, Definition::docFile, Definition::docLine, Definition::documentation, Definition::inbodyDocumentation, Definition::inbodyFile, Definition::inbodyLine, QCString::isEmpty, memberList, DefinitionMutable::setBriefDescription, DefinitionMutable::setDocumentation, DefinitionMutable::setInbodyDocumentation and toMemberDefMutable.

docFile()

QCString MemberGroup::docFile ()

inline

Definition at line 88 of file membergroup.h.

88 QCString docFile() const { return m_docFile; }

Reference m_docFile.

Referenced by MemberGroup.

docLine()

int MemberGroup::docLine ()

inline

Definition at line 89 of file membergroup.h.

89 int docLine() const { return m_docLine; }

Reference m_docLine.

Referenced by MemberGroup.

documentation()

const QCString & MemberGroup::documentation ()

inline

Definition at line 68 of file membergroup.h.

68 const QCString &documentation() const { return doc; }

Reference doc.

findSectionsInDocumentation()

void MemberGroup::findSectionsInDocumentation (const Definition * d)

Declaration at line 75 of file membergroup.h, definition at line 272 of file membergroup.cpp.

272void MemberGroup::findSectionsInDocumentation(const Definition *d)

273{

274 docFindSections(doc,d,m_docFile);

275 memberList->findSectionsInDocumentation(d);

276}

References doc, docFindSections, m_docFile and memberList.

groupId()

int MemberGroup::groupId ()

inline

Definition at line 49 of file membergroup.h.

49 int groupId() const { return grpId; }

Reference grpId.

header()

QCString MemberGroup::header ()

inline

Definition at line 48 of file membergroup.h.

48 QCString header() const { return grpHeader; }

Reference grpHeader.

insertMember()

void MemberGroup::insertMember (MemberDef * md)

Declaration at line 50 of file membergroup.h, definition at line 44 of file membergroup.cpp.

44void MemberGroup::insertMember(MemberDef *md)

45{

46 //printf("MemberGroup::insertMember(%s) inSameSection=%d md->getSectionList()=%s\n",qPrint(md->name()),

47 // inSameSection,qPrint(md->getSectionList(m_container)->listType().to_string()));

48

49 MemberDef *firstMd = memberList->empty() ? nullptr : memberList->front();

50 if (inSameSection && firstMd &&

51 firstMd->getSectionList(m_container)!=md->getSectionList(m_container))

52 {

53 //printf("inSameSection=FALSE\n");

54 inSameSection=FALSE;

55 }

56 else if (inDeclSection==nullptr)

57 {

58 inDeclSection = const_cast<MemberList*>(md->getSectionList(m_container));

59 //printf("inDeclSection=%p type=%d\n",inDeclSection,inDeclSection->listType());

60 }

61 memberList->push_back(md);

62

63 // copy the group of the first member in the memberGroup

64 GroupDef *gd = nullptr;

65 if (firstMd && !firstMd->isAlias() && (gd=firstMd->getGroupDef()))

66 {

67 MemberDefMutable *mdm = toMemberDefMutable(md);

68 if (mdm)

69 {

70 mdm->setGroupDef(gd, firstMd->getGroupPri(),

71 firstMd->getGroupFileName(),

72 firstMd->getGroupStartLine(),

73 firstMd->getGroupHasDocs());

74 }

75 gd->insertMember(md);

76 }

77}

References FALSE, MemberDef::getGroupDef, MemberDef::getGroupFileName, MemberDef::getGroupHasDocs, MemberDef::getGroupPri, MemberDef::getGroupStartLine, MemberDef::getSectionList, inDeclSection, inSameSection, GroupDef::insertMember, Definition::isAlias, m_container, memberList, MemberDefMutable::setGroupDef and toMemberDefMutable.

Referenced by addMembersToMemberGroup.

memberContainer()

const Definition * MemberGroup::memberContainer ()

Declaration at line 81 of file membergroup.h, definition at line 185 of file membergroup.cpp.

185const Definition *MemberGroup::memberContainer() const

186{

187 // return the container for the first member.

188 // Note this can be different from container() in case

189 // the member is rendered as part of a file but the members

190 // are actually of a namespace.

191 const Definition *ctx = nullptr;

192 if (memberList && !memberList->empty())

193 {

194 const MemberDef *md = memberList->front();

195 ctx = md->getClassDef();

196 if (ctx==nullptr) ctx = md->getNamespaceDef();

197 if (ctx==nullptr) ctx = md->getFileDef();

198 }

199 return ctx==nullptr ? m_container : ctx;

200}

References MemberDef::getClassDef, MemberDef::getFileDef, MemberDef::getNamespaceDef, m_container and memberList.

members()

const MemberList & MemberGroup::members ()

inline

Definition at line 86 of file membergroup.h.

86 const MemberList &members() const { return *memberList.get(); }

Reference memberList.

numDecEnumValues()

int MemberGroup::numDecEnumValues ()

Declaration at line 77 of file membergroup.h, definition at line 252 of file membergroup.cpp.

252int MemberGroup::numDecEnumValues() const

253{

254 return memberList->numDecEnumValues();

255}

Reference memberList.

numDecMembers()

int MemberGroup::numDecMembers ()

Declaration at line 76 of file membergroup.h, definition at line 247 of file membergroup.cpp.

247int MemberGroup::numDecMembers() const

248{

249 return memberList->numDecMembers();

250}

Reference memberList.

numDocEnumValues()

int MemberGroup::numDocEnumValues ()

Declaration at line 79 of file membergroup.h, definition at line 262 of file membergroup.cpp.

262int MemberGroup::numDocEnumValues() const

263{

264 return memberList->numDocEnumValues();

265}

Reference memberList.

numDocMembers()

int MemberGroup::numDocMembers ()

Declaration at line 78 of file membergroup.h, definition at line 257 of file membergroup.cpp.

257int MemberGroup::numDocMembers() const

258{

259 return memberList->numDocMembers();

260}

Reference memberList.

setAnchors()

void MemberGroup::setAnchors ()

Declaration at line 51 of file membergroup.h, definition at line 80 of file membergroup.cpp.

80void MemberGroup::setAnchors()

81{

82 memberList->setAnchors();

83}

Reference memberList.

setAnonymousEnumType()

void MemberGroup::setAnonymousEnumType ()

Declaration at line 66 of file membergroup.h, definition at line 116 of file membergroup.cpp.

116void MemberGroup::setAnonymousEnumType()

117{

118 memberList->setAnonymousEnumType();

119}

Reference memberList.

setRefItems()

void MemberGroup::setRefItems (const RefItemVector & sli)

Declaration at line 85 of file membergroup.h, definition at line 278 of file membergroup.cpp.

278void MemberGroup::setRefItems(const RefItemVector &sli)

279{

280 m_xrefListItems.insert(m_xrefListItems.end(), sli.cbegin(), sli.cend());

281}

Reference m_xrefListItems.

writeDeclarations()

void MemberGroup::writeDeclarations (OutputList & ol, const ClassDef * cd, const NamespaceDef * nd, const FileDef * fd, const GroupDef * gd, const ModuleDef * mod, bool showInline=FALSE)

Declaration at line 55 of file membergroup.h, definition at line 85 of file membergroup.cpp.

85void MemberGroup::writeDeclarations(OutputList &ol,

86 const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd,const ModuleDef *mod,

87 bool showInline) const

88{

89 //printf("MemberGroup::writeDeclarations() %s\n",qPrint(grpHeader));

90 QCString ldoc = doc;

91 memberList->writeDeclarations(ol,cd,nd,fd,gd,mod,grpHeader,ldoc,FALSE,showInline);

92}

References doc, FALSE, grpHeader and memberList.

writeDocumentation()

void MemberGroup::writeDocumentation (OutputList & ol, const QCString & scopeName, const Definition * container, bool showEnumValues, bool showInline)

Declaration at line 58 of file membergroup.h, definition at line 103 of file membergroup.cpp.

103void MemberGroup::writeDocumentation(OutputList &ol,const QCString &scopeName,

104 const Definition *container,bool showEnumValues,bool showInline) const

105{

106 //printf("MemberGroup::writeDocumentation() %s\n",qPrint(grpHeader));

107 memberList->writeDocumentation(ol,scopeName,container,QCString(),memberList->listType().toLabel(),showEnumValues,showInline);

108}

References container and memberList.

writeDocumentationPage()

void MemberGroup::writeDocumentationPage (OutputList & ol, const QCString & scopeName, const DefinitionMutable * container)

Declaration at line 60 of file membergroup.h, definition at line 110 of file membergroup.cpp.

110void MemberGroup::writeDocumentationPage(OutputList &ol,const QCString &scopeName,

111 const DefinitionMutable *container) const

112{

113 memberList->writeDocumentationPage(ol,scopeName,container);

114}

References container and memberList.

writePlainDeclarations()

void MemberGroup::writePlainDeclarations (OutputList & ol, bool inGroup, const ClassDef * cd, const NamespaceDef * nd, const FileDef * fd, const GroupDef * gd, const ModuleDef * mod, int indentLevel, const ClassDef * inheritedFrom, const QCString & inheritId)

Declaration at line 52 of file membergroup.h, definition at line 94 of file membergroup.cpp.

94void MemberGroup::writePlainDeclarations(OutputList &ol,bool inGroup,

95 const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd,const ModuleDef *mod,

96 int indentLevel,const ClassDef *inheritedFrom,const QCString &inheritId

97 ) const

98{

99 //printf("MemberGroup::writePlainDeclarations() memberList->count()=%d\n",memberList->count());

100 memberList->writePlainDeclarations(ol,inGroup,cd,nd,fd,gd,mod,indentLevel,inheritedFrom,inheritId);

101}

Reference memberList.

writeTagFile()

void MemberGroup::writeTagFile (TextStream & tagFile, bool qualifiedName=false)

Declaration at line 62 of file membergroup.h, definition at line 283 of file membergroup.cpp.

283void MemberGroup::writeTagFile(TextStream &tagFile,bool qualifiedName)

284{

285 memberList->writeTagFile(tagFile,qualifiedName);

286}

Reference memberList.

Private Member Attributes

doc

QCString MemberGroup::doc

Definition at line 98 of file membergroup.h.

98 QCString doc;

Referenced by documentation, findSectionsInDocumentation, MemberGroup and writeDeclarations.

fileName

QCString MemberGroup::fileName

Definition at line 97 of file membergroup.h.

97 QCString fileName; // base name of the generated file

grpHeader

QCString MemberGroup::grpHeader

Definition at line 96 of file membergroup.h.

96 QCString grpHeader;

Referenced by header, MemberGroup and writeDeclarations.

grpId

int MemberGroup::grpId = 0

Definition at line 95 of file membergroup.h.

95 int grpId = 0;

Referenced by groupId and MemberGroup.

inDeclSection

MemberList* MemberGroup::inDeclSection = nullptr

Definition at line 94 of file membergroup.h.

94 MemberList *inDeclSection = nullptr;

Referenced by addToDeclarationSection and insertMember.

inSameSection

bool MemberGroup::inSameSection = true

Definition at line 99 of file membergroup.h.

99 bool inSameSection = true;

Referenced by allMembersInSameSection and insertMember.

m_container

const Definition* MemberGroup::m_container

Definition at line 92 of file membergroup.h.

92 const Definition *m_container;

Referenced by addGroupedInheritedMembers, container, countGroupedInheritedMembers, insertMember, memberContainer and MemberGroup.

m_docFile

QCString MemberGroup::m_docFile

Definition at line 100 of file membergroup.h.

100 QCString m_docFile;

Referenced by docFile, findSectionsInDocumentation and MemberGroup.

m_docLine

int MemberGroup::m_docLine

Definition at line 101 of file membergroup.h.

101 int m_docLine;

Referenced by docLine and MemberGroup.

m_xrefListItems

RefItemVector MemberGroup::m_xrefListItems

Definition at line 102 of file membergroup.h.

102 RefItemVector m_xrefListItems;

Referenced by setRefItems.

memberList

std::unique_ptr<MemberList> MemberGroup::memberList

Definition at line 93 of file membergroup.h.

93 std::unique_ptr<MemberList> memberList; // list of all members in the group

Referenced by addGroupedInheritedMembers, addListReferences, countDecMembers, countDocMembers, countGroupedInheritedMembers, countInheritableMembers, distributeMemberGroupDocumentation, findSectionsInDocumentation, insertMember, memberContainer, MemberGroup, members, numDecEnumValues, numDecMembers, numDocEnumValues, numDocMembers, setAnchors, setAnonymousEnumType, writeDeclarations, writeDocumentation, writeDocumentationPage, writePlainDeclarations and writeTagFile.

---

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

• membergroup.cpp
• membergroup.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.