Entry Class Reference

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

#include <src/entry.h>

Collaboration diagram for Entry:

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.
Note This makes the entry passed invalid!
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

Detailed 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 114 of file entry.h.

Member Enumeration Documentation

GroupDocType

enum Entry::GroupDocType

Enumerator
GROUPDOC_NORMAL	defgroup
GROUPDOC_ADD	addtogroup
GROUPDOC_WEAK	weakgroup

Definition at line 118 of file entry.h.

    {
      GROUPDOC_NORMAL,        //!< defgroup
      GROUPDOC_ADD,           //!< addtogroup
      GROUPDOC_WEAK           //!< weakgroup
    };                        //!< kind of group

Constructor & Destructor Documentation

Entry() [1/3]

Entry::Entry

(

)

Definition at line 33 of file entry.cpp.

             : section(EntryType::makeEmpty()), program(static_cast<size_t>(0)), initializer(static_cast<size_t>(0))
{
  //printf("Entry::Entry(%p)\n",this);
  g_num++;
  m_parent=nullptr;
  //printf("Entry::Entry() tArgList=0\n");
  mGrpId = -1;
  hasTagInfo = false;
  relatesType = RelatesType::Simple;
  hidden = FALSE;
  groupDocType = GROUPDOC_NORMAL;
  reset();
}

References FALSE, g_num, GROUPDOC_NORMAL, groupDocType, hasTagInfo, hidden, m_parent, mGrpId, relatesType, reset(), and Simple.

Referenced by copyToSubEntry(), and moveToSubEntryAndRefresh().

Entry() [2/3]

Entry::Entry

(

const Entry &

e

)

Definition at line 47 of file entry.cpp.

                           : section(e.section)
{
  //printf("Entry::Entry(%p):copy\n",this);
  g_num++;
  type        = e.type;
  name        = e.name;
  hasTagInfo  = e.hasTagInfo;
  tagInfoData = e.tagInfoData;
  protection  = e.protection;
  mtype       = e.mtype;
  spec        = e.spec;
  vhdlSpec    = e.vhdlSpec;
  initLines   = e.initLines;
  isStatic    = e.isStatic;
  localToc    = e.localToc;
  explicitExternal = e.explicitExternal;
  proto       = e.proto;
  subGrouping = e.subGrouping;
  commandOverrides = e.commandOverrides;
  exported    = e.exported;
  virt        = e.virt;
  args        = e.args;
  bitfields   = e.bitfields;
  argList     = e.argList;
  tArgLists   = e.tArgLists;
  program.str(e.program.str());
  initializer.str(e.initializer.str());
  includeFile = e.includeFile;
  includeName = e.includeName;
  doc         = e.doc;
  docLine     = e.docLine;
  docFile     = e.docFile;
  brief       = e.brief;
  briefLine   = e.briefLine;
  briefFile   = e.briefFile;
  inbodyDocs  = e.inbodyDocs;
  inbodyLine  = e.inbodyLine;
  inbodyFile  = e.inbodyFile;
  relates     = e.relates;
  relatesType = e.relatesType;
  read        = e.read;
  write       = e.write;
  inside      = e.inside;
  exception   = e.exception;
  typeConstr  = e.typeConstr;
  bodyLine    = e.bodyLine;
  bodyColumn  = e.bodyColumn;
  endBodyLine = e.endBodyLine;
  mGrpId      = e.mGrpId;
  anchors     = e.anchors;
  fileName    = e.fileName;
  startLine   = e.startLine;
  startColumn = e.startColumn;
  sli         = e.sli;
  lang        = e.lang;
  hidden      = e.hidden;
  artificial  = e.artificial;
  groupDocType = e.groupDocType;
  id          = e.id;
  extends     = e.extends;
  groups      = e.groups;
  req         = e.req;
  m_fileDef   = e.m_fileDef;
  qualifiers  = e.qualifiers;
 
  m_parent    = e.m_parent;
  // deep copy child entries
  m_sublist.reserve(e.m_sublist.size());
  for (const auto &cur : e.m_sublist)
  {
    m_sublist.push_back(std::make_shared<Entry>(*cur));
  }
}

References anchors, argList, args, artificial, bitfields, bodyColumn, bodyLine, brief, briefFile, briefLine, commandOverrides, doc, docFile, docLine, endBodyLine, 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, sli, spec, startColumn, startLine, TextStream::str(), subGrouping, tagInfoData, tArgLists, type, typeConstr, vhdlSpec, virt, and write.

Entry() [3/3]

Entry::Entry ( Entry && )

delete

~Entry()

Entry::~Entry

(

)

Definition at line 121 of file entry.cpp.

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

References g_num.

Member Function Documentation

children()

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

inline

Returns the list of children for this Entry

See also

addSubEntry() and removeSubEntry()

Definition at line 138 of file entry.h.

{ return m_sublist; }

References m_sublist.

Referenced by addEnumValuesToEnums(), buildClassDocList(), buildClassList(), buildConceptDocList(), buildConceptList(), buildExampleList(), buildFileList(), buildGroupListFiltered(), buildListOfUsingDecls(), buildNamespaceList(), buildPageList(), computePageRelations(), endScope(), findClassEntries(), findDefineDocumentation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findGroupScope(), findMainPage(), findMainPageTagFiles(), findMemberDocumentation(), findModuleDocumentation(), findObjCMethodDefinitions(), findUsingDeclarations(), findUsingDeclImports(), findUsingDirectives(), VHDLOutlineParser::mapLibPackage(), organizeSubGroupsFiltered(), printNavTree(), resolveModuleProcedures(), and resolveTypeBoundProcedures().

copyToSubEntry() [1/2]

void Entry::copyToSubEntry

(

const std::shared_ptr< Entry > &

e

)

Definition at line 163 of file entry.cpp.

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

References m_sublist.

copyToSubEntry() [2/2]

void Entry::copyToSubEntry

(

Entry *

e

)

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

Definition at line 156 of file entry.cpp.

{
  Entry *copy = new Entry(*current);
  copy->m_parent=this;
  m_sublist.emplace_back(copy);
}

References Entry(), m_parent, and m_sublist.

Referenced by VHDLOutlineParser::mapLibPackage().

fileDef()

FileDef * Entry::fileDef ( ) const

inline

Definition at line 168 of file entry.h.

{ return m_fileDef; }

References m_fileDef.

Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), addEnumValuesToEnums(), addLocalObjCMethod(), addMemberDocs(), addMemberFunction(), addMemberSpecialization(), addOverloaded(), addVariableToClass(), addVariableToFile(), buildNamespaceList(), findClassRelation(), findDefineDocumentation(), findEnumDocumentation(), findEnums(), findGlobalMember(), findMember(), findUsingDeclarations(), findUsingDirectives(), and isVarWithConstructor().

groupDocCmd()

const char * Entry::groupDocCmd ( ) const

inline

return the command name used to define GROUPDOC_SEC

Definition at line 237 of file entry.h.

    {
      switch( groupDocType )
      {
        case GROUPDOC_NORMAL: return "\\defgroup";
        case GROUPDOC_ADD: return "\\addtogroup";
        case GROUPDOC_WEAK: return "\\weakgroup";
        default: return "unknown group command";
      }
    }

References GROUPDOC_ADD, GROUPDOC_NORMAL, GROUPDOC_WEAK, and groupDocType.

groupingPri()

Grouping::GroupPri_t Entry::groupingPri ( ) const

inline

Definition at line 247 of file entry.h.

    {
      if( !section.isGroupDoc() )
      {
        return Grouping::GROUPING_LOWEST;
      }
      switch( groupDocType )
      {
        case GROUPDOC_NORMAL: return Grouping::GROUPING_AUTO_DEF;
        case GROUPDOC_ADD:    return Grouping::GROUPING_AUTO_ADD;
        case GROUPDOC_WEAK:   return Grouping::GROUPING_AUTO_WEAK;
        default: return Grouping::GROUPING_LOWEST;
      }
    }

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().

markAsProcessed()

void Entry::markAsProcessed ( ) const

inline

Definition at line 166 of file entry.h.

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

Referenced by addVariableToClass(), and addVariableToFile().

moveToSubEntryAndKeep() [1/2]

void Entry::moveToSubEntryAndKeep

(

Entry *

e

)

Definition at line 144 of file entry.cpp.

{
  current->m_parent=this;
  m_sublist.emplace_back(current);
}

References m_parent, and m_sublist.

Referenced by initUCF().

moveToSubEntryAndKeep() [2/2]

void Entry::moveToSubEntryAndKeep

(

std::shared_ptr< Entry >

e

)

Definition at line 150 of file entry.cpp.

{
  current->m_parent=this;
  m_sublist.push_back(current);
}

References m_parent, and m_sublist.

moveToSubEntryAndRefresh() [1/2]

void Entry::moveToSubEntryAndRefresh

(

Entry *&

e

)

Definition at line 130 of file entry.cpp.

{
  current->m_parent=this;
  m_sublist.emplace_back(current);
  current = new Entry;
}

References Entry(), m_parent, and m_sublist.

moveToSubEntryAndRefresh() [2/2]

void Entry::moveToSubEntryAndRefresh

(

std::shared_ptr< Entry > &

e

)

Definition at line 137 of file entry.cpp.

{
  current->m_parent=this;
  m_sublist.push_back(current);
  current = std::make_shared<Entry>();
}

References m_parent, and m_sublist.

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

parent()

Entry * Entry::parent ( ) const

inline

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

Definition at line 133 of file entry.h.

{ return m_parent; }

References m_parent.

Referenced by addClassToContext(), addConceptToContext(), addEnumDocs(), addEnumValuesToEnums(), addMemberDocs(), addMemberFunction(), addPageToContext(), buildListOfUsingDecls(), endScope(), findClassRelation(), findDefineDocumentation(), findEnumDocumentation(), findEnums(), findGroupScope(), findMember(), findUsingDeclarations(), findUsingDeclImports(), findUsingDirectives(), and isVarWithConstructor().

removeSubEntry()

void Entry::removeSubEntry

(

const Entry *

e

)

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

Definition at line 170 of file entry.cpp.

{
  auto it = std::find_if(m_sublist.begin(),m_sublist.end(),
      [e](const std::shared_ptr<Entry>&elem) { return elem.get()==e; });
  if (it!=m_sublist.end())
  {
    m_sublist.erase(it);
  }
}

References m_sublist.

Referenced by endScope().

reset()

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.

{
  //printf("Entry::reset()\n");
  name.clear();
  type.clear();
  args.clear();
  bitfields.clear();
  exception.clear();
  program.str(std::string());
  includeFile.clear();
  includeName.clear();
  doc.clear();
  docFile.clear();
  docLine=-1;
  relates.clear();
  relatesType=RelatesType::Simple;
  brief.clear();
  briefFile.clear();
  briefLine=-1;
  inbodyDocs.clear();
  inbodyFile.clear();
  inbodyLine=-1;
  inside.clear();
  fileName.clear();
  initializer.str(std::string());
  initLines = -1;
  startLine = 1;
  startColumn = 1;
  bodyLine = -1;
  bodyColumn = 1;
  endBodyLine = -1;
  mGrpId = -1;
  commandOverrides.reset();
  exported = false;
  section = EntryType::makeEmpty();
  mtype   = MethodTypes::Method;
  virt    = Specifier::Normal;
  isStatic = false;
  proto   = false;
  explicitExternal = false;
  spec.reset();
  vhdlSpec = VhdlSpecifier::UNKNOWN;
  lang = SrcLangExt::Unknown;
  hidden = false;
  artificial = false;
  subGrouping = true;
  protection = Protection::Public;
  groupDocType = GROUPDOC_NORMAL;
  id.clear();
  metaData.clear();
  m_sublist.clear();
  extends.clear();
  groups.clear();
  anchors.clear();
  argList.reset();
  tArgLists.clear();
  typeConstr.reset();
  sli.clear();
  req.clear();
  m_fileDef = nullptr;
  qualifiers.clear();
}

References anchors, argList, args, artificial, bitfields, bodyColumn, bodyLine, brief, briefFile, briefLine, QCString::clear(), 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, ArgumentList::reset(), CommandOverrides::reset(), TypeSpecifier::reset(), section, Simple, sli, spec, startColumn, startLine, TextStream::str(), subGrouping, tArgLists, type, typeConstr, Unknown, UNKNOWN, vhdlSpec, and virt.

Referenced by Entry().

setFileDef()

void Entry::setFileDef

(

FileDef *

fd

)

Definition at line 244 of file entry.cpp.

{
  m_fileDef = fd;
  for (const auto &childNode : m_sublist)
  {
      childNode->setFileDef(fd);
  }
}

References m_fileDef, and m_sublist.

tagInfo()

const TagInfo * Entry::tagInfo ( ) const

inline

Definition at line 176 of file entry.h.

{ return hasTagInfo ? &tagInfoData : nullptr; }

References hasTagInfo, and tagInfoData.

Referenced by addClassToContext(), addConceptToContext(), addEnumValuesToEnums(), addLocalObjCMethod(), addMemberSpecialization(), addOverloaded(), addPageToContext(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildFileList(), buildGroupListFiltered(), buildNamespaceList(), findClassRelation(), findDefineDocumentation(), findEnums(), findGroupScope(), findMainPage(), findMainPageTagFiles(), findMember(), and findUsingDeclImports().

Member Data Documentation

anchors

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

list of anchors defined in this entry

Definition at line 221 of file entry.h.

Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), addEnumDocs(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildGroupListFiltered(), buildNamespaceList(), Entry(), findEnums(), findMainPage(), findMainPageTagFiles(), findMember(), findUsingDeclImports(), findUsingDirectives(), and reset().

argList

ArgumentList Entry::argList

member arguments as a list

Definition at line 193 of file entry.h.

Referenced by addLocalObjCMethod(), addMemberDocs(), addMemberFunction(), addMemberSpecialization(), addOverloaded(), addVariableToFile(), Entry(), findArgument(), findGlobalMember(), findMember(), isVarWithConstructor(), and reset().

args

QCString Entry::args

member argument string

Definition at line 191 of file entry.h.

Referenced by addRelatedPage(), buildExampleList(), buildPageList(), Entry(), filterMemberDocumentation(), findDefineDocumentation(), findEnums(), findMainPage(), and reset().

artificial

bool Entry::artificial

Artificially introduced item.

Definition at line 228 of file entry.h.

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

bitfields

QCString Entry::bitfields

member's bit fields

Definition at line 192 of file entry.h.

Referenced by addVariableToClass(), Entry(), and reset().

bodyColumn

int Entry::bodyColumn

column of the body in the source

Definition at line 216 of file entry.h.

Referenced by Entry(), and reset().

bodyLine

int Entry::bodyLine

line number of the body in the source

Definition at line 215 of file entry.h.

Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), ModuleManager::addDocs(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addOverloaded(), addVariableToClass(), addVariableToFile(), buildNamespaceList(), VHDLOutlineParser::checkInlineCode(), Entry(), findDefineDocumentation(), findEnums(), findMember(), and reset().

brief

QCString Entry::brief

brief description (doc block)

Definition at line 202 of file entry.h.

Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), DocGroup::addDocs(), ModuleManager::addDocs(), addEnumDocs(), addIncludeFile(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildGroupListFiltered(), buildNamespaceList(), VHDLOutlineParser::checkInlineCode(), 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 204 of file entry.h.

Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), ModuleManager::addDocs(), addEnumDocs(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildGroupListFiltered(), buildNamespaceList(), 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 203 of file entry.h.

Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), ModuleManager::addDocs(), addEnumDocs(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildGroupListFiltered(), buildNamespaceList(), Entry(), findDirDocumentation(), findEnums(), findMainPage(), findMember(), findUsingDeclImports(), findUsingDirectives(), and reset().

commandOverrides

CommandOverrides Entry::commandOverrides

store info for commands whose default can be overridden

Definition at line 189 of file entry.h.

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

doc

QCString Entry::doc

documentation block (partly parsed)

Definition at line 199 of file entry.h.

Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), DocGroup::addDocs(), ModuleManager::addDocs(), addEnumDocs(), addIncludeFile(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addMemberToGroups(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildGroupListFiltered(), buildNamespaceList(), VHDLOutlineParser::checkInlineCode(), 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 201 of file entry.h.

Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), DocGroup::addDocs(), ModuleManager::addDocs(), addEnumDocs(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildFileList(), buildGroupListFiltered(), buildNamespaceList(), Entry(), findDirDocumentation(), findEnums(), findMainPage(), findMember(), findUsingDeclImports(), findUsingDirectives(), and reset().

docLine

int Entry::docLine

line number at which the documentation was found

Definition at line 200 of file entry.h.

Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), DocGroup::addDocs(), ModuleManager::addDocs(), addEnumDocs(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildFileList(), buildGroupListFiltered(), buildNamespaceList(), Entry(), findDirDocumentation(), findEnums(), findMainPage(), findMember(), findUsingDeclImports(), findUsingDirectives(), CommentScanner::parseCommentBlock(), and reset().

endBodyLine

int Entry::endBodyLine

line number where the definition ends

Definition at line 217 of file entry.h.

Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), ModuleManager::addDocs(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addOverloaded(), addVariableToClass(), addVariableToFile(), buildNamespaceList(), VHDLOutlineParser::checkInlineCode(), Entry(), findEnums(), findMember(), and reset().

exception

QCString Entry::exception

throw specification

Definition at line 213 of file entry.h.

Referenced by addVariableToClass(), Entry(), filterMemberDocumentation(), and reset().

explicitExternal

bool Entry::explicitExternal

explicitly defined as external?

Definition at line 185 of file entry.h.

Referenced by addVariableToFile(), Entry(), and reset().

exported

bool Entry::exported

is the symbol exported from a C++20 module

Definition at line 188 of file entry.h.

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 219 of file entry.h.

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

fileName

QCString Entry::fileName

file this entry was extracted from

Definition at line 222 of file entry.h.

Referenced by addClassToContext(), addClassToGroups(), ModuleDefImpl::addClassToModule(), ModuleManager::addClassToModule(), addConceptToContext(), addConceptToGroups(), ModuleDefImpl::addConceptToModule(), ModuleManager::addConceptToModule(), addDirToGroups(), ModuleManager::addDocs(), addExampleToGroups(), addGroupToGroups(), addIncludeFile(), addLocalObjCMethod(), addMemberDocs(), addMemberFunction(), addMemberSpecialization(), addMemberToGroups(), ModuleDefImpl::addMemberToModule(), ModuleManager::addMemberToModule(), addModuleToGroups(), addNamespaceToGroups(), addOverloaded(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildGroupListFiltered(), 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

GroupDocType Entry::groupDocType

Definition at line 229 of file entry.h.

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

groups

std::vector<Grouping> Entry::groups

list of groups this entry belongs to

Definition at line 220 of file entry.h.

Referenced by addClassToGroups(), addConceptToGroups(), addDirToGroups(), addEnumDocs(), addExampleToGroups(), addGroupToGroups(), addMemberToGroups(), addModuleToGroups(), addNamespaceToGroups(), addRelatedPage(), buildFileList(), DocGroup::close(), Entry(), findGlobalMember(), findUsingDirectives(), DocGroup::initGroupInfo(), isEntryInGroupOfMember(), reset(), and tryAddEnumDocsToGroupMember().

hasTagInfo

bool Entry::hasTagInfo

is tag info valid

Definition at line 174 of file entry.h.

Referenced by Entry(), Entry(), and tagInfo().

hidden

bool Entry::hidden

does this represent an entity that is hidden from the output

Definition at line 227 of file entry.h.

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

id

QCString Entry::id

libclang id

Definition at line 230 of file entry.h.

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

inbodyDocs

QCString Entry::inbodyDocs

documentation inside the body of a function

Definition at line 205 of file entry.h.

Referenced by addDefineDoc(), addEnumDocs(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildGroupListFiltered(), VHDLOutlineParser::checkInlineCode(), Entry(), findEnums(), findMainPage(), findMember(), findUsingDeclImports(), and reset().

inbodyFile

QCString Entry::inbodyFile

file in which the body doc was found

Definition at line 207 of file entry.h.

Referenced by addDefineDoc(), addEnumDocs(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addOverloaded(), addVariableToClass(), addVariableToFile(), buildGroupListFiltered(), Entry(), findEnums(), findMember(), findUsingDeclImports(), and reset().

inbodyLine

int Entry::inbodyLine

line number at which the body doc was found

Definition at line 206 of file entry.h.

Referenced by addDefineDoc(), addEnumDocs(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addOverloaded(), addVariableToClass(), addVariableToFile(), buildGroupListFiltered(), Entry(), findEnums(), findMember(), findUsingDeclImports(), and reset().

includeFile

QCString Entry::includeFile

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

Definition at line 197 of file entry.h.

Referenced by addIncludeFile(), Entry(), and reset().

includeName

QCString Entry::includeName

include name (3 arg of \class)

Definition at line 198 of file entry.h.

Referenced by addIncludeFile(), Entry(), and reset().

initializer

TextStream Entry::initializer

initial value (for variables)

Definition at line 196 of file entry.h.

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

initLines

int Entry::initLines

define/variable initializer lines to show

Definition at line 183 of file entry.h.

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 212 of file entry.h.

Referenced by Entry(), filterMemberDocumentation(), and reset().

isStatic

bool Entry::isStatic

static ?

Definition at line 184 of file entry.h.

Referenced by addClassToContext(), addLocalObjCMethod(), addMemberFunction(), addMemberSpecialization(), addOverloaded(), addVariableToClass(), addVariableToFile(), applyModifiers(), Entry(), findMember(), and reset().

lang

SrcLangExt Entry::lang

programming language in which this entry was found

Definition at line 226 of file entry.h.

Referenced by addClassToContext(), addConceptToContext(), addEnumValuesToEnums(), addLocalObjCMethod(), addMemberDocs(), addMemberFunction(), addMemberSpecialization(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildGroupListFiltered(), buildNamespaceList(), VHDLOutlineParser::checkInlineCode(), Entry(), extractClassName(), filterMemberDocumentation(), findClassRelation(), findDefineDocumentation(), findEnums(), findGlobalMember(), findMember(), findTemplateInstanceRelation(), findUsedClassesForClass(), findUsingDeclarations(), findUsingDeclImports(), findUsingDirectives(), VHDLOutlineParser::initEntry(), and reset().

localToc

LocalToc Entry::localToc

Definition at line 231 of file entry.h.

Referenced by addRelatedPage(), Entry(), and findMainPage().

m_fileDef

FileDef* Entry::m_fileDef

private

Definition at line 265 of file entry.h.

Referenced by Entry(), fileDef(), reset(), and setFileDef().

m_parent

Entry* Entry::m_parent

private

parent node in the tree

Definition at line 263 of file entry.h.

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

m_sublist

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

private

Definition at line 264 of file entry.h.

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

metaData

QCString Entry::metaData

Slice metadata.

Definition at line 232 of file entry.h.

Referenced by addClassToContext(), addLocalObjCMethod(), addMemberSpecialization(), addOverloaded(), addVariableToClass(), addVariableToFile(), buildNamespaceList(), findEnums(), findMember(), findUsingDeclImports(), findUsingDirectives(), and reset().

mGrpId

int Entry::mGrpId

member group id

Definition at line 218 of file entry.h.

Referenced by addConceptToContext(), addDefineDoc(), addEnumDocs(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addOverloaded(), addVariableToClass(), addVariableToFile(), DocGroup::close(), Entry(), Entry(), filterMemberDocumentation(), findEnums(), findMember(), findUsingDeclImports(), DocGroup::initGroupInfo(), DocGroup::open(), and reset().

mtype

MethodTypes Entry::mtype

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

Definition at line 180 of file entry.h.

Referenced by addOverloaded(), addVariableToClass(), Entry(), findMember(), and reset().

name

QCString Entry::name

member name

Definition at line 173 of file entry.h.

Referenced by addClassToContext(), addConceptToContext(), ModuleManager::addDocs(), addEnumDocs(), addEnumValuesToEnums(), addLocalObjCMethod(), addMemberDocs(), addPageToContext(), addRelatedPage(), addVariableToFile(), buildClassDocList(), buildClassList(), buildExampleList(), buildFileList(), buildGroupListFiltered(), buildListOfUsingDecls(), buildNamespaceList(), buildPageList(), VHDLOutlineParser::checkInlineCode(), computeClassRelations(), computePageRelations(), computeTemplateClassRelations(), endScope(), Entry(), extractClassName(), filterMemberDocumentation(), findBaseClassesForClass(), findClassEntries(), findClassRelation(), findDefineDocumentation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findGroupScope(), findMember(), findTemplateInstanceRelation(), findUsingDeclarations(), findUsingDeclImports(), findUsingDirectives(), isClassSection(), isVarWithConstructor(), DocGroup::open(), organizeSubGroupsFiltered(), printNavTree(), and reset().

program

TextStream Entry::program

the program text

Definition at line 195 of file entry.h.

Referenced by Entry(), and reset().

protection

Protection Entry::protection

class protection

Definition at line 179 of file entry.h.

Referenced by addClassToContext(), addIncludeFile(), addLocalObjCMethod(), addMemberFunction(), addMemberSpecialization(), addOverloaded(), addVariableToClass(), addVariableToFile(), applyModifiers(), computeClassRelations(), Entry(), findEnums(), findMember(), findUsingDeclImports(), initMethodProtection(), and reset().

proto

bool Entry::proto

prototype ?

Definition at line 186 of file entry.h.

Referenced by addDefineDoc(), addEnumDocs(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addOverloaded(), Entry(), findEnums(), findMember(), and reset().

qualifiers

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

qualifiers specified with the qualifier command

Definition at line 234 of file entry.h.

Referenced by addClassToContext(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addOverloaded(), addVariableToClass(), addVariableToFile(), Entry(), findEnums(), findMember(), findUsingDeclImports(), and reset().

read

QCString Entry::read

property read accessor

Definition at line 210 of file entry.h.

Referenced by addVariableToClass(), and Entry().

relates

QCString Entry::relates

related class (doc block)

Definition at line 208 of file entry.h.

Referenced by addEnumValuesToEnums(), Entry(), findEnums(), findMemberDocumentation(), DocGroup::initGroupInfo(), DocGroup::open(), and reset().

relatesType

RelatesType Entry::relatesType

how relates is handled

Definition at line 209 of file entry.h.

Referenced by Entry(), Entry(), findEnums(), findGlobalMember(), findMember(), findMemberDocumentation(), and reset().

req

QCString Entry::req

C++20 requires clause.

Definition at line 233 of file entry.h.

Referenced by addClassToContext(), addMemberDocs(), Entry(), findGlobalMember(), and reset().

section

EntryType Entry::section

entry type (see Sections);

Definition at line 171 of file entry.h.

Referenced by addClassToContext(), addConceptToContext(), DocGroup::addDocs(), addEnumValuesToEnums(), addMemberDocs(), addMemberFunction(), addPageToContext(), buildClassDocList(), buildClassList(), buildConceptDocList(), buildConceptList(), buildExampleList(), buildFileList(), buildGroupListFiltered(), buildListOfUsingDecls(), buildNamespaceList(), buildPageList(), VHDLOutlineParser::checkInlineCode(), computePageRelations(), endScope(), filterMemberDocumentation(), findClassRelation(), findDefineDocumentation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findGlobalMember(), findGroupScope(), findMainPage(), findMainPageTagFiles(), findMember(), findMemberDocumentation(), findModuleDocumentation(), findUsingDeclarations(), findUsingDeclImports(), findUsingDirectives(), groupingPri(), isClassSection(), isVarWithConstructor(), DocGroup::open(), organizeSubGroupsFiltered(), printNavTree(), and reset().

sli

RefItemVector Entry::sli

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

Definition at line 225 of file entry.h.

Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), DocGroup::addDocs(), ModuleManager::addDocs(), addEnumDocs(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildFileList(), buildGroupListFiltered(), buildNamespaceList(), buildPageList(), Entry(), findDirDocumentation(), findEnums(), findMember(), findUsingDirectives(), and reset().

spec

TypeSpecifier Entry::spec

class/member specifiers

Definition at line 181 of file entry.h.

Referenced by addClassToContext(), addEnumValuesToEnums(), addVariableToClass(), addVariableToFile(), applyModifiers(), 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 224 of file entry.h.

Referenced by addClassToContext(), addConceptToContext(), addLocalObjCMethod(), addMemberSpecialization(), addOverloaded(), addVariableToClass(), addVariableToFile(), buildNamespaceList(), Entry(), findClassRelation(), findEnums(), findMember(), findTemplateInstanceRelation(), findUsingDeclImports(), findUsingDirectives(), and reset().

startLine

int Entry::startLine

start line of entry in the source

Definition at line 223 of file entry.h.

Referenced by addClassToContext(), addClassToGroups(), ModuleDefImpl::addClassToModule(), addConceptToContext(), addConceptToGroups(), ModuleDefImpl::addConceptToModule(), addDefineDoc(), addDirToGroups(), ModuleManager::addDocs(), addExampleToGroups(), addGroupToGroups(), addIncludeFile(), addLocalObjCMethod(), addMemberDocs(), addMemberFunction(), addMemberSpecialization(), addMemberToGroups(), ModuleDefImpl::addMemberToModule(), addModuleToGroups(), addNamespaceToGroups(), addOverloaded(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildGroupListFiltered(), buildNamespaceList(), VHDLOutlineParser::checkInlineCode(), computeClassRelations(), 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 187 of file entry.h.

Referenced by addClassToContext(), Entry(), and reset().

tagInfoData

TagInfo Entry::tagInfoData

tag file info data

Definition at line 175 of file entry.h.

Referenced by Entry(), and tagInfo().

tArgLists

ArgumentLists Entry::tArgLists

template argument declarations

Definition at line 194 of file entry.h.

Referenced by addClassToContext(), addConceptToContext(), addMemberFunction(), addOverloaded(), addVariableToClass(), addVariableToFile(), Entry(), findGlobalMember(), findMember(), findUsingDeclarations(), and reset().

type

QCString Entry::type

member type

Definition at line 172 of file entry.h.

Referenced by applyModifiers(), buildGroupListFiltered(), buildNamespaceList(), VHDLOutlineParser::checkInlineCode(), endScope(), Entry(), filterMemberDocumentation(), findGlobalMember(), isVarWithConstructor(), and reset().

typeConstr

ArgumentList Entry::typeConstr

where clause (C#) for type constraints

Definition at line 214 of file entry.h.

Referenced by addClassToContext(), addMemberSpecialization(), addOverloaded(), Entry(), and reset().

vhdlSpec

VhdlSpecifier Entry::vhdlSpec

VHDL specifiers.

Definition at line 182 of file entry.h.

Referenced by addLocalObjCMethod(), addMemberSpecialization(), addOverloaded(), addVariableToClass(), addVariableToFile(), VHDLOutlineParser::checkInlineCode(), Entry(), findEnums(), findMember(), VhdlDocGen::isVhdlClass(), and reset().

virt

Specifier Entry::virt

virtualness of the entry

Definition at line 190 of file entry.h.

Referenced by addLocalObjCMethod(), addMemberFunction(), addMemberSpecialization(), addOverloaded(), applyModifiers(), Entry(), findMember(), findUsingDeclImports(), and reset().

write

QCString Entry::write

property write accessor

Definition at line 211 of file entry.h.

Referenced by addVariableToClass(), and Entry().

---

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

• src/entry.h
• src/entry.cpp