Skip to main content

The DocGroup Class Reference

Declaration​

class DocGroup { ... }

Included Headers​

#include <src/docgroup.h>

Public Constructors Index​

DocGroup ()

Public Member Functions Index​

voidenterFile (const QCString &fileName, int)
voidleaveFile (const QCString &fileName, int line)
voidenterCompound (const QCString &fileName, int line, const QCString &name)
voidleaveCompound (const QCString &, int, const QCString &)
voidopen (Entry *e, const QCString &, int, bool implicit=false)
voidclose (Entry *e, const QCString &fileName, int line, bool foundInline, bool implicit=false)
voidinitGroupInfo (Entry *e)
boolisEmpty () const
voidclearHeader ()
voidappendHeader (const char)
voidaddDocs (Entry *e)

Private Member Functions Index​

intfindExistingGroup (const MemberGroupInfo *info)

Private Member Attributes Index​

intm_openCount = 0
QCStringm_memberGroupHeader
intm_memberGroupId = 0
QCStringm_memberGroupRelates
QCStringm_memberGroupDocs
std::vector< Grouping >m_autoGroupStack
QCStringm_compoundName

Definition at line 24 of file docgroup.h.

Public Constructors​

DocGroup()​

DocGroup::DocGroup ()
 inline

Definition at line 27 of file docgroup.h.

27 DocGroup() {};

Public Member Functions​

addDocs()​

void DocGroup::addDocs (Entry * e)

Declaration at line 40 of file docgroup.h, definition at line 205 of file docgroup.cpp.

205void DocGroup::addDocs(Entry *e)
206{
207 if (e->section.isMemberGrp())
208 {
209 m_memberGroupDocs=e->brief.stripWhiteSpace();
210 e->doc = stripLeadingAndTrailingEmptyLines(e->doc,e->docLine);
211 if (!m_memberGroupDocs.isEmpty() && !e->doc.isEmpty())
212 {
213 m_memberGroupDocs+="\n\n";
214 }
215 m_memberGroupDocs+=e->doc;
216 {
217 std::lock_guard<std::mutex> lock(g_memberGroupInfoMapMutex);
218 auto it =Doxygen::memberGroupInfoMap.find(m_memberGroupId);
219 if (it!=Doxygen::memberGroupInfoMap.end())
220 {
221 auto &info = it->second;
222 info->doc = m_memberGroupDocs;
223 info->docFile = e->docFile;
224 info->docLine = e->docLine;
225 info->setRefItems(e->sli);
226 }
227 }
228 e->doc.clear();
229 e->brief.clear();
230 }
231}

References Entry::brief, QCString::clear, Entry::doc, Entry::docFile, Entry::docLine, end, g_memberGroupInfoMapMutex, QCString::isEmpty, m_memberGroupDocs, m_memberGroupId, Doxygen::memberGroupInfoMap, Entry::section, Entry::sli, stripLeadingAndTrailingEmptyLines and QCString::stripWhiteSpace.

appendHeader()​

void DocGroup::appendHeader (const char text)

Declaration at line 39 of file docgroup.h, definition at line 243 of file docgroup.cpp.

243void DocGroup::appendHeader(const char text)
244{
245 m_memberGroupHeader += text;
246}

Reference m_memberGroupHeader.

clearHeader()​

void DocGroup::clearHeader ()

Declaration at line 38 of file docgroup.h, definition at line 238 of file docgroup.cpp.

238void DocGroup::clearHeader()
239{
240 m_memberGroupHeader.clear();
241}

Reference m_memberGroupHeader.

close()​

void DocGroup::close (Entry * e, const QCString & fileName, int line, bool foundInline, bool implicit=false)

Declaration at line 35 of file docgroup.h, definition at line 141 of file docgroup.cpp.

141void DocGroup::close(Entry *e,const QCString &fileName,int line,bool foundInline,bool implicit)
142{
143 if (!implicit)
144 {
145 if (m_openCount < 1)
146 {
147 warn(fileName,line,"unbalanced grouping commands");
148 }
149 else
150 {
151 m_openCount--;
152 }
153 }
154 //printf("==> closeGroup(name=%s,sec=%x,file=%s,line=%d) m_autoGroupStack=%zu\n",
155 // qPrint(e->name),e->section,qPrint(fileName),line,m_autoGroupStack.size());
156 if (m_memberGroupId!=DOX_NOGROUP) // end of member group
157 {
158 {
159 std::lock_guard<std::mutex> lock(g_memberGroupInfoMapMutex);
160 auto it = Doxygen::memberGroupInfoMap.find(m_memberGroupId);
161 if (it!=Doxygen::memberGroupInfoMap.end()) // known group
162 {
163 auto &info = it->second;
164 info->doc = m_memberGroupDocs;
165 //info->docFile = fileName;
166 //info->docLine = line;
167 }
168 }
169 m_memberGroupId=DOX_NOGROUP;
170 m_memberGroupRelates.clear();
171 m_memberGroupDocs.clear();
172 if (!foundInline)
173 {
174 e->mGrpId=DOX_NOGROUP;
175 e->relates="";
176 }
177 //printf("new group id=%d\n",m_memberGroupId);
178 }
179 else if (!m_autoGroupStack.empty()) // end of auto group
180 {
181 Grouping grp = m_autoGroupStack.back();
182 m_autoGroupStack.pop_back();
183 // see bug577005: we should not remove the last group for e
184 if (!foundInline && !e->groups.empty()) e->groups.pop_back();
185 //printf("Removing %s e=%p\n",qPrint(grp->groupname),e);
186 if (!foundInline) initGroupInfo(e);
187 }
188}

References DOX_NOGROUP, end, g_memberGroupInfoMapMutex, Entry::groups, initGroupInfo, m_autoGroupStack, m_memberGroupDocs, m_memberGroupId, m_memberGroupRelates, m_openCount, Doxygen::memberGroupInfoMap, Entry::mGrpId, Entry::relates and warn.

enterCompound()​

void DocGroup::enterCompound (const QCString & fileName, int line, const QCString & name)

Declaration at line 32 of file docgroup.h, definition at line 55 of file docgroup.cpp.

55void DocGroup::enterCompound(const QCString &fileName,int line,const QCString &name)
56{
57 if (m_memberGroupId!=DOX_NOGROUP)
58 {
59 warn(fileName,line,"try to put compound {} inside a member group",name);
60 }
61 m_memberGroupId=DOX_NOGROUP;
62 m_memberGroupRelates.clear();
63 m_memberGroupDocs.clear();
64 m_compoundName = name;
65 int i = m_compoundName.find('(');
66 if (i!=-1)
67 {
68 m_compoundName=m_compoundName.left(i); // strip category (Obj-C)
69 }
70 if (m_compoundName.isEmpty())
71 {
72 m_compoundName=fileName;
73 }
74 //printf("groupEnterCompound(%s)\n",qPrint(name));
75}

References DOX_NOGROUP, m_compoundName, m_memberGroupDocs, m_memberGroupId, m_memberGroupRelates and warn.

enterFile()​

void DocGroup::enterFile (const QCString & fileName, int)

Declaration at line 30 of file docgroup.h, definition at line 26 of file docgroup.cpp.

26void DocGroup::enterFile(const QCString &fileName,int)
27{
28 m_openCount = 0;
29 m_autoGroupStack.clear();
30 m_memberGroupId = DOX_NOGROUP;
31 m_memberGroupDocs.clear();
32 m_memberGroupRelates.clear();
33 m_compoundName=fileName;
34}

References DOX_NOGROUP, m_autoGroupStack, m_compoundName, m_memberGroupDocs, m_memberGroupId, m_memberGroupRelates and m_openCount.

initGroupInfo()​

void DocGroup::initGroupInfo (Entry * e)

Declaration at line 36 of file docgroup.h, definition at line 190 of file docgroup.cpp.

190void DocGroup::initGroupInfo(Entry *e)
191{
192 //printf("==> initGroup(id=%d,related=%s,e=%p,#stack=%zu)\n",m_memberGroupId,
193 // qPrint(m_memberGroupRelates),(void*)e,m_autoGroupStack.size());
194 e->mGrpId = m_memberGroupId;
195 e->relates = m_memberGroupRelates;
196 if (!m_autoGroupStack.empty())
197 {
198 //printf("Appending group %s to %s: count=%zu entry=%p\n",
199 // qPrint(m_autoGroupStack.back().groupname),
200 // qPrint(e->name),e->groups.size(),(void*)e);
201 e->groups.emplace_back(m_autoGroupStack.back());
202 }
203}

References Entry::groups, m_autoGroupStack, m_memberGroupId, m_memberGroupRelates, Entry::mGrpId and Entry::relates.

Referenced by close.

isEmpty()​

bool DocGroup::isEmpty ()

Declaration at line 37 of file docgroup.h, definition at line 233 of file docgroup.cpp.

233bool DocGroup::isEmpty() const
234{
235 return (m_memberGroupId==DOX_NOGROUP);
236}

References DOX_NOGROUP and m_memberGroupId.

leaveCompound()​

void DocGroup::leaveCompound (const QCString &, int, const QCString &)

Declaration at line 33 of file docgroup.h, definition at line 77 of file docgroup.cpp.

77void DocGroup::leaveCompound(const QCString &,int,const QCString &/* name */)
78{
79 //printf("groupLeaveCompound(%s)\n",qPrint(name));
80 //if (m_memberGroupId!=DOX_NOGROUP)
81 //{
82 // warn(fileName,line,"end of compound {} while inside a member group\n",name);
83 //}
84 m_memberGroupId=DOX_NOGROUP;
85 m_memberGroupRelates.clear();
86 m_memberGroupDocs.clear();
87 m_compoundName.clear();
88}

References DOX_NOGROUP, m_compoundName, m_memberGroupDocs, m_memberGroupId and m_memberGroupRelates.

leaveFile()​

void DocGroup::leaveFile (const QCString & fileName, int line)

Declaration at line 31 of file docgroup.h, definition at line 36 of file docgroup.cpp.

36void DocGroup::leaveFile(const QCString &fileName,int line)
37{
38 //if (m_memberGroupId!=DOX_NOGROUP)
39 //{
40 // warn(fileName,line,"end of file while inside a member group");
41 //}
42 m_memberGroupId=DOX_NOGROUP;
43 m_memberGroupRelates.clear();
44 m_memberGroupDocs.clear();
45 if (!m_autoGroupStack.empty())
46 {
47 warn(fileName,line,"end of file while inside a group");
48 }
49 else if (m_openCount > 0) // < 0 is already handled on close call
50 {
51 warn(fileName,line,"end of file with unbalanced grouping commands");
52 }
53}

References DOX_NOGROUP, m_autoGroupStack, m_memberGroupDocs, m_memberGroupId, m_memberGroupRelates, m_openCount and warn.

open()​

void DocGroup::open (Entry * e, const QCString &, int, bool implicit=false)

Declaration at line 34 of file docgroup.h, definition at line 108 of file docgroup.cpp.

108void DocGroup::open(Entry *e,const QCString &,int, bool implicit)
109{
110 if (!implicit) m_openCount++;
111 //printf("==> openGroup(name=%s,sec=%x) m_autoGroupStack=%zu\n",
112 // qPrint(e->name),e->section,m_autoGroupStack.size());
113 if (e->section.isGroupDoc()) // auto group
114 {
115 m_autoGroupStack.emplace_back(e->name,e->groupingPri());
116 }
117 else // start of a member group
118 {
119 //printf(" membergroup id=%d %s\n",m_memberGroupId,qPrint(m_memberGroupHeader));
120 if (m_memberGroupId==DOX_NOGROUP) // no group started yet
121 {
122 auto info = std::make_unique<MemberGroupInfo>();
123 info->header = m_memberGroupHeader.stripWhiteSpace();
124 info->compoundName = m_compoundName;
125 m_memberGroupId = findExistingGroup(info.get());
126 {
127 std::lock_guard<std::mutex> lock(g_memberGroupInfoMapMutex);
128 auto it = Doxygen::memberGroupInfoMap.find(m_memberGroupId);
129 if (it==Doxygen::memberGroupInfoMap.end())
130 {
131 //printf(" use membergroup %d\n",m_memberGroupId);
132 Doxygen::memberGroupInfoMap.emplace(m_memberGroupId,std::move(info));
133 }
134 }
135 m_memberGroupRelates = e->relates;
136 e->mGrpId = m_memberGroupId;
137 }
138 }
139}

References DOX_NOGROUP, end, findExistingGroup, g_memberGroupInfoMapMutex, Entry::groupingPri, m_autoGroupStack, m_compoundName, m_memberGroupHeader, m_memberGroupId, m_memberGroupRelates, m_openCount, Doxygen::memberGroupInfoMap, Entry::mGrpId, Entry::name, Entry::relates and Entry::section.

Private Member Functions​

findExistingGroup()​

int DocGroup::findExistingGroup (const MemberGroupInfo * info)

Declaration at line 43 of file docgroup.h, definition at line 90 of file docgroup.cpp.

90int DocGroup::findExistingGroup(const MemberGroupInfo *info)
91{
92 std::lock_guard<std::mutex> lock(g_memberGroupInfoMapMutex);
93 //printf("findExistingGroup %s:%s\n",qPrint(info->header),qPrint(info->compoundName));
94 for (const auto &[groupId,groupInfo] : Doxygen::memberGroupInfoMap)
95 {
96 if (m_compoundName==groupInfo->compoundName && // same file or scope
97 !groupInfo->header.isEmpty() && // not a nameless group
98 qstricmp(groupInfo->header,info->header)==0 // same header name
99 )
100 {
101 //printf("Found it!\n");
102 return groupId; // put the item in this group
103 }
104 }
105 return ++g_groupId; // start new group
106}

References g_groupId, g_memberGroupInfoMapMutex, MemberGroupInfo::header, m_compoundName, Doxygen::memberGroupInfoMap and qstricmp.

Referenced by open.

Private Member Attributes​

m_autoGroupStack​

std::vector<Grouping> DocGroup::m_autoGroupStack

Definition at line 49 of file docgroup.h.

49 std::vector<Grouping> m_autoGroupStack;

Referenced by close, enterFile, initGroupInfo, leaveFile and open.

m_compoundName​

QCString DocGroup::m_compoundName

Definition at line 50 of file docgroup.h.

50 QCString m_compoundName;

Referenced by enterCompound, enterFile, findExistingGroup, leaveCompound and open.

m_memberGroupDocs​

QCString DocGroup::m_memberGroupDocs

Definition at line 48 of file docgroup.h.

48 QCString m_memberGroupDocs;

Referenced by addDocs, close, enterCompound, enterFile, leaveCompound and leaveFile.

m_memberGroupHeader​

QCString DocGroup::m_memberGroupHeader

Definition at line 45 of file docgroup.h.

45 QCString m_memberGroupHeader;

Referenced by appendHeader, clearHeader and open.

m_memberGroupId​

int DocGroup::m_memberGroupId = 0

Definition at line 46 of file docgroup.h.

46 int m_memberGroupId = 0;

Referenced by addDocs, close, enterCompound, enterFile, initGroupInfo, isEmpty, leaveCompound, leaveFile and open.

m_memberGroupRelates​

QCString DocGroup::m_memberGroupRelates

Definition at line 47 of file docgroup.h.

47 QCString m_memberGroupRelates;

Referenced by close, enterCompound, enterFile, initGroupInfo, leaveCompound, leaveFile and open.

m_openCount​

int DocGroup::m_openCount = 0

Definition at line 44 of file docgroup.h.

44 int m_openCount = 0;

Referenced by close, enterFile, leaveFile and open.

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

Generated via doxygen2docusaurus by Doxygen 1.14.0.