Doxygen
Entry类 参考

Represents an unstructured piece of information, about an entity found in the sources. 更多...

#include <entry.h>

+ Entry 的协作图:

Public 类型

enum  Sections {
  CLASS_SEC = 0x00000001, NAMESPACE_SEC = 0x00000010, CONCEPT_SEC = 0x00000020, COMPOUND_MASK = CLASS_SEC,
  SCOPE_MASK = COMPOUND_MASK | NAMESPACE_SEC, CLASSDOC_SEC = 0x00000800, STRUCTDOC_SEC = 0x00001000, UNIONDOC_SEC = 0x00002000,
  EXCEPTIONDOC_SEC = 0x00004000, NAMESPACEDOC_SEC = 0x00008000, INTERFACEDOC_SEC = 0x00010000, PROTOCOLDOC_SEC = 0x00020000,
  CATEGORYDOC_SEC = 0x00040000, SERVICEDOC_SEC = 0x00080000, SINGLETONDOC_SEC = 0x00100000, CONCEPTDOC_SEC = 0x00200000,
  COMPOUNDDOC_MASK, SOURCE_SEC = 0x00400000, HEADER_SEC = 0x00800000, FILE_MASK = SOURCE_SEC | HEADER_SEC,
  ENUMDOC_SEC = 0x01000000, ENUM_SEC = 0x02000000, EMPTY_SEC = 0x03000000, PAGEDOC_SEC = 0x04000000,
  VARIABLE_SEC = 0x05000000, FUNCTION_SEC = 0x06000000, TYPEDEF_SEC = 0x07000000, MEMBERDOC_SEC = 0x08000000,
  OVERLOADDOC_SEC = 0x09000000, EXAMPLE_SEC = 0x0a000000, VARIABLEDOC_SEC = 0x0b000000, FILEDOC_SEC = 0x0c000000,
  DEFINEDOC_SEC = 0x0d000000, INCLUDE_SEC = 0x0e000000, DEFINE_SEC = 0x0f000000, GROUPDOC_SEC = 0x10000000,
  USINGDIR_SEC = 0x11000000, MAINPAGEDOC_SEC = 0x12000000, MEMBERGRP_SEC = 0x13000000, USINGDECL_SEC = 0x14000000,
  PACKAGE_SEC = 0x15000000, PACKAGEDOC_SEC = 0x16000000, OBJCIMPL_SEC = 0x17000000, DIRDOC_SEC = 0x18000000,
  EXPORTED_INTERFACE_SEC = 0x19000000, INCLUDED_SERVICE_SEC = 0x1A000000, EXAMPLE_LINENO_SEC = 0x1B000000
}
 
enum  GroupDocType { GROUPDOC_NORMAL, GROUPDOC_ADD, GROUPDOC_WEAK }
 

Public 成员函数

 Entry ()
 
 Entry (const Entry &)
 
 ~Entry ()
 
Entryparent () const
 
const std::vector< std::shared_ptr< Entry > > & children () const
 
add entry as a child and pass ownership.
注解
This makes the entry passed invalid!
void moveToSubEntryAndKeep (Entry *e)
 
void moveToSubEntryAndKeep (std::shared_ptr< Entry > e)
 

静态 Public 属性

static const uint64 Template = (1ULL<<0)
 
static const uint64 Generic = (1ULL<<1)
 
static const uint64 Ref = (1ULL<<2)
 
static const uint64 Value = (1ULL<<3)
 
static const uint64 Interface = (1ULL<<4)
 
static const uint64 Struct = (1ULL<<5)
 
static const uint64 Union = (1ULL<<6)
 
static const uint64 Exception = (1ULL<<7)
 
static const uint64 Protocol = (1ULL<<8)
 
static const uint64 Category = (1ULL<<9)
 
static const uint64 SealedClass = (1ULL<<10)
 
static const uint64 AbstractClass = (1ULL<<11)
 
static const uint64 Enum = (1ULL<<12)
 
static const uint64 Service = (1ULL<<13)
 
static const uint64 Singleton = (1ULL<<14)
 
static const uint64 ForwardDecl = (1ULL<<15)
 
static const uint64 Local = (1ULL<<16)
 
static const uint64 EnumStruct = (1ULL<<18)
 
static const uint64 ConstExpr = (1ULL<<19)
 
static const uint64 PrivateGettable = (1ULL<<20)
 
static const uint64 ProtectedGettable = (1ULL<<21)
 
static const uint64 PrivateSettable = (1ULL<<22)
 
static const uint64 ProtectedSettable = (1ULL<<23)
 
static const uint64 Inline = (1ULL<<24)
 
static const uint64 Explicit = (1ULL<<25)
 
static const uint64 Mutable = (1ULL<<26)
 
static const uint64 Settable = (1ULL<<27)
 
static const uint64 Gettable = (1ULL<<28)
 
static const uint64 Readable = (1ULL<<29)
 
static const uint64 Writable = (1ULL<<30)
 
static const uint64 Final = (1ULL<<31)
 
static const uint64 Abstract = (1ULL<<32)
 
static const uint64 Addable = (1ULL<<33)
 
static const uint64 Removable = (1ULL<<34)
 
static const uint64 Raisable = (1ULL<<35)
 
static const uint64 Override = (1ULL<<36)
 
static const uint64 New = (1ULL<<37)
 
static const uint64 Sealed = (1ULL<<38)
 
static const uint64 Initonly = (1ULL<<39)
 
static const uint64 Optional = (1ULL<<40)
 
static const uint64 Required = (1ULL<<41)
 
static const uint64 NonAtomic = (1ULL<<42)
 
static const uint64 Copy = (1ULL<<43)
 
static const uint64 Retain = (1ULL<<44)
 
static const uint64 Assign = (1ULL<<45)
 
static const uint64 Strong = (1ULL<<46)
 
static const uint64 Weak = (1ULL<<47)
 
static const uint64 Unretained = (1ULL<<48)
 
static const uint64 Alias = (1ULL<<49)
 
static const uint64 ConstExp = (1ULL<<50)
 
static const uint64 Default = (1ULL<<51)
 
static const uint64 Delete = (1ULL<<52)
 
static const uint64 NoExcept = (1ULL<<53)
 
static const uint64 Attribute = (1ULL<<54)
 
static const uint64 Property = (1ULL<<55)
 
static const uint64 Readonly = (1ULL<<56)
 
static const uint64 Bound = (1ULL<<57)
 
static const uint64 Constrained = (1ULL<<58)
 
static const uint64 Transient = (1ULL<<59)
 
static const uint64 MaybeVoid = (1ULL<<60)
 
static const uint64 MaybeDefault = (1ULL<<61)
 
static const uint64 MaybeAmbiguous = (1ULL<<62)
 
static const uint64 Published = (1ULL<<63)
 

add entry as a child, pass ownership and reinitialize entry

int section
 entry type (see Sections); 更多...
 
QCString type
 member type 更多...
 
QCString name
 member name 更多...
 
bool hasTagInfo
 is tag info valid 更多...
 
TagInfo tagInfoData
 tag file info data 更多...
 
Protection protection
 class protection 更多...
 
MethodTypes mtype
 signal, slot, (dcop) method, or property? 更多...
 
uint64 spec
 class/member specifiers 更多...
 
int initLines
 define/variable initializer lines to show 更多...
 
bool stat
 static ? 更多...
 
bool explicitExternal
 explicitly defined as external? 更多...
 
bool proto
 prototype ? 更多...
 
bool subGrouping
 automatically group class members? 更多...
 
bool callGraph
 do we need to draw the call graph? 更多...
 
bool callerGraph
 do we need to draw the caller graph? 更多...
 
bool referencedByRelation
 do we need to show the referenced by relation? 更多...
 
bool referencesRelation
 do we need to show the references relation? 更多...
 
Specifier virt
 virtualness of the entry 更多...
 
QCString args
 member argument string 更多...
 
QCString bitfields
 member's bit fields 更多...
 
ArgumentList argList
 member arguments as a list 更多...
 
ArgumentLists tArgLists
 template argument declarations 更多...
 
TextStream program
 the program text 更多...
 
TextStream initializer
 initial value (for variables) 更多...
 
QCString includeFile
 include file (2 arg of \class, must be unique) 更多...
 
QCString includeName
 include name (3 arg of \class) 更多...
 
QCString doc
 documentation block (partly parsed) 更多...
 
int docLine
 line number at which the documentation was found 更多...
 
QCString docFile
 file in which the documentation was found 更多...
 
QCString brief
 brief description (doc block) 更多...
 
int briefLine
 line number at which the brief desc. was found 更多...
 
QCString briefFile
 file in which the brief desc. was found 更多...
 
QCString inbodyDocs
 documentation inside the body of a function 更多...
 
int inbodyLine
 line number at which the body doc was found 更多...
 
QCString inbodyFile
 file in which the body doc was found 更多...
 
QCString relates
 related class (doc block) 更多...
 
RelatesType relatesType
 how relates is handled 更多...
 
QCString read
 property read accessor 更多...
 
QCString write
 property write accessor 更多...
 
QCString inside
 name of the class in which documents are found 更多...
 
QCString exception
 throw specification 更多...
 
ArgumentList typeConstr
 where clause (C#) for type constraints 更多...
 
int bodyLine
 line number of the body in the source 更多...
 
int bodyColumn
 column of the body in the source 更多...
 
int endBodyLine
 line number where the definition ends 更多...
 
int mGrpId
 member group id 更多...
 
std::vector< BaseInfoextends
 list of base classes 更多...
 
std::vector< Groupinggroups
 list of groups this entry belongs to 更多...
 
std::vector< const SectionInfo * > anchors
 list of anchors defined in this entry 更多...
 
QCString fileName
 file this entry was extracted from 更多...
 
int startLine
 start line of entry in the source 更多...
 
int startColumn
 start column of entry in the source 更多...
 
RefItemVector sli
 special lists (test/todo/bug/deprecated/..) this entry is in 更多...
 
SrcLangExt lang
 programming language in which this entry was found 更多...
 
bool hidden
 does this represent an entity that is hidden from the output 更多...
 
bool artificial
 Artificially introduced item 更多...
 
GroupDocType groupDocType
 
QCString id
 libclang id 更多...
 
LocalToc localToc
 
QCString metaData
 Slice metadata 更多...
 
QCString req
 C++20 requires clause 更多...
 
Entrym_parent
 parent node in the tree 更多...
 
std::vector< std::shared_ptr< Entry > > m_sublist
 
FileDefm_fileDef
 
void moveToSubEntryAndRefresh (Entry *&e)
 
void moveToSubEntryAndRefresh (std::shared_ptr< Entry > &e)
 
void copyToSubEntry (Entry *e)
 
void copyToSubEntry (const std::shared_ptr< Entry > &e)
 
void removeSubEntry (const Entry *e)
 
void reset ()
 
void markAsProcessed () const
 
void setFileDef (FileDef *fd)
 
FileDeffileDef () const
 
const TagInfotagInfo () const
 
const char * groupDocCmd () const
 return the command name used to define GROUPDOC_SEC 更多...
 
Grouping::GroupPri_t groupingPri () const
 
Entryoperator= (const Entry &)
 

详细描述

Represents an unstructured piece of information, about an entity found in the sources.

parseMain() in scanner.l will generate a tree of these entries.

在文件 entry.h61 行定义.

成员枚举类型说明

◆ GroupDocType

枚举值
GROUPDOC_NORMAL 

defgroup

GROUPDOC_ADD 

addtogroup

GROUPDOC_WEAK 

weakgroup

在文件 entry.h188 行定义.

189  {
190  GROUPDOC_NORMAL, //!< defgroup
191  GROUPDOC_ADD, //!< addtogroup
192  GROUPDOC_WEAK //!< weakgroup
193  }; //!< kind of group

◆ Sections

Kind of entries that are supported

枚举值
CLASS_SEC 
NAMESPACE_SEC 
CONCEPT_SEC 
COMPOUND_MASK 
SCOPE_MASK 
CLASSDOC_SEC 
STRUCTDOC_SEC 
UNIONDOC_SEC 
EXCEPTIONDOC_SEC 
NAMESPACEDOC_SEC 
INTERFACEDOC_SEC 
PROTOCOLDOC_SEC 
CATEGORYDOC_SEC 
SERVICEDOC_SEC 
SINGLETONDOC_SEC 
CONCEPTDOC_SEC 
COMPOUNDDOC_MASK 
SOURCE_SEC 
HEADER_SEC 
FILE_MASK 
ENUMDOC_SEC 
ENUM_SEC 
EMPTY_SEC 
PAGEDOC_SEC 
VARIABLE_SEC 
FUNCTION_SEC 
TYPEDEF_SEC 
MEMBERDOC_SEC 
OVERLOADDOC_SEC 
EXAMPLE_SEC 
VARIABLEDOC_SEC 
FILEDOC_SEC 
DEFINEDOC_SEC 
INCLUDE_SEC 
DEFINE_SEC 
GROUPDOC_SEC 
USINGDIR_SEC 
MAINPAGEDOC_SEC 
MEMBERGRP_SEC 
USINGDECL_SEC 
PACKAGE_SEC 
PACKAGEDOC_SEC 
OBJCIMPL_SEC 
DIRDOC_SEC 
EXPORTED_INTERFACE_SEC 
INCLUDED_SERVICE_SEC 
EXAMPLE_LINENO_SEC 

在文件 entry.h66 行定义.

66  {
67  CLASS_SEC = 0x00000001,
68  NAMESPACE_SEC = 0x00000010,
69  CONCEPT_SEC = 0x00000020,
72 
73  CLASSDOC_SEC = 0x00000800,
74  STRUCTDOC_SEC = 0x00001000,
75  UNIONDOC_SEC = 0x00002000,
76  EXCEPTIONDOC_SEC = 0x00004000,
77  NAMESPACEDOC_SEC = 0x00008000,
78  INTERFACEDOC_SEC = 0x00010000,
79  PROTOCOLDOC_SEC = 0x00020000,
80  CATEGORYDOC_SEC = 0x00040000,
81  SERVICEDOC_SEC = 0x00080000,
82  SINGLETONDOC_SEC = 0x00100000,
83  CONCEPTDOC_SEC = 0x00200000,
87 
88  SOURCE_SEC = 0x00400000,
89  HEADER_SEC = 0x00800000,
91 
92  ENUMDOC_SEC = 0x01000000,
93  ENUM_SEC = 0x02000000,
94  EMPTY_SEC = 0x03000000,
95  PAGEDOC_SEC = 0x04000000,
96  VARIABLE_SEC = 0x05000000,
97  FUNCTION_SEC = 0x06000000,
98  TYPEDEF_SEC = 0x07000000,
99  MEMBERDOC_SEC = 0x08000000,
100  OVERLOADDOC_SEC = 0x09000000,
101  EXAMPLE_SEC = 0x0a000000,
102  VARIABLEDOC_SEC = 0x0b000000,
103  FILEDOC_SEC = 0x0c000000,
104  DEFINEDOC_SEC = 0x0d000000,
105  INCLUDE_SEC = 0x0e000000,
106  DEFINE_SEC = 0x0f000000,
107  GROUPDOC_SEC = 0x10000000,
108  USINGDIR_SEC = 0x11000000,
109  MAINPAGEDOC_SEC = 0x12000000,
110  MEMBERGRP_SEC = 0x13000000,
111  USINGDECL_SEC = 0x14000000,
112  PACKAGE_SEC = 0x15000000,
113  PACKAGEDOC_SEC = 0x16000000,
114  OBJCIMPL_SEC = 0x17000000,
115  DIRDOC_SEC = 0x18000000,
116  EXPORTED_INTERFACE_SEC = 0x19000000,
117  INCLUDED_SERVICE_SEC = 0x1A000000,
118  EXAMPLE_LINENO_SEC = 0x1B000000,
119  };

构造及析构函数说明

◆ Entry() [1/2]

Entry::Entry ( )

在文件 entry.cpp33 行定义.

34 {
35  //printf("Entry::Entry(%p)\n",this);
36  g_num++;
37  m_parent=0;
39  //printf("Entry::Entry() tArgList=0\n");
40  mGrpId = -1;
41  hasTagInfo = FALSE;
43  hidden = FALSE;
45  reset();
46 }

引用了 EMPTY_SEC, FALSE, g_num, GROUPDOC_NORMAL, groupDocType, hasTagInfo, hidden, m_parent, mGrpId, relatesType, reset(), section , 以及 Simple.

被这些函数引用 copyToSubEntry() , 以及 moveToSubEntryAndRefresh().

◆ Entry() [2/2]

Entry::Entry ( const Entry e)

在文件 entry.cpp48 行定义.

49 {
50  //printf("Entry::Entry(%p):copy\n",this);
51  g_num++;
52  section = e.section;
53  type = e.type;
54  name = e.name;
58  mtype = e.mtype;
59  spec = e.spec;
60  initLines = e.initLines;
61  stat = e.stat;
62  localToc = e.localToc;
64  proto = e.proto;
66  callGraph = e.callGraph;
70  virt = e.virt;
71  args = e.args;
72  bitfields = e.bitfields;
73  argList = e.argList;
74  tArgLists = e.tArgLists;
75  program.str(e.program.str());
79  doc = e.doc;
80  docLine = e.docLine;
81  docFile = e.docFile;
82  brief = e.brief;
83  briefLine = e.briefLine;
84  briefFile = e.briefFile;
88  relates = e.relates;
90  read = e.read;
91  write = e.write;
92  inside = e.inside;
93  exception = e.exception;
95  bodyLine = e.bodyLine;
98  mGrpId = e.mGrpId;
99  anchors = e.anchors;
100  fileName = e.fileName;
101  startLine = e.startLine;
103  sli = e.sli;
104  lang = e.lang;
105  hidden = e.hidden;
108  id = e.id;
109  extends = e.extends;
110  groups = e.groups;
111  req = e.req;
112  m_fileDef = e.m_fileDef;
113 
114  m_parent = e.m_parent;
115  // deep copy child entries
116  m_sublist.reserve(e.m_sublist.size());
117  for (const auto &cur : e.m_sublist)
118  {
119  m_sublist.push_back(std::make_shared<Entry>(*cur));
120  }
121 }

引用了 anchors, argList, args, artificial, bitfields, bodyColumn, bodyLine, brief, briefFile, briefLine, callerGraph, callGraph, doc, docFile, docLine, endBodyLine, exception, explicitExternal, extends, fileName, g_num, groupDocType, groups, hasTagInfo, hidden, id, inbodyDocs, inbodyFile, inbodyLine, includeFile, includeName, initializer, initLines, inside, lang, localToc, m_fileDef, m_parent, m_sublist, mGrpId, mtype, name, program, protection, proto, read, referencedByRelation, referencesRelation, relates, relatesType, req, section, sli, spec, startColumn, startLine, stat, TextStream::str(), subGrouping, tagInfoData, tArgLists, type, typeConstr, virt , 以及 write.

◆ ~Entry()

Entry::~Entry ( )

在文件 entry.cpp123 行定义.

124 {
125  //printf("Entry::~Entry(%p) num=%d\n",this,g_num);
126  //printf("Deleting entry %d name %s type %x children %d\n",
127  // num,qPrint(name),section,sublist->count());
128 
129  g_num--;
130 }

引用了 g_num.

成员函数说明

◆ children()

◆ copyToSubEntry() [1/2]

void Entry::copyToSubEntry ( const std::shared_ptr< Entry > &  e)

在文件 entry.cpp165 行定义.

166 {
167  std::shared_ptr<Entry> copy = std::make_shared<Entry>(*current);
168  copy->m_parent=this;
169  m_sublist.push_back(copy);
170 }

引用了 m_sublist.

◆ copyToSubEntry() [2/2]

void Entry::copyToSubEntry ( Entry e)

make a copy of e and add it as a child to this entry

在文件 entry.cpp158 行定义.

159 {
160  Entry *copy = new Entry(*current);
161  copy->m_parent=this;
162  m_sublist.emplace_back(copy);
163 }

引用了 Entry(), m_parent , 以及 m_sublist.

被这些函数引用 VHDLOutlineParser::mapLibPackage().

◆ fileDef()

◆ groupDocCmd()

const char* Entry::groupDocCmd ( ) const
inline

return the command name used to define GROUPDOC_SEC

在文件 entry.h304 行定义.

305  {
306  switch( groupDocType )
307  {
308  case GROUPDOC_NORMAL: return "\\defgroup";
309  case GROUPDOC_ADD: return "\\addtogroup";
310  case GROUPDOC_WEAK: return "\\weakgroup";
311  default: return "unknown group command";
312  }
313  }

引用了 GROUPDOC_ADD, GROUPDOC_NORMAL, GROUPDOC_WEAK , 以及 groupDocType.

◆ groupingPri()

Grouping::GroupPri_t Entry::groupingPri ( ) const
inline

在文件 entry.h314 行定义.

315  {
316  if( section != GROUPDOC_SEC )
317  {
319  }
320  switch( groupDocType )
321  {
325  default: return Grouping::GROUPING_LOWEST;
326  }
327  }

引用了 GROUPDOC_ADD, GROUPDOC_NORMAL, GROUPDOC_SEC, GROUPDOC_WEAK, groupDocType, Grouping::GROUPING_AUTO_ADD, Grouping::GROUPING_AUTO_DEF, Grouping::GROUPING_AUTO_WEAK, Grouping::GROUPING_LOWEST , 以及 section.

被这些函数引用 DocGroup::open().

◆ markAsProcessed()

void Entry::markAsProcessed ( ) const
inline

在文件 entry.h233 行定义.

233 { ((Entry*)(this))->section = Entry::EMPTY_SEC; }

引用了 EMPTY_SEC , 以及 section.

被这些函数引用 addVariableToClass() , 以及 addVariableToFile().

◆ moveToSubEntryAndKeep() [1/2]

void Entry::moveToSubEntryAndKeep ( Entry e)

在文件 entry.cpp146 行定义.

147 {
148  current->m_parent=this;
149  m_sublist.emplace_back(current);
150 }

引用了 m_parent , 以及 m_sublist.

被这些函数引用 initUCF().

◆ moveToSubEntryAndKeep() [2/2]

void Entry::moveToSubEntryAndKeep ( std::shared_ptr< Entry e)

在文件 entry.cpp152 行定义.

153 {
154  current->m_parent=this;
155  m_sublist.push_back(current);
156 }

引用了 m_sublist.

◆ moveToSubEntryAndRefresh() [1/2]

void Entry::moveToSubEntryAndRefresh ( Entry *&  e)

在文件 entry.cpp132 行定义.

133 {
134  current->m_parent=this;
135  m_sublist.emplace_back(current);
136  current = new Entry;
137 }

引用了 Entry(), m_parent , 以及 m_sublist.

◆ moveToSubEntryAndRefresh() [2/2]

void Entry::moveToSubEntryAndRefresh ( std::shared_ptr< Entry > &  e)

在文件 entry.cpp139 行定义.

140 {
141  current->m_parent=this;
142  m_sublist.push_back(current);
143  current = std::make_shared<Entry>();
144 }

引用了 m_sublist.

◆ operator=()

Entry& Entry::operator= ( const Entry )
private

◆ parent()

◆ removeSubEntry()

void Entry::removeSubEntry ( const Entry e)

Removes entry e from the list of children. The entry will be deleted if found.

在文件 entry.cpp172 行定义.

173 {
174  auto it = std::find_if(m_sublist.begin(),m_sublist.end(),
175  [e](const std::shared_ptr<Entry>&elem) { return elem.get()==e; });
176  if (it!=m_sublist.end())
177  {
178  m_sublist.erase(it);
179  }
180 }

引用了 m_sublist.

◆ reset()

void Entry::reset ( )

Restore the state of this Entry to the default value it has at construction time.

在文件 entry.cpp183 行定义.

184 {
185  bool entryCallGraph = Config_getBool(CALL_GRAPH);
186  bool entryCallerGraph = Config_getBool(CALLER_GRAPH);
187  bool entryReferencedByRelation = Config_getBool(REFERENCED_BY_RELATION);
188  bool entryReferencesRelation = Config_getBool(REFERENCES_RELATION);
189  //printf("Entry::reset()\n");
190  name.resize(0);
191  type.resize(0);
192  args.resize(0);
193  bitfields.resize(0);
194  exception.resize(0);
195  program.str(std::string());
196  includeFile.resize(0);
197  includeName.resize(0);
198  doc.resize(0);
199  docFile.resize(0);
200  docLine=-1;
201  relates.resize(0);
203  brief.resize(0);
204  briefFile.resize(0);
205  briefLine=-1;
206  inbodyDocs.resize(0);
207  inbodyFile.resize(0);
208  inbodyLine=-1;
209  inside.resize(0);
210  fileName.resize(0);
211  initializer.str(std::string());
212  initLines = -1;
213  startLine = 1;
214  startColumn = 1;
215  bodyLine = -1;
216  bodyColumn = 1;
217  endBodyLine = -1;
218  mGrpId = -1;
219  callGraph = entryCallGraph;
220  callerGraph = entryCallerGraph;
221  referencedByRelation = entryReferencedByRelation;
222  referencesRelation = entryReferencesRelation;
223  section = EMPTY_SEC;
224  mtype = Method;
225  virt = Normal;
226  stat = FALSE;
227  proto = FALSE;
229  spec = 0;
231  hidden = FALSE;
232  artificial = FALSE;
233  subGrouping = TRUE;
234  protection = Public;
236  id.resize(0);
237  metaData.resize(0);
238  m_sublist.clear();
239  extends.clear();
240  groups.clear();
241  anchors.clear();
242  argList.reset();
243  tArgLists.clear();
244  typeConstr.reset();
245  sli.clear();
246  req.resize(0);
247  m_fileDef = 0;
248 }

引用了 anchors, argList, args, artificial, bitfields, bodyColumn, bodyLine, brief, briefFile, briefLine, callerGraph, callGraph, Config_getBool, doc, docFile, docLine, EMPTY_SEC, endBodyLine, exception, explicitExternal, extends, FALSE, fileName, GROUPDOC_NORMAL, groupDocType, groups, hidden, inbodyDocs, inbodyFile, inbodyLine, includeFile, includeName, initializer, initLines, inside, lang, m_fileDef, m_sublist, metaData, Method, mGrpId, mtype, name, Normal, program, protection, proto, Public, referencedByRelation, referencesRelation, relates, relatesType, req, ArgumentList::reset(), QCString::resize(), section, Simple, sli, spec, SrcLangExt_Unknown, startColumn, startLine, stat, TextStream::str(), subGrouping, tArgLists, TRUE, type, typeConstr , 以及 virt.

被这些函数引用 Entry().

◆ setFileDef()

void Entry::setFileDef ( FileDef fd)

在文件 entry.cpp250 行定义.

251 {
252  m_fileDef = fd;
253  for (const auto &childNode : m_sublist)
254  {
255  childNode->setFileDef(fd);
256  }
257 }

引用了 m_fileDef , 以及 m_sublist.

◆ tagInfo()

类成员变量说明

◆ Abstract

const uint64 Entry::Abstract = (1ULL<<32)
static

在文件 entry.h155 行定义.

被这些函数引用 MemberDefImpl::isAbstract() , 以及 ClassDefImpl::isAbstract().

◆ AbstractClass

const uint64 Entry::AbstractClass = (1ULL<<11)
static

在文件 entry.h133 行定义.

◆ Addable

const uint64 Entry::Addable = (1ULL<<33)
static

在文件 entry.h156 行定义.

被这些函数引用 MemberDefImpl::isAddable().

◆ Alias

const uint64 Entry::Alias = (1ULL<<49)
static

在文件 entry.h172 行定义.

被这些函数引用 addVariableToClass(), addVariableToFile() , 以及 MemberDefImpl::isTypeAlias().

◆ anchors

◆ argList

◆ args

◆ artificial

bool Entry::artificial

Artificially introduced item

在文件 entry.h296 行定义.

被这些函数引用 addClassToContext(), addVariableToClass(), buildNamespaceList(), Entry() , 以及 reset().

◆ Assign

const uint64 Entry::Assign = (1ULL<<45)
static

在文件 entry.h168 行定义.

被这些函数引用 MemberDefImpl::isAssign().

◆ Attribute

const uint64 Entry::Attribute = (1ULL<<54)
static

在文件 entry.h177 行定义.

被这些函数引用 MemberDefImpl::isAttribute().

◆ bitfields

QCString Entry::bitfields

member's bit fields

在文件 entry.h260 行定义.

被这些函数引用 addVariableToClass(), Entry() , 以及 reset().

◆ bodyColumn

int Entry::bodyColumn

column of the body in the source

在文件 entry.h284 行定义.

被这些函数引用 Entry() , 以及 reset().

◆ bodyLine

◆ Bound

const uint64 Entry::Bound = (1ULL<<57)
static

在文件 entry.h180 行定义.

被这些函数引用 MemberDefImpl::isBound().

◆ brief

◆ briefFile

◆ briefLine

◆ callerGraph

bool Entry::callerGraph

◆ callGraph

bool Entry::callGraph

◆ Category

const uint64 Entry::Category = (1ULL<<9)
static

在文件 entry.h131 行定义.

被这些函数引用 TagFileParser::buildLists() , 以及 convertToCompoundType().

◆ ConstExp

const uint64 Entry::ConstExp = (1ULL<<50)
static

在文件 entry.h173 行定义.

◆ ConstExpr

const uint64 Entry::ConstExpr = (1ULL<<19)
static

在文件 entry.h142 行定义.

被这些函数引用 MemberDefImpl::isConstExpr().

◆ Constrained

const uint64 Entry::Constrained = (1ULL<<58)
static

在文件 entry.h181 行定义.

被这些函数引用 MemberDefImpl::isConstrained().

◆ Copy

const uint64 Entry::Copy = (1ULL<<43)
static

在文件 entry.h166 行定义.

被这些函数引用 MemberDefImpl::isCopy().

◆ Default

const uint64 Entry::Default = (1ULL<<51)
static

在文件 entry.h174 行定义.

被这些函数引用 MemberDefImpl::isDefault().

◆ Delete

const uint64 Entry::Delete = (1ULL<<52)
static

在文件 entry.h175 行定义.

被这些函数引用 MemberDefImpl::isDelete().

◆ doc

◆ docFile

◆ docLine

◆ endBodyLine

◆ Enum

const uint64 Entry::Enum = (1ULL<<12)
static

在文件 entry.h134 行定义.

被这些函数引用 addClassToContext() , 以及 TagFileParser::buildLists().

◆ EnumStruct

const uint64 Entry::EnumStruct = (1ULL<<18)
static

在文件 entry.h141 行定义.

被这些函数引用 MemberDefImpl::isEnumStruct().

◆ Exception

const uint64 Entry::Exception = (1ULL<<7)
static

◆ exception

QCString Entry::exception

throw specification

在文件 entry.h281 行定义.

被这些函数引用 addVariableToClass(), Entry(), filterMemberDocumentation() , 以及 reset().

◆ Explicit

const uint64 Entry::Explicit = (1ULL<<25)
static

在文件 entry.h148 行定义.

被这些函数引用 findMember() , 以及 MemberDefImpl::isExplicit().

◆ explicitExternal

bool Entry::explicitExternal

explicitly defined as external?

在文件 entry.h251 行定义.

被这些函数引用 addEnumValuesToEnums(), addVariableToFile(), Entry() , 以及 reset().

◆ extends

std::vector<BaseInfo> Entry::extends

list of base classes

在文件 entry.h287 行定义.

被这些函数引用 computePageRelations(), computeTemplateClassRelations(), Entry(), findBaseClassesForClass(), isClassSection() , 以及 reset().

◆ fileName

◆ Final

const uint64 Entry::Final = (1ULL<<31)
static

在文件 entry.h154 行定义.

被这些函数引用 MemberDefImpl::isFinal() , 以及 ClassDefImpl::isFinal().

◆ ForwardDecl

const uint64 Entry::ForwardDecl = (1ULL<<15)
static

在文件 entry.h137 行定义.

被这些函数引用 addClassToContext() , 以及 ClassDefImpl::isForwardDeclared().

◆ Generic

const uint64 Entry::Generic = (1ULL<<1)
static

在文件 entry.h123 行定义.

◆ Gettable

const uint64 Entry::Gettable = (1ULL<<28)
static

在文件 entry.h151 行定义.

被这些函数引用 MemberDefImpl::isGettable().

◆ groupDocType

GroupDocType Entry::groupDocType

在文件 entry.h297 行定义.

被这些函数引用 buildGroupListFiltered(), Entry(), groupDocCmd(), groupingPri(), organizeSubGroupsFiltered() , 以及 reset().

◆ groups

◆ hasTagInfo

bool Entry::hasTagInfo

is tag info valid

在文件 entry.h241 行定义.

被这些函数引用 Entry() , 以及 tagInfo().

◆ hidden

bool Entry::hidden

does this represent an entity that is hidden from the output

在文件 entry.h295 行定义.

被这些函数引用 addClassToContext(), addConceptToContext(), addVariableToClass(), buildNamespaceList(), Entry(), findUsingDirectives() , 以及 reset().

◆ id

◆ inbodyDocs

◆ inbodyFile

◆ inbodyLine

◆ includeFile

QCString Entry::includeFile

include file (2 arg of \class, must be unique)

在文件 entry.h265 行定义.

被这些函数引用 addIncludeFile(), Entry() , 以及 reset().

◆ includeName

QCString Entry::includeName

include name (3 arg of \class)

在文件 entry.h266 行定义.

被这些函数引用 addIncludeFile(), Entry() , 以及 reset().

◆ initializer

TextStream Entry::initializer

initial value (for variables)

在文件 entry.h264 行定义.

被这些函数引用 addConceptToContext(), addEnumValuesToEnums(), addMemberDocs(), addVariableToClass(), addVariableToFile(), Entry() , 以及 reset().

◆ initLines

int Entry::initLines

define/variable initializer lines to show

在文件 entry.h249 行定义.

被这些函数引用 addEnumValuesToEnums(), addMemberDocs(), addVariableToClass(), addVariableToFile(), Entry(), findDefineDocumentation() , 以及 reset().

◆ Initonly

const uint64 Entry::Initonly = (1ULL<<39)
static

在文件 entry.h162 行定义.

被这些函数引用 MemberDefImpl::isInitonly().

◆ Inline

const uint64 Entry::Inline = (1ULL<<24)
static

◆ inside

QCString Entry::inside

name of the class in which documents are found

在文件 entry.h280 行定义.

被这些函数引用 Entry(), filterMemberDocumentation() , 以及 reset().

◆ Interface

const uint64 Entry::Interface = (1ULL<<4)
static

◆ lang

◆ Local

const uint64 Entry::Local = (1ULL<<16)
static

◆ localToc

LocalToc Entry::localToc

在文件 entry.h299 行定义.

被这些函数引用 addRelatedPage(), Entry() , 以及 findMainPage().

◆ m_fileDef

FileDef* Entry::m_fileDef
private

在文件 entry.h333 行定义.

被这些函数引用 Entry(), fileDef(), reset() , 以及 setFileDef().

◆ m_parent

Entry* Entry::m_parent
private

parent node in the tree

在文件 entry.h330 行定义.

被这些函数引用 copyToSubEntry(), Entry(), moveToSubEntryAndKeep(), moveToSubEntryAndRefresh() , 以及 parent().

◆ m_sublist

std::vector< std::shared_ptr<Entry> > Entry::m_sublist
private

◆ MaybeAmbiguous

const uint64 Entry::MaybeAmbiguous = (1ULL<<62)
static

在文件 entry.h185 行定义.

被这些函数引用 MemberDefImpl::isMaybeAmbiguous().

◆ MaybeDefault

const uint64 Entry::MaybeDefault = (1ULL<<61)
static

在文件 entry.h184 行定义.

被这些函数引用 MemberDefImpl::isMaybeDefault().

◆ MaybeVoid

const uint64 Entry::MaybeVoid = (1ULL<<60)
static

在文件 entry.h183 行定义.

被这些函数引用 MemberDefImpl::isMaybeVoid().

◆ metaData

◆ mGrpId

◆ mtype

MethodTypes Entry::mtype

signal, slot, (dcop) method, or property?

在文件 entry.h247 行定义.

被这些函数引用 addOverloaded(), addVariableToClass(), Entry(), findMember() , 以及 reset().

◆ Mutable

const uint64 Entry::Mutable = (1ULL<<26)
static

在文件 entry.h149 行定义.

被这些函数引用 findMember() , 以及 MemberDefImpl::isMutable().

◆ name

◆ New

const uint64 Entry::New = (1ULL<<37)
static

在文件 entry.h160 行定义.

被这些函数引用 MemberDefImpl::isNew().

◆ NoExcept

const uint64 Entry::NoExcept = (1ULL<<53)
static

在文件 entry.h176 行定义.

被这些函数引用 MemberDefImpl::isNoExcept().

◆ NonAtomic

const uint64 Entry::NonAtomic = (1ULL<<42)
static

在文件 entry.h165 行定义.

被这些函数引用 MemberDefImpl::isNonAtomic().

◆ Optional

const uint64 Entry::Optional = (1ULL<<40)
static

在文件 entry.h163 行定义.

被这些函数引用 MemberDefImpl::isOptional().

◆ Override

const uint64 Entry::Override = (1ULL<<36)
static

在文件 entry.h159 行定义.

被这些函数引用 MemberDefImpl::isOverride().

◆ PrivateGettable

const uint64 Entry::PrivateGettable = (1ULL<<20)
static

在文件 entry.h143 行定义.

被这些函数引用 MemberDefImpl::isPrivateGettable().

◆ PrivateSettable

const uint64 Entry::PrivateSettable = (1ULL<<22)
static

在文件 entry.h145 行定义.

被这些函数引用 MemberDefImpl::isPrivateSettable().

◆ program

TextStream Entry::program

the program text

在文件 entry.h263 行定义.

被这些函数引用 Entry() , 以及 reset().

◆ Property

const uint64 Entry::Property = (1ULL<<55)
static

在文件 entry.h178 行定义.

被这些函数引用 MemberDefImpl::isUNOProperty().

◆ ProtectedGettable

const uint64 Entry::ProtectedGettable = (1ULL<<21)
static

在文件 entry.h144 行定义.

被这些函数引用 MemberDefImpl::isProtectedGettable().

◆ ProtectedSettable

const uint64 Entry::ProtectedSettable = (1ULL<<23)
static

在文件 entry.h146 行定义.

被这些函数引用 MemberDefImpl::isProtectedSettable().

◆ protection

◆ proto

bool Entry::proto

◆ Protocol

const uint64 Entry::Protocol = (1ULL<<8)
static

在文件 entry.h130 行定义.

被这些函数引用 TagFileParser::buildLists() , 以及 convertToCompoundType().

◆ Published

const uint64 Entry::Published = (1ULL<<63)
static

在文件 entry.h186 行定义.

被这些函数引用 buildNamespaceList(), MemberDefImpl::isPublished() , 以及 ClassDefImpl::isPublished().

◆ Raisable

const uint64 Entry::Raisable = (1ULL<<35)
static

在文件 entry.h158 行定义.

被这些函数引用 MemberDefImpl::isRaisable().

◆ read

QCString Entry::read

property read accessor

在文件 entry.h278 行定义.

被这些函数引用 addVariableToClass() , 以及 Entry().

◆ Readable

const uint64 Entry::Readable = (1ULL<<29)
static

在文件 entry.h152 行定义.

被这些函数引用 MemberDefImpl::isReadable().

◆ Readonly

const uint64 Entry::Readonly = (1ULL<<56)
static

在文件 entry.h179 行定义.

被这些函数引用 MemberDefImpl::isReadonly().

◆ Ref

const uint64 Entry::Ref = (1ULL<<2)
static

在文件 entry.h124 行定义.

◆ referencedByRelation

bool Entry::referencedByRelation

do we need to show the referenced by relation?

在文件 entry.h256 行定义.

被这些函数引用 addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addOverloaded(), addVariableToClass(), addVariableToFile(), Entry(), findEnums(), findMember(), findUsingDeclImports() , 以及 reset().

◆ referencesRelation

bool Entry::referencesRelation

do we need to show the references relation?

在文件 entry.h257 行定义.

被这些函数引用 addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addOverloaded(), addVariableToClass(), addVariableToFile(), Entry(), findEnums(), findMember(), findUsingDeclImports() , 以及 reset().

◆ relates

QCString Entry::relates

related class (doc block)

在文件 entry.h276 行定义.

被这些函数引用 addEnumValuesToEnums(), Entry(), findEnums(), findMemberDocumentation(), DocGroup::initGroupInfo(), DocGroup::open() , 以及 reset().

◆ relatesType

RelatesType Entry::relatesType

how relates is handled

在文件 entry.h277 行定义.

被这些函数引用 Entry(), findEnums(), findGlobalMember(), findMember(), findMemberDocumentation() , 以及 reset().

◆ Removable

const uint64 Entry::Removable = (1ULL<<34)
static

在文件 entry.h157 行定义.

被这些函数引用 MemberDefImpl::isRemovable().

◆ req

QCString Entry::req

C++20 requires clause

在文件 entry.h301 行定义.

被这些函数引用 addClassToContext(), addMemberDocs(), Entry(), findGlobalMember() , 以及 reset().

◆ Required

const uint64 Entry::Required = (1ULL<<41)
static

在文件 entry.h164 行定义.

被这些函数引用 MemberDefImpl::isRequired().

◆ Retain

const uint64 Entry::Retain = (1ULL<<44)
static

在文件 entry.h167 行定义.

被这些函数引用 MemberDefImpl::isRetain().

◆ Sealed

const uint64 Entry::Sealed = (1ULL<<38)
static

在文件 entry.h161 行定义.

被这些函数引用 MemberDefImpl::isSealed() , 以及 ClassDefImpl::isSealed().

◆ SealedClass

const uint64 Entry::SealedClass = (1ULL<<10)
static

在文件 entry.h132 行定义.

◆ section

◆ Service

const uint64 Entry::Service = (1ULL<<13)
static

在文件 entry.h135 行定义.

被这些函数引用 TagFileParser::buildLists() , 以及 convertToCompoundType().

◆ Settable

const uint64 Entry::Settable = (1ULL<<27)
static

在文件 entry.h150 行定义.

被这些函数引用 MemberDefImpl::isSettable().

◆ Singleton

const uint64 Entry::Singleton = (1ULL<<14)
static

在文件 entry.h136 行定义.

被这些函数引用 TagFileParser::buildLists() , 以及 convertToCompoundType().

◆ sli

◆ spec

◆ startColumn

◆ startLine

◆ stat

◆ Strong

const uint64 Entry::Strong = (1ULL<<46)
static

在文件 entry.h169 行定义.

被这些函数引用 addEnumValuesToEnums(), TagFileParser::buildMemberList() , 以及 MemberDefImpl::isStrong().

◆ Struct

const uint64 Entry::Struct = (1ULL<<5)
static

◆ subGrouping

bool Entry::subGrouping

automatically group class members?

在文件 entry.h253 行定义.

被这些函数引用 addClassToContext(), Entry() , 以及 reset().

◆ tagInfoData

TagInfo Entry::tagInfoData

tag file info data

在文件 entry.h242 行定义.

被这些函数引用 Entry() , 以及 tagInfo().

◆ tArgLists

◆ Template

const uint64 Entry::Template = (1ULL<<0)
static

在文件 entry.h122 行定义.

◆ Transient

const uint64 Entry::Transient = (1ULL<<59)
static

在文件 entry.h182 行定义.

被这些函数引用 MemberDefImpl::isTransient().

◆ type

◆ typeConstr

ArgumentList Entry::typeConstr

where clause (C#) for type constraints

在文件 entry.h282 行定义.

被这些函数引用 addClassToContext(), addMemberSpecialization(), addOverloaded(), Entry() , 以及 reset().

◆ Union

const uint64 Entry::Union = (1ULL<<6)
static

在文件 entry.h128 行定义.

被这些函数引用 TagFileParser::buildLists() , 以及 convertToCompoundType().

◆ Unretained

const uint64 Entry::Unretained = (1ULL<<48)
static

在文件 entry.h171 行定义.

被这些函数引用 MemberDefImpl::isUnretained().

◆ Value

const uint64 Entry::Value = (1ULL<<3)
static

在文件 entry.h125 行定义.

◆ virt

Specifier Entry::virt

virtualness of the entry

在文件 entry.h258 行定义.

被这些函数引用 addLocalObjCMethod(), addMemberFunction(), addMemberSpecialization(), addOverloaded(), Entry(), findMember(), findUsingDeclImports() , 以及 reset().

◆ Weak

const uint64 Entry::Weak = (1ULL<<47)
static

在文件 entry.h170 行定义.

被这些函数引用 MemberDefImpl::isWeak().

◆ Writable

const uint64 Entry::Writable = (1ULL<<30)
static

在文件 entry.h153 行定义.

被这些函数引用 MemberDefImpl::isWritable().

◆ write

QCString Entry::write

property write accessor

在文件 entry.h279 行定义.

被这些函数引用 addVariableToClass() , 以及 Entry().


该类的文档由以下文件生成:
SrcLangExt_Unknown
@ SrcLangExt_Unknown
Definition: types.h:43
Entry::args
QCString args
member argument string
Definition: entry.h:259
Entry::SERVICEDOC_SEC
@ SERVICEDOC_SEC
Definition: entry.h:81
Entry::tArgLists
ArgumentLists tArgLists
template argument declarations
Definition: entry.h:262
Entry::GROUPDOC_NORMAL
@ GROUPDOC_NORMAL
defgroup
Definition: entry.h:190
Entry::OVERLOADDOC_SEC
@ OVERLOADDOC_SEC
Definition: entry.h:100
Entry::virt
Specifier virt
virtualness of the entry
Definition: entry.h:258
Entry::EXAMPLE_SEC
@ EXAMPLE_SEC
Definition: entry.h:101
Normal
@ Normal
Definition: types.h:29
Entry::INTERFACEDOC_SEC
@ INTERFACEDOC_SEC
Definition: entry.h:78
Entry::initializer
TextStream initializer
initial value (for variables)
Definition: entry.h:264
Entry::startLine
int startLine
start line of entry in the source
Definition: entry.h:291
Entry::callGraph
bool callGraph
do we need to draw the call graph?
Definition: entry.h:254
Entry::STRUCTDOC_SEC
@ STRUCTDOC_SEC
Definition: entry.h:74
Entry::CLASSDOC_SEC
@ CLASSDOC_SEC
Definition: entry.h:73
Entry::SINGLETONDOC_SEC
@ SINGLETONDOC_SEC
Definition: entry.h:82
Entry::spec
uint64 spec
class/member specifiers
Definition: entry.h:248
Entry::mtype
MethodTypes mtype
signal, slot, (dcop) method, or property?
Definition: entry.h:247
Entry::extends
std::vector< BaseInfo > extends
list of base classes
Definition: entry.h:287
Entry::ENUM_SEC
@ ENUM_SEC
Definition: entry.h:93
Entry::startColumn
int startColumn
start column of entry in the source
Definition: entry.h:292
Entry::name
QCString name
member name
Definition: entry.h:240
Entry::hidden
bool hidden
does this represent an entity that is hidden from the output
Definition: entry.h:295
Entry::COMPOUND_MASK
@ COMPOUND_MASK
Definition: entry.h:70
Entry::USINGDIR_SEC
@ USINGDIR_SEC
Definition: entry.h:108
Entry::anchors
std::vector< const SectionInfo * > anchors
list of anchors defined in this entry
Definition: entry.h:289
Entry::CONCEPT_SEC
@ CONCEPT_SEC
Definition: entry.h:69
Entry::hasTagInfo
bool hasTagInfo
is tag info valid
Definition: entry.h:241
Entry::referencedByRelation
bool referencedByRelation
do we need to show the referenced by relation?
Definition: entry.h:256
Entry::mGrpId
int mGrpId
member group id
Definition: entry.h:286
Entry::DEFINE_SEC
@ DEFINE_SEC
Definition: entry.h:106
Grouping::GROUPING_LOWEST
@ GROUPING_LOWEST
Definition: types.h:69
Entry::protection
Protection protection
class protection
Definition: entry.h:246
Entry::VARIABLEDOC_SEC
@ VARIABLEDOC_SEC
Definition: entry.h:102
Public
@ Public
Definition: types.h:26
Entry::id
QCString id
libclang id
Definition: entry.h:298
Entry::briefFile
QCString briefFile
file in which the brief desc. was found
Definition: entry.h:272
Entry::MAINPAGEDOC_SEC
@ MAINPAGEDOC_SEC
Definition: entry.h:109
Entry::DIRDOC_SEC
@ DIRDOC_SEC
Definition: entry.h:115
Entry::CONCEPTDOC_SEC
@ CONCEPTDOC_SEC
Definition: entry.h:83
Entry::includeName
QCString includeName
include name (3 arg of \class)
Definition: entry.h:266
Entry::docLine
int docLine
line number at which the documentation was found
Definition: entry.h:268
Entry::includeFile
QCString includeFile
include file (2 arg of \class, must be unique)
Definition: entry.h:265
Entry::reset
void reset()
Definition: entry.cpp:183
Entry::EXCEPTIONDOC_SEC
@ EXCEPTIONDOC_SEC
Definition: entry.h:76
Entry::PROTOCOLDOC_SEC
@ PROTOCOLDOC_SEC
Definition: entry.h:79
Entry::relates
QCString relates
related class (doc block)
Definition: entry.h:276
Entry::doc
QCString doc
documentation block (partly parsed)
Definition: entry.h:267
Entry::UNIONDOC_SEC
@ UNIONDOC_SEC
Definition: entry.h:75
Entry::groupDocType
GroupDocType groupDocType
Definition: entry.h:297
Entry::FILEDOC_SEC
@ FILEDOC_SEC
Definition: entry.h:103
Entry::CATEGORYDOC_SEC
@ CATEGORYDOC_SEC
Definition: entry.h:80
Entry::bodyColumn
int bodyColumn
column of the body in the source
Definition: entry.h:284
Entry::GROUPDOC_ADD
@ GROUPDOC_ADD
addtogroup
Definition: entry.h:191
Entry::SCOPE_MASK
@ SCOPE_MASK
Definition: entry.h:71
Entry::inbodyDocs
QCString inbodyDocs
documentation inside the body of a function
Definition: entry.h:273
Entry::NAMESPACE_SEC
@ NAMESPACE_SEC
Definition: entry.h:68
Entry::metaData
QCString metaData
Slice metadata
Definition: entry.h:300
Entry::TYPEDEF_SEC
@ TYPEDEF_SEC
Definition: entry.h:98
Entry::INCLUDED_SERVICE_SEC
@ INCLUDED_SERVICE_SEC
Definition: entry.h:117
Entry::program
TextStream program
the program text
Definition: entry.h:263
Entry::INCLUDE_SEC
@ INCLUDE_SEC
Definition: entry.h:105
Method
@ Method
Definition: types.h:32
Entry::SOURCE_SEC
@ SOURCE_SEC
Definition: entry.h:88
Entry::briefLine
int briefLine
line number at which the brief desc. was found
Definition: entry.h:271
Entry::CLASS_SEC
@ CLASS_SEC
Definition: entry.h:67
Entry::OBJCIMPL_SEC
@ OBJCIMPL_SEC
Definition: entry.h:114
Entry::section
int section
entry type (see Sections);
Definition: entry.h:238
Entry::ENUMDOC_SEC
@ ENUMDOC_SEC
Definition: entry.h:92
Entry::endBodyLine
int endBodyLine
line number where the definition ends
Definition: entry.h:285
Entry::localToc
LocalToc localToc
Definition: entry.h:299
Entry::callerGraph
bool callerGraph
do we need to draw the caller graph?
Definition: entry.h:255
Entry::m_parent
Entry * m_parent
parent node in the tree
Definition: entry.h:330
g_num
static AtomicInt g_num
Definition: entry.cpp:31
Entry::m_fileDef
FileDef * m_fileDef
Definition: entry.h:333
TRUE
#define TRUE
Definition: qcstring.h:36
Entry::FUNCTION_SEC
@ FUNCTION_SEC
Definition: entry.h:97
Entry::COMPOUNDDOC_MASK
@ COMPOUNDDOC_MASK
Definition: entry.h:84
Entry::inbodyLine
int inbodyLine
line number at which the body doc was found
Definition: entry.h:274
Entry::MEMBERDOC_SEC
@ MEMBERDOC_SEC
Definition: entry.h:99
TextStream::str
std::string str() const
Return the contents of the buffer as a std::string object
Definition: textstream.h:208
Entry::stat
bool stat
static ?
Definition: entry.h:250
Entry::GROUPDOC_SEC
@ GROUPDOC_SEC
Definition: entry.h:107
Grouping::GROUPING_AUTO_DEF
@ GROUPING_AUTO_DEF
membership in group was defined via @defgroup
Definition: types.h:72
Entry::USINGDECL_SEC
@ USINGDECL_SEC
Definition: entry.h:111
Entry::fileName
QCString fileName
file this entry was extracted from
Definition: entry.h:290
Entry::m_sublist
std::vector< std::shared_ptr< Entry > > m_sublist
Definition: entry.h:331
Entry::Entry
Entry()
Definition: entry.cpp:33
Entry::inbodyFile
QCString inbodyFile
file in which the body doc was found
Definition: entry.h:275
Entry::NAMESPACEDOC_SEC
@ NAMESPACEDOC_SEC
Definition: entry.h:77
Entry::lang
SrcLangExt lang
programming language in which this entry was found
Definition: entry.h:294
Entry::typeConstr
ArgumentList typeConstr
where clause (C#) for type constraints
Definition: entry.h:282
Entry::brief
QCString brief
brief description (doc block)
Definition: entry.h:270
Entry::bodyLine
int bodyLine
line number of the body in the source
Definition: entry.h:283
Entry::initLines
int initLines
define/variable initializer lines to show
Definition: entry.h:249
Entry
Represents an unstructured piece of information, about an entity found in the sources.
Definition: entry.h:61
Config_getBool
#define Config_getBool(name)
Definition: config.h:33
Entry::PAGEDOC_SEC
@ PAGEDOC_SEC
Definition: entry.h:95
Entry::explicitExternal
bool explicitExternal
explicitly defined as external?
Definition: entry.h:251
Entry::relatesType
RelatesType relatesType
how relates is handled
Definition: entry.h:277
Entry::EXAMPLE_LINENO_SEC
@ EXAMPLE_LINENO_SEC
Definition: entry.h:118
Grouping::GROUPING_AUTO_ADD
@ GROUPING_AUTO_ADD
membership in group was defined via @add[to]group
Definition: types.h:71
Entry::PACKAGE_SEC
@ PACKAGE_SEC
Definition: entry.h:112
Entry::artificial
bool artificial
Artificially introduced item
Definition: entry.h:296
Entry::EMPTY_SEC
@ EMPTY_SEC
Definition: entry.h:94
ArgumentList::reset
void reset()
Definition: arguments.h:73
Entry::inside
QCString inside
name of the class in which documents are found
Definition: entry.h:280
Entry::read
QCString read
property read accessor
Definition: entry.h:278
Entry::HEADER_SEC
@ HEADER_SEC
Definition: entry.h:89
Entry::VARIABLE_SEC
@ VARIABLE_SEC
Definition: entry.h:96
Entry::sli
RefItemVector sli
special lists (test/todo/bug/deprecated/..) this entry is in
Definition: entry.h:293
Entry::subGrouping
bool subGrouping
automatically group class members?
Definition: entry.h:253
Entry::PACKAGEDOC_SEC
@ PACKAGEDOC_SEC
Definition: entry.h:113
Entry::type
QCString type
member type
Definition: entry.h:239
Entry::exception
QCString exception
throw specification
Definition: entry.h:281
Entry::proto
bool proto
prototype ?
Definition: entry.h:252
Entry::bitfields
QCString bitfields
member's bit fields
Definition: entry.h:260
Entry::DEFINEDOC_SEC
@ DEFINEDOC_SEC
Definition: entry.h:104
Entry::referencesRelation
bool referencesRelation
do we need to show the references relation?
Definition: entry.h:257
Grouping::GROUPING_AUTO_WEAK
@ GROUPING_AUTO_WEAK
membership in group was defined via @weakgroup
Definition: types.h:70
Entry::argList
ArgumentList argList
member arguments as a list
Definition: entry.h:261
Entry::tagInfoData
TagInfo tagInfoData
tag file info data
Definition: entry.h:242
Entry::docFile
QCString docFile
file in which the documentation was found
Definition: entry.h:269
Entry::write
QCString write
property write accessor
Definition: entry.h:279
Simple
@ Simple
Definition: types.h:35
Entry::groups
std::vector< Grouping > groups
list of groups this entry belongs to
Definition: entry.h:288
Entry::MEMBERGRP_SEC
@ MEMBERGRP_SEC
Definition: entry.h:110
QCString::resize
bool resize(size_t newlen)
Resizes the string to hold newlen characters (this value should also count the 0-terminator).
Definition: qcstring.h:164
Entry::FILE_MASK
@ FILE_MASK
Definition: entry.h:90
FALSE
#define FALSE
Definition: qcstring.h:33
Entry::GROUPDOC_WEAK
@ GROUPDOC_WEAK
weakgroup
Definition: entry.h:192
Entry::EXPORTED_INTERFACE_SEC
@ EXPORTED_INTERFACE_SEC
Definition: entry.h:116
Entry::req
QCString req
C++20 requires clause
Definition: entry.h:301