Public Types | Public Member Functions | List of all members
Entry Class Reference

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

#include <entry.h>

Collaboration diagram for Entry:
Collaboration graph

Public Types


Public Member Functions

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

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 callGraph
 do we need to draw the call graph?
bool callerGraph
 do we need to draw the caller graph?
bool referencedByRelation
 do we need to show the referenced by relation?
bool referencesRelation
 do we need to show the references relation?
bool inlineSource
 do we need to show the inline source?
bool includeGraph
 do we need to draw the include graph?
bool includedByGraph
 do we need to draw the included by graph?
bool directoryGraph
 do we need to draw the directory graph?
bool collaborationGraph
 do we need to draw the collaboration graph?
CLASS_GRAPH_t inheritanceGraph
 type of inheritance graph?
bool groupGraph
 do we need to draw the group graph?
bool exported
 is the symbol exported from a C++20 module
Specifier virt
 virtualness of the entry
QCString args
 member argument string
QCString bitfields
 member's bit fields
ArgumentList argList
 member arguments as a list
ArgumentLists tArgLists
 template argument declarations
TextStream program
 the program text
TextStream initializer
 initial value (for variables)
QCString includeFile
 include file (2 arg of \class, must be unique)
QCString includeName
 include name (3 arg of \class)
QCString doc
 documentation block (partly parsed)
int docLine
 line number at which the documentation was found
QCString docFile
 file in which the documentation was found
QCString brief
 brief description (doc block)
int briefLine
 line number at which the brief desc. was found
QCString briefFile
 file in which the brief desc. was found
QCString inbodyDocs
 documentation inside the body of a function
int inbodyLine
 line number at which the body doc was found
QCString inbodyFile
 file in which the body doc was found
QCString relates
 related class (doc block)
RelatesType relatesType
 how relates is handled
QCString read
 property read accessor
QCString write
 property write accessor
QCString inside
 name of the class in which documents are found
QCString exception
 throw specification
ArgumentList typeConstr
 where clause (C#) for type constraints
int bodyLine
 line number of the body in the source
int bodyColumn
 column of the body in the source
int endBodyLine
 line number where the definition ends
int mGrpId
 member group id
std::vector< BaseInfoextends
 list of base classes
std::vector< Groupinggroups
 list of groups this entry belongs to
std::vector< const SectionInfo * > anchors
 list of anchors defined in this entry
QCString fileName
 file this entry was extracted from
int startLine
 start line of entry in the source
int startColumn
 start column of entry in the source
RefItemVector sli
 special lists (test/todo/bug/deprecated/..) this entry is in
SrcLangExt lang
 programming language in which this entry was found
bool hidden
 does this represent an entity that is hidden from the output
bool artificial
 Artificially introduced item.
GroupDocType groupDocType
QCString id
 libclang id
LocalToc localToc
QCString metaData
 Slice metadata.
QCString req
 C++20 requires clause.
std::vector< std::string > qualifiers
 qualifiers specified with the qualifier command
void moveToSubEntryAndRefresh (Entry *&e)
void moveToSubEntryAndRefresh (std::shared_ptr< Entry > &e)
void copyToSubEntry (Entry *e)
void copyToSubEntry (const std::shared_ptr< Entry > &e)
void removeSubEntry (const Entry *e)
void reset ()
void markAsProcessed () const
void setFileDef (FileDef *fd)
FileDeffileDef () const
const TagInfotagInfo () const
const char * groupDocCmd () const
 return the command name used to define GROUPDOC_SEC
Grouping::GroupPri_t groupingPri () const

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.

Member Enumeration Documentation

◆ GroupDocType







Member Function Documentation

◆ children()

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

Returns the list of children for this Entry

See also
addSubEntry() and removeSubEntry()

◆ copyToSubEntry()

void Entry::copyToSubEntry ( Entry e)

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

◆ parent()

Entry* Entry::parent ( ) const

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

◆ removeSubEntry()

void Entry::removeSubEntry ( const Entry e)

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

◆ reset()

void Entry::reset ( )

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

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