Doxygen
|
Represents an unstructured piece of information, about an entity found in the sources. More...
#include <src/entry.h>
Public Types | |
enum | GroupDocType { GROUPDOC_NORMAL , GROUPDOC_ADD , GROUPDOC_WEAK } |
Public Member Functions | |
Entry () | |
Entry (const Entry &) | |
Entry & | operator= (const Entry &)=delete |
Entry (Entry &&)=delete | |
Entry & | operator= (Entry &&)=delete |
~Entry () | |
Entry * | parent () const |
const std::vector< std::shared_ptr< Entry > > & | children () const |
add entry as a child and pass ownership. | |
| |
void | moveToSubEntryAndKeep (Entry *e) |
void | moveToSubEntryAndKeep (std::shared_ptr< Entry > e) |
add entry as a child, pass ownership and reinitialize entry | |
EntryType | 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? | |
TypeSpecifier | spec |
class/member specifiers | |
VhdlSpecifier | vhdlSpec |
VHDL specifiers. | |
int | initLines |
define/variable initializer lines to show | |
bool | isStatic |
static ? | |
bool | explicitExternal |
explicitly defined as external? | |
bool | proto |
prototype ? | |
bool | subGrouping |
automatically group class members? | |
bool | exported |
is the symbol exported from a C++20 module | |
CommandOverrides | commandOverrides |
store info for commands whose default can be overridden | |
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< BaseInfo > | extends |
list of base classes | |
std::vector< Grouping > | groups |
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. | |
std::vector< std::string > | qualifiers |
qualifiers specified with the qualifier command | |
Entry * | m_parent |
parent node in the tree | |
std::vector< std::shared_ptr< Entry > > | m_sublist |
FileDef * | m_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) |
FileDef * | fileDef () const |
const TagInfo * | tagInfo () const |
const char * | groupDocCmd () const |
return the command name used to define GROUPDOC_SEC | |
Grouping::GroupPri_t | groupingPri () const |
Represents an unstructured piece of information, about an entity found in the sources.
parseMain() in scanner.l will generate a tree of these entries.
enum Entry::GroupDocType |
Entry::Entry | ( | ) |
Definition at line 33 of file entry.cpp.
References FALSE, g_num, GROUPDOC_NORMAL, groupDocType, hasTagInfo, hidden, initializer, m_parent, mGrpId, program, relatesType, reset(), section, and Simple.
Referenced by copyToSubEntry(), Entry(), Entry(), markAsProcessed(), moveToSubEntryAndKeep(), moveToSubEntryAndRefresh(), operator=(), operator=(), parent(), and removeSubEntry().
Entry::Entry | ( | const Entry & | e | ) |
Definition at line 47 of file entry.cpp.
References anchors, argList, args, artificial, bitfields, bodyColumn, bodyLine, brief, briefFile, briefLine, commandOverrides, doc, docFile, docLine, endBodyLine, Entry(), exception, explicitExternal, exported, extends, fileName, g_num, groupDocType, groups, hasTagInfo, hidden, id, inbodyDocs, inbodyFile, inbodyLine, includeFile, includeName, initializer, initLines, inside, isStatic, lang, localToc, m_fileDef, m_parent, m_sublist, mGrpId, mtype, name, program, protection, proto, qualifiers, read, relates, relatesType, req, section, sli, spec, startColumn, startLine, TextStream::str(), subGrouping, tagInfoData, tArgLists, type, typeConstr, vhdlSpec, virt, and write.
Entry::~Entry | ( | ) |
|
inline |
Returns the list of children for this Entry
Definition at line 139 of file entry.h.
References m_sublist.
Referenced by addEnumValuesToEnums(), buildClassDocList(), buildClassList(), buildConceptDocList(), buildConceptList(), buildDictionaryList(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildInterfaceAndServiceList(), buildListOfUsingDecls(), buildNamespaceList(), buildPageList(), buildSequenceList(), buildTypedefList(), buildVarList(), computePageRelations(), endScope(), findClassEntries(), findDefineDocumentation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findGroupScope(), findMainPage(), findMainPageTagFiles(), findMemberDocumentation(), findModuleDocumentation(), findObjCMethodDefinitions(), findUsingDeclarations(), findUsingDeclImports(), findUsingDirectives(), VHDLOutlineParser::mapLibPackage(), organizeSubGroupsFiltered(), printNavTree(), resolveModuleProcedures(), and resolveTypeBoundProcedures().
void Entry::copyToSubEntry | ( | const std::shared_ptr< Entry > & | e | ) |
void Entry::copyToSubEntry | ( | Entry * | e | ) |
|
inline |
Definition at line 169 of file entry.h.
References m_fileDef.
Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), addEnumValuesToEnums(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberFunction(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addVariableToClass(), addVariableToFile(), buildFunctionList(), buildNamespaceList(), findClassRelation(), findDefineDocumentation(), findEnumDocumentation(), findEnums(), findGlobalMember(), findMember(), findUsingDeclarations(), findUsingDeclImports(), findUsingDirectives(), isVarWithConstructor(), and resolveTemplateInstanceInType().
|
inline |
return the command name used to define GROUPDOC_SEC
Definition at line 238 of file entry.h.
References GROUPDOC_ADD, GROUPDOC_NORMAL, GROUPDOC_WEAK, and groupDocType.
|
inline |
Definition at line 248 of file entry.h.
References GROUPDOC_ADD, GROUPDOC_NORMAL, GROUPDOC_WEAK, groupDocType, Grouping::GROUPING_AUTO_ADD, Grouping::GROUPING_AUTO_DEF, Grouping::GROUPING_AUTO_WEAK, Grouping::GROUPING_LOWEST, and section.
Referenced by DocGroup::open().
|
inline |
Definition at line 167 of file entry.h.
References Entry(), and section.
Referenced by addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addMethodToClass(), addVariableToClass(), addVariableToFile(), and buildTypedefList().
void Entry::moveToSubEntryAndKeep | ( | Entry * | e | ) |
void Entry::moveToSubEntryAndKeep | ( | std::shared_ptr< Entry > | e | ) |
void Entry::moveToSubEntryAndRefresh | ( | Entry *& | e | ) |
void Entry::moveToSubEntryAndRefresh | ( | std::shared_ptr< Entry > & | e | ) |
|
inline |
Returns the parent for this Entry or nullptr if this entry has no parent.
Definition at line 134 of file entry.h.
References Entry(), and m_parent.
Referenced by addClassToContext(), addConceptToContext(), addEnumDocs(), addEnumValuesToEnums(), addGlobalFunction(), addMemberDocs(), addMemberFunction(), addPageToContext(), addVariable(), buildFunctionList(), buildInterfaceAndServiceList(), buildListOfUsingDecls(), buildTypedefList(), endScope(), findClassRelation(), findDefineDocumentation(), findEnumDocumentation(), findEnums(), findGroupScope(), findMember(), findUsingDeclarations(), findUsingDeclImports(), findUsingDirectives(), and isVarWithConstructor().
void Entry::removeSubEntry | ( | const Entry * | e | ) |
void Entry::reset | ( | ) |
Restore the state of this Entry to the default value it has at construction time.
Definition at line 181 of file entry.cpp.
References anchors, argList, args, artificial, bitfields, bodyColumn, bodyLine, brief, briefFile, briefLine, commandOverrides, doc, docFile, docLine, endBodyLine, exception, explicitExternal, exported, extends, fileName, GROUPDOC_NORMAL, groupDocType, groups, hidden, inbodyDocs, inbodyFile, inbodyLine, includeFile, includeName, initializer, initLines, inside, isStatic, lang, m_fileDef, m_sublist, metaData, Method, mGrpId, mtype, name, Normal, program, protection, proto, Public, qualifiers, relates, relatesType, req, section, Simple, sli, spec, startColumn, startLine, subGrouping, tArgLists, type, typeConstr, UNKNOWN, Unknown, vhdlSpec, and virt.
Referenced by Entry().
void Entry::setFileDef | ( | FileDef * | fd | ) |
|
inline |
Definition at line 177 of file entry.h.
References hasTagInfo, and tagInfoData.
Referenced by addClassToContext(), addConceptToContext(), addEnumValuesToEnums(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addPageToContext(), addRelatedPage(), addVariable(), addVariableToClass(), addVariableToFile(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildNamespaceList(), buildTypedefList(), findClassRelation(), findDefineDocumentation(), findEnums(), findGroupScope(), findMainPage(), findMainPageTagFiles(), findMember(), and findUsingDeclImports().
std::vector<const SectionInfo*> Entry::anchors |
list of anchors defined in this entry
Definition at line 222 of file entry.h.
Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), addEnumDocs(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildNamespaceList(), buildTypedefList(), createUsingMemberImportForClass(), Entry(), findEnums(), findMainPage(), findMainPageTagFiles(), findMember(), findUsingDeclImports(), findUsingDirectives(), and reset().
ArgumentList Entry::argList |
member arguments as a list
Definition at line 194 of file entry.h.
Referenced by addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberFunction(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addVariableToFile(), buildFunctionList(), Entry(), findArgument(), findGlobalMember(), findMember(), isVarWithConstructor(), and reset().
QCString Entry::args |
member argument string
Definition at line 192 of file entry.h.
Referenced by addGlobalFunction(), addRelatedPage(), addVariable(), buildExampleList(), buildFunctionList(), buildInterfaceAndServiceList(), buildPageList(), Entry(), filterMemberDocumentation(), findDefineDocumentation(), findEnums(), findMainPage(), and reset().
bool Entry::artificial |
Artificially introduced item.
Definition at line 229 of file entry.h.
Referenced by addClassToContext(), addVariableToClass(), buildNamespaceList(), Entry(), and reset().
QCString Entry::bitfields |
member's bit fields
Definition at line 193 of file entry.h.
Referenced by addVariableToClass(), Entry(), and reset().
int Entry::bodyColumn |
int Entry::bodyLine |
line number of the body in the source
Definition at line 216 of file entry.h.
Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), ModuleManager::addDocs(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addVariable(), addVariableToClass(), addVariableToFile(), buildFunctionList(), buildInterfaceAndServiceList(), buildNamespaceList(), VHDLOutlineParser::checkInlineCode(), Entry(), findDefineDocumentation(), findEnums(), findMember(), and reset().
QCString Entry::brief |
brief description (doc block)
Definition at line 203 of file entry.h.
Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), DocGroup::addDocs(), ModuleManager::addDocs(), addEnumDocs(), addGlobalFunction(), addIncludeFile(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildNamespaceList(), buildTypedefList(), VHDLOutlineParser::checkInlineCode(), createUsingMemberImportForClass(), Entry(), findDefineDocumentation(), findDirDocumentation(), findEnums(), findMainPage(), findMember(), findUsingDeclImports(), findUsingDirectives(), and reset().
QCString Entry::briefFile |
file in which the brief desc. was found
Definition at line 205 of file entry.h.
Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), ModuleManager::addDocs(), addEnumDocs(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildNamespaceList(), buildTypedefList(), createUsingMemberImportForClass(), Entry(), findDirDocumentation(), findEnums(), findMainPage(), findMember(), findUsingDeclImports(), findUsingDirectives(), and reset().
int Entry::briefLine |
line number at which the brief desc. was found
Definition at line 204 of file entry.h.
Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), ModuleManager::addDocs(), addEnumDocs(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildNamespaceList(), buildTypedefList(), createUsingMemberImportForClass(), Entry(), findDirDocumentation(), findEnums(), findMainPage(), findMember(), findUsingDeclImports(), findUsingDirectives(), and reset().
CommandOverrides Entry::commandOverrides |
store info for commands whose default can be overridden
Definition at line 190 of file entry.h.
Referenced by addClassToContext(), applyMemberOverrideOptions(), buildFileList(), buildGroupListFiltered(), Entry(), findDirDocumentation(), and reset().
QCString Entry::doc |
documentation block (partly parsed)
Definition at line 200 of file entry.h.
Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), DocGroup::addDocs(), ModuleManager::addDocs(), addEnumDocs(), addGlobalFunction(), addIncludeFile(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addMemberToGroups(), addMethodToClass(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildNamespaceList(), buildTypedefList(), VHDLOutlineParser::checkInlineCode(), createUsingMemberImportForClass(), Entry(), findDefineDocumentation(), findDirDocumentation(), findEnums(), findMainPage(), findMember(), findUsingDeclImports(), findUsingDirectives(), CitationManager::generatePage(), and reset().
QCString Entry::docFile |
file in which the documentation was found
Definition at line 202 of file entry.h.
Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), DocGroup::addDocs(), ModuleManager::addDocs(), addEnumDocs(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildInterfaceAndServiceList(), buildNamespaceList(), buildTypedefList(), createUsingMemberImportForClass(), Entry(), findDirDocumentation(), findEnums(), findMainPage(), findMember(), findUsingDeclImports(), findUsingDirectives(), and reset().
int Entry::docLine |
line number at which the documentation was found
Definition at line 201 of file entry.h.
Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), DocGroup::addDocs(), ModuleManager::addDocs(), addEnumDocs(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildNamespaceList(), buildTypedefList(), createUsingMemberImportForClass(), Entry(), findDirDocumentation(), findEnums(), findMainPage(), findMember(), findUsingDeclImports(), findUsingDirectives(), CommentScanner::parseCommentBlock(), and reset().
int Entry::endBodyLine |
line number where the definition ends
Definition at line 218 of file entry.h.
Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), ModuleManager::addDocs(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addVariable(), addVariableToClass(), addVariableToFile(), buildFunctionList(), buildNamespaceList(), VHDLOutlineParser::checkInlineCode(), Entry(), findEnums(), findMember(), and reset().
QCString Entry::exception |
throw specification
Definition at line 214 of file entry.h.
Referenced by addGlobalFunction(), addMethodToClass(), addVariableToClass(), Entry(), filterMemberDocumentation(), and reset().
bool Entry::explicitExternal |
explicitly defined as external?
Definition at line 186 of file entry.h.
Referenced by addGlobalFunction(), addVariableToFile(), Entry(), and reset().
bool Entry::exported |
is the symbol exported from a C++20 module
Definition at line 189 of file entry.h.
Referenced by ModuleDefImpl::addClassToModule(), ModuleDefImpl::addConceptToModule(), ModuleDefImpl::addMemberToModule(), ModuleManager::addMemberToModule(), buildNamespaceList(), Entry(), findUsingDirectives(), and reset().
std::vector<BaseInfo> Entry::extends |
list of base classes
Definition at line 220 of file entry.h.
Referenced by computePageRelations(), computeTemplateClassRelations(), Entry(), findBaseClassesForClass(), isClassSection(), and reset().
QCString Entry::fileName |
file this entry was extracted from
Definition at line 223 of file entry.h.
Referenced by addClassToContext(), addClassToGroups(), ModuleDefImpl::addClassToModule(), ModuleManager::addClassToModule(), addConceptToContext(), addConceptToGroups(), ModuleDefImpl::addConceptToModule(), ModuleManager::addConceptToModule(), addDirToGroups(), ModuleManager::addDocs(), addExampleToGroups(), addGlobalFunction(), addGroupToGroups(), addIncludeFile(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberFunction(), addMemberSpecialization(), addMemberToGroups(), ModuleDefImpl::addMemberToModule(), ModuleManager::addMemberToModule(), addMethodToClass(), addModuleToGroups(), addNamespaceToGroups(), addOverloaded(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildInterfaceAndServiceList(), buildNamespaceList(), VHDLOutlineParser::checkInlineCode(), computeClassRelations(), Entry(), findClassRelation(), findDefineDocumentation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findGlobalMember(), findMainPage(), findMember(), findTemplateInstanceRelation(), findUsingDeclarations(), findUsingDeclImports(), findUsingDirectives(), haveEqualFileNames(), VHDLOutlineParser::initEntry(), printNavTree(), reset(), and tryAddEnumDocsToGroupMember().
GroupDocType Entry::groupDocType |
Definition at line 230 of file entry.h.
Referenced by buildGroupListFiltered(), Entry(), Entry(), groupDocCmd(), groupingPri(), organizeSubGroupsFiltered(), and reset().
std::vector<Grouping> Entry::groups |
list of groups this entry belongs to
Definition at line 221 of file entry.h.
Referenced by addClassToGroups(), addConceptToGroups(), addDirToGroups(), addEnumDocs(), addExampleToGroups(), addGroupToGroups(), addMemberToGroups(), addModuleToGroups(), addNamespaceToGroups(), addRelatedPage(), buildFileList(), buildFunctionList(), buildTypedefList(), DocGroup::close(), Entry(), findGlobalMember(), findUsingDirectives(), DocGroup::initGroupInfo(), isEntryInGroupOfMember(), reset(), and tryAddEnumDocsToGroupMember().
bool Entry::hasTagInfo |
bool Entry::hidden |
does this represent an entity that is hidden from the output
Definition at line 228 of file entry.h.
Referenced by addClassToContext(), addConceptToContext(), ModuleManager::addDocs(), addVariableToClass(), buildNamespaceList(), Entry(), Entry(), findUsingDirectives(), and reset().
QCString Entry::id |
libclang id
Definition at line 231 of file entry.h.
Referenced by addClassToContext(), addConceptToContext(), ModuleManager::addDocs(), addGlobalFunction(), addLocalObjCMethod(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addVariableToClass(), addVariableToFile(), buildNamespaceList(), createUsingMemberImportForClass(), Entry(), findEnums(), findMember(), findUsingDeclImports(), and findUsingDirectives().
QCString Entry::inbodyDocs |
documentation inside the body of a function
Definition at line 206 of file entry.h.
Referenced by addDefineDoc(), addEnumDocs(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFunctionList(), buildGroupListFiltered(), buildTypedefList(), VHDLOutlineParser::checkInlineCode(), createUsingMemberImportForClass(), Entry(), findEnums(), findMainPage(), findMember(), findUsingDeclImports(), and reset().
QCString Entry::inbodyFile |
file in which the body doc was found
Definition at line 208 of file entry.h.
Referenced by addDefineDoc(), addEnumDocs(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addVariableToClass(), addVariableToFile(), buildFunctionList(), buildGroupListFiltered(), buildTypedefList(), createUsingMemberImportForClass(), Entry(), findEnums(), findMember(), findUsingDeclImports(), and reset().
int Entry::inbodyLine |
line number at which the body doc was found
Definition at line 207 of file entry.h.
Referenced by addDefineDoc(), addEnumDocs(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addVariableToClass(), addVariableToFile(), buildFunctionList(), buildGroupListFiltered(), buildTypedefList(), createUsingMemberImportForClass(), Entry(), findEnums(), findMember(), findUsingDeclImports(), and reset().
QCString Entry::includeFile |
include file (2 arg of \class, must be unique)
Definition at line 198 of file entry.h.
Referenced by addIncludeFile(), Entry(), and reset().
QCString Entry::includeName |
include name (3 arg of \class)
Definition at line 199 of file entry.h.
Referenced by addIncludeFile(), Entry(), and reset().
TextStream Entry::initializer |
initial value (for variables)
Definition at line 197 of file entry.h.
Referenced by addConceptToContext(), addMemberDocs(), addVariableToClass(), addVariableToFile(), Entry(), Entry(), and reset().
int Entry::initLines |
define/variable initializer lines to show
Definition at line 184 of file entry.h.
Referenced by addDefineDoc(), addMemberDocs(), addVariableToClass(), addVariableToFile(), Entry(), and reset().
QCString Entry::inside |
name of the class in which documents are found
Definition at line 213 of file entry.h.
Referenced by Entry(), filterMemberDocumentation(), and reset().
bool Entry::isStatic |
static ?
Definition at line 185 of file entry.h.
Referenced by addClassToContext(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberFunction(), addMemberSpecialization(), addOverloaded(), addVariableToClass(), addVariableToFile(), applyModifiers(), buildFunctionList(), Entry(), findMember(), and reset().
SrcLangExt Entry::lang |
programming language in which this entry was found
Definition at line 227 of file entry.h.
Referenced by addClassToContext(), addConceptToContext(), addEnumValuesToEnums(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberFunction(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addRelatedPage(), addVariable(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFunctionList(), buildGroupListFiltered(), buildInterfaceAndServiceList(), buildNamespaceList(), buildTypedefList(), buildVarList(), VHDLOutlineParser::checkInlineCode(), createUsingMemberImportForClass(), Entry(), extractClassName(), filterMemberDocumentation(), findClassRelation(), findDefineDocumentation(), findEnums(), findGlobalMember(), findMember(), findTemplateInstanceRelation(), findUsedClassesForClass(), findUsingDeclarations(), findUsingDeclImports(), findUsingDirectives(), VHDLOutlineParser::initEntry(), and reset().
LocalToc Entry::localToc |
Definition at line 232 of file entry.h.
Referenced by addRelatedPage(), Entry(), and findMainPage().
|
private |
|
private |
parent node in the tree
Definition at line 264 of file entry.h.
Referenced by copyToSubEntry(), Entry(), Entry(), moveToSubEntryAndKeep(), moveToSubEntryAndRefresh(), and parent().
|
private |
Definition at line 265 of file entry.h.
Referenced by children(), copyToSubEntry(), copyToSubEntry(), Entry(), moveToSubEntryAndKeep(), moveToSubEntryAndKeep(), moveToSubEntryAndRefresh(), moveToSubEntryAndRefresh(), removeSubEntry(), reset(), and setFileDef().
QCString Entry::metaData |
Slice metadata.
Definition at line 233 of file entry.h.
Referenced by addClassToContext(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addVariableToClass(), addVariableToFile(), buildNamespaceList(), createUsingMemberImportForClass(), findEnums(), findMember(), findUsingDeclImports(), findUsingDirectives(), and reset().
int Entry::mGrpId |
member group id
Definition at line 219 of file entry.h.
Referenced by addConceptToContext(), addDefineDoc(), addEnumDocs(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addVariable(), addVariableToClass(), addVariableToFile(), buildFunctionList(), buildInterfaceAndServiceList(), DocGroup::close(), createUsingMemberImportForClass(), Entry(), Entry(), filterMemberDocumentation(), findEnums(), findMember(), findUsingDeclImports(), DocGroup::initGroupInfo(), DocGroup::open(), and reset().
MethodTypes Entry::mtype |
signal, slot, (dcop) method, or property?
Definition at line 181 of file entry.h.
Referenced by addMethodToClass(), addOverloaded(), addVariable(), addVariableToClass(), Entry(), findMember(), and reset().
QCString Entry::name |
member name
Definition at line 174 of file entry.h.
Referenced by addClassToContext(), addConceptToContext(), ModuleManager::addDocs(), addEnumDocs(), addEnumValuesToEnums(), addGlobalFunction(), addLocalObjCMethod(), addMemberDocs(), addPageToContext(), addRelatedPage(), addVariable(), addVariableToFile(), buildClassDocList(), buildClassList(), buildDictionaryList(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildInterfaceAndServiceList(), buildListOfUsingDecls(), buildNamespaceList(), buildPageList(), buildSequenceList(), buildTypedefList(), buildVarList(), VHDLOutlineParser::checkInlineCode(), computeClassRelations(), computePageRelations(), computeTemplateClassRelations(), endScope(), Entry(), extractClassName(), filterMemberDocumentation(), findBaseClassesForClass(), findClassEntries(), findClassRelation(), findDefineDocumentation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findGroupScope(), findMember(), findTemplateInstanceRelation(), findUsingDeclarations(), findUsingDeclImports(), findUsingDirectives(), isClassSection(), isVarWithConstructor(), makeTemplateInstanceRelation(), DocGroup::open(), organizeSubGroupsFiltered(), printNavTree(), and reset().
TextStream Entry::program |
Protection Entry::protection |
class protection
Definition at line 180 of file entry.h.
Referenced by addClassToContext(), addGlobalFunction(), addIncludeFile(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberFunction(), addMemberSpecialization(), addOverloaded(), addVariable(), addVariableToClass(), addVariableToFile(), applyModifiers(), buildFunctionList(), computeClassRelations(), createUsingMemberImportForClass(), Entry(), findEnums(), findMember(), findUsingDeclImports(), and reset().
bool Entry::proto |
prototype ?
Definition at line 187 of file entry.h.
Referenced by addDefineDoc(), addEnumDocs(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), buildFunctionList(), buildInterfaceAndServiceList(), buildTypedefList(), Entry(), findEnums(), findMember(), and reset().
std::vector<std::string> Entry::qualifiers |
qualifiers specified with the qualifier command
Definition at line 235 of file entry.h.
Referenced by addClassToContext(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addVariableToClass(), addVariableToFile(), buildFunctionList(), buildTypedefList(), createUsingMemberImportForClass(), Entry(), findEnums(), findMember(), findUsingDeclImports(), and reset().
QCString Entry::read |
property read accessor
Definition at line 211 of file entry.h.
Referenced by addVariableToClass(), and Entry().
QCString Entry::relates |
related class (doc block)
Definition at line 209 of file entry.h.
Referenced by addEnumValuesToEnums(), addVariable(), buildFunctionList(), buildInterfaceAndServiceList(), DocGroup::close(), Entry(), findEnums(), findMemberDocumentation(), DocGroup::initGroupInfo(), DocGroup::open(), and reset().
RelatesType Entry::relatesType |
how relates is handled
Definition at line 210 of file entry.h.
Referenced by addGlobalFunction(), addMethodToClass(), addVariable(), buildFunctionList(), buildInterfaceAndServiceList(), Entry(), Entry(), findEnums(), findGlobalMember(), findMember(), findMemberDocumentation(), and reset().
QCString Entry::req |
C++20 requires clause.
Definition at line 234 of file entry.h.
Referenced by addClassToContext(), addGlobalFunction(), addMemberDocs(), addMethodToClass(), buildFunctionList(), Entry(), findGlobalMember(), and reset().
EntryType Entry::section |
entry type (see Sections);
Definition at line 172 of file entry.h.
Referenced by addClassToContext(), addConceptToContext(), DocGroup::addDocs(), addEnumValuesToEnums(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMemberFunction(), addPageToContext(), addVariable(), buildClassDocList(), buildClassList(), buildConceptDocList(), buildConceptList(), buildDictionaryList(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildInterfaceAndServiceList(), buildListOfUsingDecls(), buildNamespaceList(), buildPageList(), buildSequenceList(), buildTypedefList(), buildVarList(), VHDLOutlineParser::checkInlineCode(), computePageRelations(), endScope(), Entry(), Entry(), filterMemberDocumentation(), findClassRelation(), findDefineDocumentation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findGlobalMember(), findGroupScope(), findMainPage(), findMainPageTagFiles(), findMember(), findMemberDocumentation(), findModuleDocumentation(), findUsingDeclarations(), findUsingDeclImports(), findUsingDirectives(), groupingPri(), isClassSection(), isVarWithConstructor(), markAsProcessed(), DocGroup::open(), organizeSubGroupsFiltered(), printNavTree(), and reset().
RefItemVector Entry::sli |
special lists (test/todo/bug/deprecated/..) this entry is in
Definition at line 226 of file entry.h.
Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), DocGroup::addDocs(), ModuleManager::addDocs(), addEnumDocs(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildFileList(), buildGroupListFiltered(), buildNamespaceList(), buildPageList(), buildTypedefList(), Entry(), findDirDocumentation(), findEnums(), findMember(), findUsingDirectives(), and reset().
TypeSpecifier Entry::spec |
class/member specifiers
Definition at line 182 of file entry.h.
Referenced by addClassToContext(), addEnumValuesToEnums(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addVariable(), addVariableToClass(), addVariableToFile(), applyModifiers(), buildFunctionList(), buildInterfaceAndServiceList(), buildNamespaceList(), endScope(), Entry(), filterMemberDocumentation(), findEnums(), findGlobalMember(), findMember(), findUsingDirectives(), printNavTree(), and reset().
int Entry::startColumn |
start column of entry in the source
Definition at line 225 of file entry.h.
Referenced by addClassToContext(), addConceptToContext(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addVariableToClass(), addVariableToFile(), buildFunctionList(), buildNamespaceList(), createUsingMemberImportForClass(), Entry(), findClassRelation(), findEnums(), findMember(), findTemplateInstanceRelation(), findUsingDeclImports(), findUsingDirectives(), and reset().
int Entry::startLine |
start line of entry in the source
Definition at line 224 of file entry.h.
Referenced by addClassToContext(), addClassToGroups(), ModuleDefImpl::addClassToModule(), addConceptToContext(), addConceptToGroups(), ModuleDefImpl::addConceptToModule(), addDefineDoc(), addDirToGroups(), ModuleManager::addDocs(), addExampleToGroups(), addGlobalFunction(), addGroupToGroups(), addIncludeFile(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberDocs(), addMemberFunction(), addMemberSpecialization(), addMemberToGroups(), ModuleDefImpl::addMemberToModule(), addMethodToClass(), addModuleToGroups(), addNamespaceToGroups(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildInterfaceAndServiceList(), buildNamespaceList(), VHDLOutlineParser::checkInlineCode(), computeClassRelations(), createUsingMemberImportForClass(), Entry(), findClassRelation(), findDefineDocumentation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findGlobalMember(), findMainPage(), findMember(), findTemplateInstanceRelation(), findUsingDeclarations(), findUsingDeclImports(), findUsingDirectives(), printNavTree(), reset(), and tryAddEnumDocsToGroupMember().
bool Entry::subGrouping |
automatically group class members?
Definition at line 188 of file entry.h.
Referenced by addClassToContext(), Entry(), and reset().
TagInfo Entry::tagInfoData |
ArgumentLists Entry::tArgLists |
template argument declarations
Definition at line 195 of file entry.h.
Referenced by addClassToContext(), addConceptToContext(), addGlobalFunction(), addMemberFunction(), addMethodToClass(), addOverloaded(), addVariableToClass(), addVariableToFile(), buildFunctionList(), buildInterfaceAndServiceList(), Entry(), findGlobalMember(), findMember(), findUsingDeclarations(), and reset().
QCString Entry::type |
member type
Definition at line 173 of file entry.h.
Referenced by addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addVariable(), applyModifiers(), buildDictionaryList(), buildFunctionList(), buildGroupListFiltered(), buildInterfaceAndServiceList(), buildNamespaceList(), buildSequenceList(), buildTypedefList(), buildVarList(), VHDLOutlineParser::checkInlineCode(), endScope(), Entry(), filterMemberDocumentation(), findGlobalMember(), isVarWithConstructor(), and reset().
ArgumentList Entry::typeConstr |
where clause (C#) for type constraints
Definition at line 215 of file entry.h.
Referenced by addClassToContext(), addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), Entry(), and reset().
VhdlSpecifier Entry::vhdlSpec |
VHDL specifiers.
Definition at line 183 of file entry.h.
Referenced by addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addVariableToClass(), addVariableToFile(), VHDLOutlineParser::checkInlineCode(), Entry(), findEnums(), findMember(), VhdlDocGen::isVhdlClass(), and reset().
Specifier Entry::virt |
virtualness of the entry
Definition at line 191 of file entry.h.
Referenced by addGlobalFunction(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberFunction(), addMemberSpecialization(), addOverloaded(), applyModifiers(), buildFunctionList(), createUsingMemberImportForClass(), Entry(), findMember(), findUsingDeclImports(), and reset().
QCString Entry::write |
property write accessor
Definition at line 212 of file entry.h.
Referenced by addVariableToClass(), and Entry().