The `Entry` Class Reference

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

Declaration

class Entry { ... }

Included Headers

Enumerations Index

enum	GroupDocType { ... }

Public Constructors Index

	Entry ()


	Entry (const Entry &)


	Entry (Entry &&)=delete

Public Destructor Index

	~Entry ()

Public Operators Index

Entry &	operator= (const Entry &)=delete


Entry &	operator= (Entry &&)=delete

Public Member Functions Index

Entry *	parent () const


const std::vector< std::shared_ptr< Entry > > &	children () const

add entry as a child, pass ownership and reinitialize entry Index

EntryType	section
	entry type (see Sections); More...

QCString	type
	member type More...

QCString	name
	member name More...

bool	hasTagInfo
	is tag info valid More...

TagInfo	tagInfoData
	tag file info data More...

Protection	protection
	class protection More...

MethodTypes	mtype
	signal, slot, (dcop) method, or property? More...

TypeSpecifier	spec
	class/member specifiers More...

VhdlSpecifier	vhdlSpec
	VHDL specifiers. More...

int	initLines
	define/variable initializer lines to show More...

bool	isStatic
	static ? More...

bool	explicitExternal
	explicitly defined as external? More...

bool	proto
	prototype ? More...

bool	subGrouping
	automatically group class members? More...

bool	exported
	is the symbol exported from a C++20 module More...

CommandOverrides	commandOverrides
	store info for commands whose default can be overridden More...

Specifier	virt
	virtualness of the entry More...

QCString	args
	member argument string More...

QCString	bitfields
	member's bit fields More...

ArgumentList	argList
	member arguments as a list More...

ArgumentLists	tArgLists
	template argument declarations More...

TextStream	program
	the program text More...

TextStream	initializer
	initial value (for variables) More...

QCString	includeFile
	include file (2 arg of \class, must be unique) More...

QCString	includeName
	include name (3 arg of \class) More...

QCString	doc
	documentation block (partly parsed) More...

int	docLine
	line number at which the documentation was found More...

QCString	docFile
	file in which the documentation was found More...

QCString	brief
	brief description (doc block) More...

int	briefLine
	line number at which the brief desc. was found More...

QCString	briefFile
	file in which the brief desc. was found More...

QCString	inbodyDocs
	documentation inside the body of a function More...

int	inbodyLine
	line number at which the body doc was found More...

QCString	inbodyFile
	file in which the body doc was found More...

QCString	relates
	related class (doc block) More...

RelatesType	relatesType
	how relates is handled More...

QCString	read
	property read accessor More...

QCString	write
	property write accessor More...

QCString	inside
	name of the class in which documents are found More...

QCString	exception
	throw specification More...

ArgumentList	typeConstr
	where clause (C#) for type constraints More...

int	bodyLine
	line number of the body in the source More...

int	bodyColumn
	column of the body in the source More...

int	endBodyLine
	line number where the definition ends More...

int	mGrpId
	member group id More...

std::vector< BaseInfo >	extends
	list of base classes More...

std::vector< Grouping >	groups
	list of groups this entry belongs to More...

std::vector< const SectionInfo * >	anchors
	list of anchors defined in this entry More...

QCString	fileName
	file this entry was extracted from More...

int	startLine
	start line of entry in the source More...

int	startColumn
	start column of entry in the source More...

RefItemVector	sli
	special lists (test/todo/bug/deprecated/..) this entry is in More...

SrcLangExt	lang
	programming language in which this entry was found More...

bool	hidden
	does this represent an entity that is hidden from the output More...

bool	artificial
	Artificially introduced item. More...

GroupDocType	groupDocType


QCString	id
	libclang id More...

LocalToc	localToc


QCString	metaData
	Slice metadata. More...

QCString	req
	C++20 requires clause. More...

std::vector< std::string >	qualifiers
	qualifiers specified with the qualifier command More...

Entry *	m_parent
	parent node in the tree More...

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 More...

Grouping::GroupPri_t	groupingPri () const

add entry as a child and pass ownership. Index

void	moveToSubEntryAndKeep (Entry *e)


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

Description

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

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

Definition at line 115 of file entry.h.

Enumerations

GroupDocType

enum Entry::GroupDocType

Enumeration values

GROUPDOC_NORMAL	defgroup
GROUPDOC_ADD	addtogroup
GROUPDOC_WEAK	weakgroup

Definition at line 119 of file entry.h.

120 {

121 GROUPDOC_NORMAL, //!< defgroup

122 GROUPDOC_ADD, //!< addtogroup

123 GROUPDOC_WEAK //!< weakgroup

124 }; //!< kind of group

Public Constructors

Entry()

Entry::Entry ()

Declaration at line 126 of file entry.h, definition at line 33 of file entry.cpp.

33Entry::Entry() : section(EntryType::makeEmpty()), program(static_cast<size_t>(0)), initializer(static_cast<size_t>(0))

34{

35 //printf("Entry::Entry(%p)\n",this);

36 g_num++;

37 m_parent=nullptr;

38 //printf("Entry::Entry() tArgList=0\n");

39 mGrpId = -1;

40 hasTagInfo = false;

41 relatesType = RelatesType::Simple;

42 hidden = FALSE;

43 groupDocType = GROUPDOC_NORMAL;

44 reset();

45}

References FALSE, g_num, GROUPDOC_NORMAL, groupDocType, hasTagInfo, hidden, initializer, m_parent, mGrpId, program, relatesType, reset and section.

Referenced by copyToSubEntry, Entry, Entry, markAsProcessed, moveToSubEntryAndKeep, moveToSubEntryAndRefresh, operator=, operator=, parent and removeSubEntry.

Entry()

Entry::Entry (const Entry & e)

Declaration at line 127 of file entry.h, definition at line 47 of file entry.cpp.

47Entry::Entry(const Entry &e) : section(e.section)

48{

49 //printf("Entry::Entry(%p):copy\n",this);

50 g_num++;

51 type = e.type;

52 name = e.name;

53 hasTagInfo = e.hasTagInfo;

54 tagInfoData = e.tagInfoData;

55 protection = e.protection;

56 mtype = e.mtype;

57 spec = e.spec;

58 vhdlSpec = e.vhdlSpec;

59 initLines = e.initLines;

60 isStatic = e.isStatic;

61 localToc = e.localToc;

62 explicitExternal = e.explicitExternal;

63 proto = e.proto;

64 subGrouping = e.subGrouping;

65 commandOverrides = e.commandOverrides;

66 exported = e.exported;

67 virt = e.virt;

68 args = e.args;

69 bitfields = e.bitfields;

70 argList = e.argList;

71 tArgLists = e.tArgLists;

72 program.str(e.program.str());

73 initializer.str(e.initializer.str());

74 includeFile = e.includeFile;

75 includeName = e.includeName;

76 doc = e.doc;

77 docLine = e.docLine;

78 docFile = e.docFile;

79 brief = e.brief;

80 briefLine = e.briefLine;

81 briefFile = e.briefFile;

82 inbodyDocs = e.inbodyDocs;

83 inbodyLine = e.inbodyLine;

84 inbodyFile = e.inbodyFile;

85 relates = e.relates;

86 relatesType = e.relatesType;

87 read = e.read;

88 write = e.write;

89 inside = e.inside;

90 exception = e.exception;

91 typeConstr = e.typeConstr;

92 bodyLine = e.bodyLine;

93 bodyColumn = e.bodyColumn;

94 endBodyLine = e.endBodyLine;

95 mGrpId = e.mGrpId;

96 anchors = e.anchors;

97 fileName = e.fileName;

98 startLine = e.startLine;

99 startColumn = e.startColumn;

100 sli = e.sli;

101 lang = e.lang;

102 hidden = e.hidden;

103 artificial = e.artificial;

104 groupDocType = e.groupDocType;

105 id = e.id;

106 extends = e.extends;

107 groups = e.groups;

108 req = e.req;

109 m_fileDef = e.m_fileDef;

110 qualifiers = e.qualifiers;

111

112 m_parent = e.m_parent;

113 // deep copy child entries

114 m_sublist.reserve(e.m_sublist.size());

115 for (const auto &cur : e.m_sublist)

116 {

117 m_sublist.push_back(std::make_shared<Entry>(*cur));

118 }

119}

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::Entry (Entry &&)

delete

Definition at line 129 of file entry.h.

Reference Entry.

Public Destructor

~Entry()

Entry::~Entry ()

Declaration at line 131 of file entry.h, definition at line 121 of file entry.cpp.

121Entry::~Entry()

122{

123 //printf("Entry::~Entry(%p) num=%d\n",this,g_num);

124 //printf("Deleting entry %d name %s type %x children %d\n",

125 // num,qPrint(name),section,sublist->count());

126

127 g_num--;

128}

Reference g_num.

Public Operators

operator=()

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

delete

Definition at line 128 of file entry.h.

Reference Entry.

operator=()

Entry & Entry::operator= (Entry &&)

delete

Definition at line 130 of file entry.h.

Reference Entry.

Public Member Functions

children()

const std::vector< std::shared_ptr< Entry > > & Entry::children ()

inline

Returns the list of children for this Entry

See Also: addSubEntry() and removeSubEntry()

Definition at line 139 of file entry.h.

139 const std::vector< std::shared_ptr<Entry> > &children() const { return m_sublist; }

Reference 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.

parent()

Entry * Entry::parent ()

inline

Returns the parent for this Entry or nullptr if this entry has no parent.

Definition at line 134 of file entry.h.

134 Entry *parent() const { return m_parent; }

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.

add entry as a child, pass ownership and reinitialize entry

anchors

std::vector<const SectionInfo*> Entry::anchors

list of anchors defined in this entry

Definition at line 222 of file entry.h.

222 std::vector<const SectionInfo*> anchors; //!< list of anchors defined in this entry

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.

argList

ArgumentList Entry::argList

member arguments as a list

Definition at line 194 of file entry.h.

194 ArgumentList argList; //!< member arguments as a list

Referenced by addGlobalFunction, addInterfaceOrServiceToServiceOrSingleton, addLocalObjCMethod, addMemberDocs, addMemberFunction, addMemberSpecialization, addMethodToClass, addOverloaded, addVariableToFile, buildFunctionList, Entry, findArgument, findGlobalMember, findMember, isVarWithConstructor and reset.

args

QCString Entry::args

member argument string

Definition at line 192 of file entry.h.

192 QCString args; //!< member argument string

Referenced by addGlobalFunction, addRelatedPage, addVariable, buildExampleList, buildFunctionList, buildInterfaceAndServiceList, buildPageList, Entry, filterMemberDocumentation, findDefineDocumentation, findEnums, findMainPage and reset.

artificial

bool Entry::artificial

Artificially introduced item.

Definition at line 229 of file entry.h.

229 bool artificial; //!< Artificially introduced item

Referenced by addClassToContext, addVariableToClass, buildNamespaceList, Entry and reset.

bitfields

QCString Entry::bitfields

member's bit fields

Definition at line 193 of file entry.h.

193 QCString bitfields; //!< member's bit fields

Referenced by addVariableToClass, Entry and reset.

bodyColumn

int Entry::bodyColumn

column of the body in the source

Definition at line 217 of file entry.h.

217 int bodyColumn; //!< column of the body in the source

Referenced by Entry and reset.

bodyLine

int Entry::bodyLine

line number of the body in the source

Definition at line 216 of file entry.h.

216 int bodyLine; //!< line number of the body in the source

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.

brief

QCString Entry::brief

brief description (doc block)

Definition at line 203 of file entry.h.

203 QCString brief; //!< brief description (doc block)

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.

briefFile

QCString Entry::briefFile

file in which the brief desc. was found

Definition at line 205 of file entry.h.

205 QCString briefFile; //!< file in which the brief desc. was found

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.

briefLine

int Entry::briefLine

line number at which the brief desc. was found

Definition at line 204 of file entry.h.

204 int briefLine; //!< line number at which the brief desc. was found

commandOverrides

CommandOverrides Entry::commandOverrides

store info for commands whose default can be overridden

Definition at line 190 of file entry.h.

190 CommandOverrides commandOverrides; //!< store info for commands whose default can be overridden

Referenced by addClassToContext, applyMemberOverrideOptions, buildFileList, buildGroupListFiltered, Entry, findDirDocumentation and reset.

copyToSubEntry

void Entry::copyToSubEntry (Entry * e)

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

Declaration at line 154 of file entry.h, definition at line 156 of file entry.cpp.

156void Entry::copyToSubEntry(Entry *current)

157{

158 Entry *copy = new Entry(*current);

159 copy->m_parent=this;

160 m_sublist.emplace_back(copy);

161}

References Entry, m_parent and m_sublist.

Referenced by VHDLOutlineParser::mapLibPackage.

copyToSubEntry

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

Declaration at line 155 of file entry.h, definition at line 163 of file entry.cpp.

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

164{

165 std::shared_ptr<Entry> copy = std::make_shared<Entry>(*current);

166 copy->m_parent=this;

167 m_sublist.push_back(copy);

168}

Reference m_sublist.

doc

QCString Entry::doc

documentation block (partly parsed)

Definition at line 200 of file entry.h.

200 QCString doc; //!< documentation block (partly parsed)

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.

docFile

QCString Entry::docFile

file in which the documentation was found

Definition at line 202 of file entry.h.

202 QCString docFile; //!< file in which the documentation was found

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.

docLine

int Entry::docLine

line number at which the documentation was found

Definition at line 201 of file entry.h.

201 int docLine; //!< line number at which the documentation was found

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.

endBodyLine

int Entry::endBodyLine

line number where the definition ends

Definition at line 218 of file entry.h.

218 int endBodyLine; //!< line number where the definition ends

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.

exception

QCString Entry::exception

throw specification

Definition at line 214 of file entry.h.

214 QCString exception; //!< throw specification

Referenced by addGlobalFunction, addMethodToClass, addVariableToClass, Entry, filterMemberDocumentation and reset.

explicitExternal

bool Entry::explicitExternal

explicitly defined as external?

Definition at line 186 of file entry.h.

186 bool explicitExternal; //!< explicitly defined as external?

Referenced by addGlobalFunction, addVariableToFile, Entry and reset.

exported

bool Entry::exported

is the symbol exported from a C++20 module

Definition at line 189 of file entry.h.

189 bool exported; //!< is the symbol exported from a C++20 module

Referenced by ModuleDefImpl::addClassToModule, ModuleDefImpl::addConceptToModule, ModuleDefImpl::addMemberToModule, ModuleManager::addMemberToModule, buildNamespaceList, Entry, findUsingDirectives and reset.

extends

std::vector<BaseInfo> Entry::extends

list of base classes

Definition at line 220 of file entry.h.

220 std::vector<BaseInfo> extends; //!< list of base classes

Referenced by computePageRelations, computeTemplateClassRelations, Entry, findBaseClassesForClass, isClassSection and reset.

fileDef

FileDef * Entry::fileDef ()

inline

Definition at line 169 of file entry.h.

169 FileDef *fileDef() const { return m_fileDef; }

Reference 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.

fileName

QCString Entry::fileName

file this entry was extracted from

Definition at line 223 of file entry.h.

223 QCString fileName; //!< file this entry was extracted from

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.

groupDocCmd

const char * Entry::groupDocCmd ()

inline

return the command name used to define GROUPDOC_SEC

Definition at line 238 of file entry.h.

238 const char *groupDocCmd() const

239 {

240 switch( groupDocType )

241 {

242 case GROUPDOC_NORMAL: return "\\defgroup";

243 case GROUPDOC_ADD: return "\\addtogroup";

244 case GROUPDOC_WEAK: return "\\weakgroup";

245 default: return "unknown group command";

246 }

247 }

References GROUPDOC_ADD, GROUPDOC_NORMAL, GROUPDOC_WEAK and groupDocType.

groupDocType

GroupDocType Entry::groupDocType

Definition at line 230 of file entry.h.

230 GroupDocType groupDocType;

Referenced by buildGroupListFiltered, Entry, Entry, groupDocCmd, groupingPri, organizeSubGroupsFiltered and reset.

groupingPri

Grouping::GroupPri_t Entry::groupingPri ()

inline

Definition at line 248 of file entry.h.

248 Grouping::GroupPri_t groupingPri() const

249 {

250 if( !section.isGroupDoc() )

251 {

252 return Grouping::GROUPING_LOWEST;

253 }

254 switch( groupDocType )

255 {

256 case GROUPDOC_NORMAL: return Grouping::GROUPING_AUTO_DEF;

257 case GROUPDOC_ADD: return Grouping::GROUPING_AUTO_ADD;

258 case GROUPDOC_WEAK: return Grouping::GROUPING_AUTO_WEAK;

259 default: return Grouping::GROUPING_LOWEST;

260 }

261 }

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.

groups

std::vector<Grouping> Entry::groups

list of groups this entry belongs to

Definition at line 221 of file entry.h.

221 std::vector<Grouping> groups; //!< list of groups this entry belongs to

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.

hasTagInfo

bool Entry::hasTagInfo

is tag info valid

Definition at line 175 of file entry.h.

175 bool hasTagInfo; //!< is tag info valid

Referenced by Entry, Entry and tagInfo.

hidden

bool Entry::hidden

does this represent an entity that is hidden from the output

Definition at line 228 of file entry.h.

228 bool hidden; //!< does this represent an entity that is hidden from the output

Referenced by addClassToContext, addConceptToContext, ModuleManager::addDocs, addVariableToClass, buildNamespaceList, Entry, Entry, findUsingDirectives and reset.

id

QCString Entry::id

libclang id

Definition at line 231 of file entry.h.

231 QCString id; //!< libclang id

Referenced by addClassToContext, addConceptToContext, ModuleManager::addDocs, addGlobalFunction, addLocalObjCMethod, addMemberSpecialization, addMethodToClass, addOverloaded, addVariableToClass, addVariableToFile, buildNamespaceList, createUsingMemberImportForClass, Entry, findEnums, findMember, findUsingDeclImports and findUsingDirectives.

inbodyDocs

QCString Entry::inbodyDocs

documentation inside the body of a function

Definition at line 206 of file entry.h.

206 QCString inbodyDocs; //!< documentation inside the body of a function

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.

inbodyFile

QCString Entry::inbodyFile

file in which the body doc was found

Definition at line 208 of file entry.h.

208 QCString inbodyFile; //!< file in which the body doc was found

Referenced by addDefineDoc, addEnumDocs, addGlobalFunction, addInterfaceOrServiceToServiceOrSingleton, addLocalObjCMethod, addMemberDocs, addMemberSpecialization, addMethodToClass, addOverloaded, addVariableToClass, addVariableToFile, buildFunctionList, buildGroupListFiltered, buildTypedefList, createUsingMemberImportForClass, Entry, findEnums, findMember, findUsingDeclImports and reset.

inbodyLine

int Entry::inbodyLine

line number at which the body doc was found

Definition at line 207 of file entry.h.

207 int inbodyLine; //!< line number at which the body doc was found

Referenced by addDefineDoc, addEnumDocs, addGlobalFunction, addInterfaceOrServiceToServiceOrSingleton, addLocalObjCMethod, addMemberDocs, addMemberSpecialization, addMethodToClass, addOverloaded, addVariableToClass, addVariableToFile, buildFunctionList, buildGroupListFiltered, buildTypedefList, createUsingMemberImportForClass, Entry, findEnums, findMember, findUsingDeclImports and reset.

includeFile

QCString Entry::includeFile

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

Definition at line 198 of file entry.h.

198 QCString includeFile; //!< include file (2 arg of \\class, must be unique)

Referenced by addIncludeFile, Entry and reset.

includeName

QCString Entry::includeName

include name (3 arg of \class)

Definition at line 199 of file entry.h.

199 QCString includeName; //!< include name (3 arg of \\class)

Referenced by addIncludeFile, Entry and reset.

initializer

TextStream Entry::initializer

initial value (for variables)

Definition at line 197 of file entry.h.

197 TextStream initializer; //!< initial value (for variables)

Referenced by addConceptToContext, addMemberDocs, addVariableToClass, addVariableToFile, Entry, Entry and reset.

initLines

int Entry::initLines

define/variable initializer lines to show

Definition at line 184 of file entry.h.

184 int initLines; //!< define/variable initializer lines to show

Referenced by addDefineDoc, addMemberDocs, addVariableToClass, addVariableToFile, Entry and reset.

inside

QCString Entry::inside

name of the class in which documents are found

Definition at line 213 of file entry.h.

213 QCString inside; //!< name of the class in which documents are found

Referenced by Entry, filterMemberDocumentation and reset.

isStatic

bool Entry::isStatic

static ?

Definition at line 185 of file entry.h.

185 bool isStatic; //!< static ?

Referenced by addClassToContext, addGlobalFunction, addInterfaceOrServiceToServiceOrSingleton, addLocalObjCMethod, addMemberFunction, addMemberSpecialization, addOverloaded, addVariableToClass, addVariableToFile, applyModifiers, buildFunctionList, Entry, findMember and reset.

lang

SrcLangExt Entry::lang

programming language in which this entry was found

Definition at line 227 of file entry.h.

227 SrcLangExt lang; //!< programming language in which this entry was found

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, makeTemplateInstanceRelation and reset.

localToc

LocalToc Entry::localToc

Definition at line 232 of file entry.h.

232 LocalToc localToc;

Referenced by addRelatedPage, Entry and findMainPage.

m_fileDef

FileDef* Entry::m_fileDef

Definition at line 266 of file entry.h.

266 FileDef *m_fileDef;

Referenced by Entry, fileDef, reset and setFileDef.

m_parent

Entry* Entry::m_parent

parent node in the tree

Definition at line 264 of file entry.h.

264 Entry *m_parent; //!< parent node in the tree

Referenced by copyToSubEntry, Entry, Entry, moveToSubEntryAndKeep, moveToSubEntryAndRefresh and parent.

m_sublist

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

Definition at line 265 of file entry.h.

265 std::vector< std::shared_ptr<Entry> > m_sublist;

Referenced by children, copyToSubEntry, copyToSubEntry, Entry, moveToSubEntryAndKeep, moveToSubEntryAndKeep, moveToSubEntryAndRefresh, moveToSubEntryAndRefresh, removeSubEntry, reset and setFileDef.

markAsProcessed

void Entry::markAsProcessed ()

inline

Definition at line 167 of file entry.h.

167 void markAsProcessed() const { (const_cast<Entry*>(this))->section = EntryType::makeEmpty(); }

References Entry and section.

Referenced by addGlobalFunction, addInterfaceOrServiceToServiceOrSingleton, addMethodToClass, addVariableToClass, addVariableToFile and buildTypedefList.

metaData

QCString Entry::metaData

Slice metadata.

Definition at line 233 of file entry.h.

233 QCString metaData; //!< Slice metadata

Referenced by addClassToContext, addGlobalFunction, addInterfaceOrServiceToServiceOrSingleton, addLocalObjCMethod, addMemberSpecialization, addMethodToClass, addOverloaded, addVariableToClass, addVariableToFile, buildNamespaceList, createUsingMemberImportForClass, findEnums, findMember, findUsingDeclImports, findUsingDirectives and reset.

mGrpId

int Entry::mGrpId

member group id

Definition at line 219 of file entry.h.

219 int mGrpId; //!< member group id

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.

moveToSubEntryAndRefresh

void Entry::moveToSubEntryAndRefresh (Entry *& e)

Declaration at line 150 of file entry.h, definition at line 130 of file entry.cpp.

130void Entry::moveToSubEntryAndRefresh(Entry *&current)

131{

132 current->m_parent=this;

133 m_sublist.emplace_back(current);

134 current = new Entry;

135}

References Entry, m_parent and m_sublist.

moveToSubEntryAndRefresh

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

Declaration at line 151 of file entry.h, definition at line 137 of file entry.cpp.

137void Entry::moveToSubEntryAndRefresh(std::shared_ptr<Entry> &current)

138{

139 current->m_parent=this;

140 m_sublist.push_back(current);

141 current = std::make_shared<Entry>();

142}

Reference m_sublist.

mtype

MethodTypes Entry::mtype

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

Definition at line 181 of file entry.h.

181 MethodTypes mtype; //!< signal, slot, (dcop) method, or property?

Referenced by addMethodToClass, addOverloaded, addVariable, addVariableToClass, Entry, findMember and reset.

name

QCString Entry::name

member name

Definition at line 174 of file entry.h.

174 QCString name; //!< member name

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.

program

TextStream Entry::program

the program text

Definition at line 196 of file entry.h.

196 TextStream program; //!< the program text

Referenced by Entry, Entry and reset.

protection

Protection Entry::protection

class protection

Definition at line 180 of file entry.h.

180 Protection protection; //!< class protection

Referenced by addClassToContext, addGlobalFunction, addIncludeFile, addInterfaceOrServiceToServiceOrSingleton, addLocalObjCMethod, addMemberFunction, addMemberSpecialization, addOverloaded, addVariable, addVariableToClass, addVariableToFile, applyModifiers, buildFunctionList, computeClassRelations, createUsingMemberImportForClass, Entry, findEnums, findMember, findUsingDeclImports and reset.

proto

bool Entry::proto

prototype ?

Definition at line 187 of file entry.h.

187 bool proto; //!< prototype ?

Referenced by addDefineDoc, addEnumDocs, addGlobalFunction, addInterfaceOrServiceToServiceOrSingleton, addLocalObjCMethod, addMemberDocs, addMemberSpecialization, addMethodToClass, addOverloaded, buildFunctionList, buildInterfaceAndServiceList, buildTypedefList, Entry, findEnums, findMember and reset.

qualifiers

std::vector<std::string> Entry::qualifiers

qualifiers specified with the qualifier command

Definition at line 235 of file entry.h.

235 std::vector<std::string> qualifiers; //!< qualifiers specified with the qualifier command

Referenced by addClassToContext, addGlobalFunction, addInterfaceOrServiceToServiceOrSingleton, addLocalObjCMethod, addMemberDocs, addMemberSpecialization, addMethodToClass, addOverloaded, addVariableToClass, addVariableToFile, buildFunctionList, buildTypedefList, createUsingMemberImportForClass, Entry, findEnums, findMember, findUsingDeclImports and reset.

read

QCString Entry::read

property read accessor

Definition at line 211 of file entry.h.

211 QCString read; //!< property read accessor

Referenced by addVariableToClass and Entry.

relates

QCString Entry::relates

related class (doc block)

Definition at line 209 of file entry.h.

209 QCString relates; //!< related class (doc block)

Referenced by addEnumValuesToEnums, addVariable, buildFunctionList, buildInterfaceAndServiceList, DocGroup::close, Entry, findEnums, findMemberDocumentation, DocGroup::initGroupInfo, DocGroup::open and reset.

relatesType

RelatesType Entry::relatesType

how relates is handled

Definition at line 210 of file entry.h.

210 RelatesType relatesType; //!< how relates is handled

Referenced by addGlobalFunction, addMethodToClass, addVariable, buildFunctionList, buildInterfaceAndServiceList, Entry, Entry, findEnums, findGlobalMember, findMember, findMemberDocumentation and reset.

removeSubEntry

void Entry::removeSubEntry (const Entry * e)

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

Declaration at line 160 of file entry.h, definition at line 170 of file entry.cpp.

170void Entry::removeSubEntry(const Entry *e)

171{

172 auto it = std::find_if(m_sublist.begin(),m_sublist.end(),

173 [e](const std::shared_ptr<Entry>&elem) { return elem.get()==e; });

174 if (it!=m_sublist.end())

175 {

176 m_sublist.erase(it);

177 }

178}

References Entry and m_sublist.

Referenced by endScope.

req

QCString Entry::req

C++20 requires clause.

Definition at line 234 of file entry.h.

234 QCString req; //!< C++20 requires clause

Referenced by addClassToContext, addGlobalFunction, addMemberDocs, addMethodToClass, buildFunctionList, Entry, findGlobalMember and reset.

reset

void Entry::reset ()

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

Declaration at line 165 of file entry.h, definition at line 181 of file entry.cpp.

181void Entry::reset()

182{

183 //printf("Entry::reset()\n");

184 name.clear();

185 type.clear();

186 args.clear();

187 bitfields.clear();

188 exception.clear();

189 program.str(std::string());

190 includeFile.clear();

191 includeName.clear();

192 doc.clear();

193 docFile.clear();

194 docLine=-1;

195 relates.clear();

196 relatesType=RelatesType::Simple;

197 brief.clear();

198 briefFile.clear();

199 briefLine=-1;

200 inbodyDocs.clear();

201 inbodyFile.clear();

202 inbodyLine=-1;

203 inside.clear();

204 fileName.clear();

205 initializer.str(std::string());

206 initLines = -1;

207 startLine = 1;

208 startColumn = 1;

209 bodyLine = -1;

210 bodyColumn = 1;

211 endBodyLine = -1;

212 mGrpId = -1;

213 commandOverrides.reset();

214 exported = false;

215 section = EntryType::makeEmpty();

216 mtype = MethodTypes::Method;

217 virt = Specifier::Normal;

218 isStatic = false;

219 proto = false;

220 explicitExternal = false;

221 spec.reset();

222 vhdlSpec = VhdlSpecifier::UNKNOWN;

223 lang = SrcLangExt::Unknown;

224 hidden = false;

225 artificial = false;

226 subGrouping = true;

227 protection = Protection::Public;

228 groupDocType = GROUPDOC_NORMAL;

229 id.clear();

230 metaData.clear();

231 m_sublist.clear();

232 extends.clear();

233 groups.clear();

234 anchors.clear();

235 argList.reset();

236 tArgLists.clear();

237 typeConstr.reset();

238 sli.clear();

239 req.clear();

240 m_fileDef = nullptr;

241 qualifiers.clear();

242}

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, mGrpId, mtype, name, program, protection, proto, qualifiers, relates, relatesType, req, section, sli, spec, startColumn, startLine, subGrouping, tArgLists, type, typeConstr, UNKNOWN, vhdlSpec and virt.

Referenced by Entry.

section

EntryType Entry::section

entry type (see Sections);

Definition at line 172 of file entry.h.

172 EntryType section; //!< entry type (see Sections);

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.

setFileDef

void Entry::setFileDef (FileDef * fd)

Declaration at line 168 of file entry.h, definition at line 244 of file entry.cpp.

244void Entry::setFileDef(FileDef *fd)

245{

246 m_fileDef = fd;

247 for (const auto &childNode : m_sublist)

248 {

249 childNode->setFileDef(fd);

250 }

251}

References m_fileDef and m_sublist.

sli

RefItemVector Entry::sli

special lists (test/todo/bug/deprecated/..) this entry is in

Definition at line 226 of file entry.h.

226 RefItemVector sli; //!< special lists (test/todo/bug/deprecated/..) this entry is in

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.

spec

TypeSpecifier Entry::spec

class/member specifiers

Definition at line 182 of file entry.h.

182 TypeSpecifier spec; //!< class/member specifiers

Referenced by addClassToContext, addEnumValuesToEnums, addGlobalFunction, addInterfaceOrServiceToServiceOrSingleton, addVariable, addVariableToClass, addVariableToFile, applyModifiers, buildFunctionList, buildInterfaceAndServiceList, buildNamespaceList, endScope, Entry, filterMemberDocumentation, findEnums, findGlobalMember, findMember, findUsingDirectives, printNavTree and reset.

startColumn

int Entry::startColumn

start column of entry in the source

Definition at line 225 of file entry.h.

225 int startColumn; //!< start column of entry in the source

Referenced by addClassToContext, addConceptToContext, addGlobalFunction, addInterfaceOrServiceToServiceOrSingleton, addLocalObjCMethod, addMemberSpecialization, addMethodToClass, addOverloaded, addVariableToClass, addVariableToFile, buildFunctionList, buildNamespaceList, createUsingMemberImportForClass, Entry, findClassRelation, findEnums, findMember, findTemplateInstanceRelation, findUsingDeclImports, findUsingDirectives and reset.

startLine

int Entry::startLine

start line of entry in the source

Definition at line 224 of file entry.h.

224 int startLine; //!< start line of entry in the source

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.

subGrouping

bool Entry::subGrouping

automatically group class members?

Definition at line 188 of file entry.h.

188 bool subGrouping; //!< automatically group class members?

Referenced by addClassToContext, Entry and reset.

tagInfo

const TagInfo * Entry::tagInfo ()

inline

Definition at line 177 of file entry.h.

177 const TagInfo *tagInfo() const { return hasTagInfo ? &tagInfoData : nullptr; }

References hasTagInfo and tagInfoData.

tagInfoData

TagInfo Entry::tagInfoData

tag file info data

Definition at line 176 of file entry.h.

176 TagInfo tagInfoData; //!< tag file info data

Referenced by Entry and tagInfo.

tArgLists

ArgumentLists Entry::tArgLists

template argument declarations

Definition at line 195 of file entry.h.

195 ArgumentLists tArgLists; //!< template argument declarations

Referenced by addClassToContext, addConceptToContext, addGlobalFunction, addMemberFunction, addMethodToClass, addOverloaded, addVariableToClass, addVariableToFile, buildFunctionList, buildInterfaceAndServiceList, Entry, findGlobalMember, findMember, findUsingDeclarations and reset.

type

QCString Entry::type

member type

Definition at line 173 of file entry.h.

173 QCString type; //!< member type

Referenced by addGlobalFunction, addInterfaceOrServiceToServiceOrSingleton, addVariable, applyModifiers, buildDictionaryList, buildFunctionList, buildGroupListFiltered, buildInterfaceAndServiceList, buildNamespaceList, buildSequenceList, buildTypedefList, buildVarList, VHDLOutlineParser::checkInlineCode, endScope, Entry, filterMemberDocumentation, findGlobalMember, isVarWithConstructor and reset.

typeConstr

ArgumentList Entry::typeConstr

where clause (C#) for type constraints

Definition at line 215 of file entry.h.

215 ArgumentList typeConstr; //!< where clause (C#) for type constraints

Referenced by addClassToContext, addGlobalFunction, addInterfaceOrServiceToServiceOrSingleton, addMemberSpecialization, addMethodToClass, addOverloaded, Entry and reset.

vhdlSpec

VhdlSpecifier Entry::vhdlSpec

VHDL specifiers.

Definition at line 183 of file entry.h.

183 VhdlSpecifier vhdlSpec; //!< VHDL specifiers

Referenced by addGlobalFunction, addInterfaceOrServiceToServiceOrSingleton, addLocalObjCMethod, addMemberSpecialization, addMethodToClass, addOverloaded, addVariableToClass, addVariableToFile, VHDLOutlineParser::checkInlineCode, Entry, findEnums, findMember, VhdlDocGen::isVhdlClass and reset.

virt

Specifier Entry::virt

virtualness of the entry

Definition at line 191 of file entry.h.

191 Specifier virt; //!< virtualness of the entry

Referenced by addGlobalFunction, addInterfaceOrServiceToServiceOrSingleton, addLocalObjCMethod, addMemberFunction, addMemberSpecialization, addOverloaded, applyModifiers, buildFunctionList, createUsingMemberImportForClass, Entry, findMember, findUsingDeclImports and reset.

write

QCString Entry::write

property write accessor

Definition at line 212 of file entry.h.

212 QCString write; //!< property write accessor

Referenced by addVariableToClass and Entry.

add entry as a child and pass ownership.

info

This makes the entry passed invalid!

moveToSubEntryAndKeep

void Entry::moveToSubEntryAndKeep (Entry * e)

Declaration at line 145 of file entry.h, definition at line 144 of file entry.cpp.

144void Entry::moveToSubEntryAndKeep(Entry *current)

145{

146 current->m_parent=this;

147 m_sublist.emplace_back(current);

148}

References Entry, m_parent and m_sublist.

Referenced by initUCF.

moveToSubEntryAndKeep

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

Declaration at line 146 of file entry.h, definition at line 150 of file entry.cpp.

150void Entry::moveToSubEntryAndKeep(std::shared_ptr<Entry> current)

151{

152 current->m_parent=this;

153 m_sublist.push_back(current);

154}

Reference m_sublist.

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

Generated via doxygen2docusaurus by Doxygen 1.14.0.

Declaration​

Included Headers​

Enumerations Index​

Public Constructors Index​

Public Destructor Index​

Public Operators Index​

Public Member Functions Index​

add entry as a child, pass ownership and reinitialize entry Index​

add entry as a child and pass ownership. Index​

Description​

Enumerations​

GroupDocType​

Public Constructors​

Entry()​

Entry()​

Entry()​

Public Destructor​

~Entry()​

Public Operators​

operator=()​

operator=()​

Public Member Functions​

children()​

parent()​

add entry as a child, pass ownership and reinitialize entry​

anchors​

argList​

args​

artificial​

bitfields​

bodyColumn​

bodyLine​

brief​

briefFile​

briefLine​

commandOverrides​

copyToSubEntry​

copyToSubEntry​

doc​

docFile​

docLine​

endBodyLine​

exception​

explicitExternal​

exported​

extends​

fileDef​

fileName​

groupDocCmd​

groupDocType​

groupingPri​

groups​

hasTagInfo​

hidden​

id​

inbodyDocs​

inbodyFile​

inbodyLine​

includeFile​

includeName​

initializer​

initLines​

inside​

isStatic​

lang​

localToc​

m_fileDef​

m_parent​

m_sublist​

markAsProcessed​

metaData​

mGrpId​

moveToSubEntryAndRefresh​

moveToSubEntryAndRefresh​

mtype​

name​

program​

protection​

proto​

qualifiers​

Declaration

Included Headers

Enumerations Index

Public Constructors Index

Public Destructor Index

Public Operators Index

Public Member Functions Index

add entry as a child, pass ownership and reinitialize entry Index

add entry as a child and pass ownership. Index

Description

Enumerations

GroupDocType

Public Constructors

Entry()

Entry()

Entry()

Public Destructor

~Entry()

Public Operators

operator=()

operator=()

Public Member Functions

children()

parent()

add entry as a child, pass ownership and reinitialize entry

anchors

argList

args

artificial

bitfields

bodyColumn

bodyLine

brief

briefFile

briefLine

commandOverrides

copyToSubEntry

copyToSubEntry

doc

docFile

docLine

endBodyLine

exception

explicitExternal

exported

extends

fileDef

fileName

groupDocCmd

groupDocType

groupingPri

groups

hasTagInfo

hidden

id

inbodyDocs

inbodyFile

inbodyLine

includeFile

includeName

initializer

initLines

inside

isStatic

lang

localToc

m_fileDef

m_parent

m_sublist

markAsProcessed

metaData

mGrpId

moveToSubEntryAndRefresh

moveToSubEntryAndRefresh

mtype

name

program

protection

proto

qualifiers