Doxygen
docgroup.h
浏览该文件的文档.
1 /******************************************************************************
2  *
3  * Copyright (C) 1997-2019 by Dimitri van Heesch.
4  *
5  * Permission to use, copy, modify, and distribute this software and its
6  * documentation under the terms of the GNU General Public License is hereby
7  * granted. No representations are made about the suitability of this software
8  * for any purpose. It is provided "as is" without express or implied warranty.
9  * See the GNU General Public License for more details.
10  *
11  * Documents produced by Doxygen are derivative works derived from the
12  * input used in their production; they are not affected by this license.
13  *
14  */
15 
16 #ifndef DOCGROUP_H
17 #define DOCGROUP_H
18 
19 #include <vector>
20 #include "membergroup.h"
21 
22 class Entry;
23 
24 class DocGroup
25 {
26  public:
27  DocGroup() {};
28 
29  public:
30  void enterFile(const QCString &fileName,int);
31  void leaveFile(const QCString &fileName,int line);
32  void enterCompound(const QCString &fileName,int line,const QCString &name);
33  void leaveCompound(const QCString &,int,const QCString & /*name*/);
34  void open(Entry *e,const QCString &,int,bool implicit=false);
35  void close(Entry *e,const QCString &fileName,int line,bool foundInline,bool implicit=false);
36  void initGroupInfo(Entry *e);
37  bool isEmpty() const;
38  void clearHeader();
39  void appendHeader(const char);
40  void addDocs(Entry *e);
41 
42  private:
43  int findExistingGroup(const MemberGroupInfo *info);
44  int m_openCount = 0;
46  int m_memberGroupId = 0;
49  std::vector<Grouping> m_autoGroupStack;
51 };
52 
53 #endif
DocGroup::m_memberGroupRelates
QCString m_memberGroupRelates
Definition: docgroup.h:47
DocGroup::isEmpty
bool isEmpty() const
Definition: docgroup.cpp:218
membergroup.h
DocGroup::enterFile
void enterFile(const QCString &fileName, int)
Definition: docgroup.cpp:25
DocGroup
Definition: docgroup.h:24
DocGroup::m_compoundName
QCString m_compoundName
Definition: docgroup.h:50
DocGroup::leaveCompound
void leaveCompound(const QCString &, int, const QCString &)
Definition: docgroup.cpp:76
DocGroup::clearHeader
void clearHeader()
Definition: docgroup.cpp:223
DocGroup::m_memberGroupDocs
QCString m_memberGroupDocs
Definition: docgroup.h:48
DocGroup::m_memberGroupHeader
QCString m_memberGroupHeader
Definition: docgroup.h:45
DocGroup::open
void open(Entry *e, const QCString &, int, bool implicit=false)
Definition: docgroup.cpp:106
DocGroup::DocGroup
DocGroup()
Definition: docgroup.h:27
DocGroup::appendHeader
void appendHeader(const char)
Definition: docgroup.cpp:228
DocGroup::initGroupInfo
void initGroupInfo(Entry *e)
Definition: docgroup.cpp:178
MemberGroupInfo
Data collected for a member group
Definition: membergroup.h:114
DocGroup::leaveFile
void leaveFile(const QCString &fileName, int line)
Definition: docgroup.cpp:35
DocGroup::addDocs
void addDocs(Entry *e)
Definition: docgroup.cpp:193
Entry
Represents an unstructured piece of information, about an entity found in the sources.
Definition: entry.h:61
DocGroup::enterCompound
void enterCompound(const QCString &fileName, int line, const QCString &name)
Definition: docgroup.cpp:54
DocGroup::m_memberGroupId
int m_memberGroupId
Definition: docgroup.h:46
DocGroup::m_openCount
int m_openCount
Definition: docgroup.h:44
DocGroup::findExistingGroup
int findExistingGroup(const MemberGroupInfo *info)
Definition: docgroup.cpp:89
DocGroup::close
void close(Entry *e, const QCString &fileName, int line, bool foundInline, bool implicit=false)
Definition: docgroup.cpp:136
DocGroup::m_autoGroupStack
std::vector< Grouping > m_autoGroupStack
Definition: docgroup.h:49
QCString
This is an alternative implementation of QCString.
Definition: qcstring.h:108