#include <entry.h>
Public Types | |
| enum | Sections { CLASS_SEC = 0x00000001, NAMESPACE_SEC = 0x00000010, COMPOUND_MASK = CLASS_SEC, SCOPE_MASK = COMPOUND_MASK | NAMESPACE_SEC, CLASSDOC_SEC = 0x00000800, STRUCTDOC_SEC = 0x00001000, UNIONDOC_SEC = 0x00002000, EXCEPTIONDOC_SEC = 0x00004000, NAMESPACEDOC_SEC = 0x00008000, INTERFACEDOC_SEC = 0x00010000, PROTOCOLDOC_SEC = 0x00020000, CATEGORYDOC_SEC = 0x00040000, COMPOUNDDOC_MASK, SOURCE_SEC = 0x00400000, HEADER_SEC = 0x00800000, FILE_MASK = SOURCE_SEC | HEADER_SEC, ENUMDOC_SEC = 0x01000000, ENUM_SEC = 0x02000000, EMPTY_SEC = 0x03000000, PAGEDOC_SEC = 0x04000000, VARIABLE_SEC = 0x05000000, FUNCTION_SEC = 0x06000000, TYPEDEF_SEC = 0x07000000, MEMBERDOC_SEC = 0x08000000, OVERLOADDOC_SEC = 0x09000000, EXAMPLE_SEC = 0x0a000000, VARIABLEDOC_SEC = 0x0b000000, FILEDOC_SEC = 0x0c000000, DEFINEDOC_SEC = 0x0d000000, INCLUDE_SEC = 0x0e000000, DEFINE_SEC = 0x0f000000, GROUPDOC_SEC = 0x10000000, USINGDIR_SEC = 0x11000000, MAINPAGEDOC_SEC = 0x12000000, MEMBERGRP_SEC = 0x13000000, USINGDECL_SEC = 0x14000000, PACKAGE_SEC = 0x15000000, PACKAGEDOC_SEC = 0x16000000, OBJCIMPL_SEC = 0x17000000, DIRDOC_SEC = 0x18000000 } |
| enum | MemberSpecifier { Inline = 0x000001, Explicit = 0x000002, Mutable = 0x000004, Settable = 0x000008, Gettable = 0x000010, Readable = 0x000020, Writable = 0x000040, Final = 0x000080, Abstract = 0x000100, Addable = 0x000200, Removable = 0x000400, Raisable = 0x000800, Override = 0x001000, New = 0x002000, Sealed = 0x004000, Initonly = 0x008000, Optional = 0x010000, Required = 0x020000, NonAtomic = 0x040000, Copy = 0x080000, Retain = 0x100000, Assign = 0x200000 } |
| enum | ClassSpecifier { Template = 0x0001, Generic = 0x0002, Ref = 0x0004, Value = 0x0008, Interface = 0x0010, Struct = 0x0020, Union = 0x0040, Exception = 0x0080, Protocol = 0x0100, Category = 0x0200, SealedClass = 0x0400, AbstractClass = 0x0800 } |
| enum | GroupDocType { GROUPDOC_NORMAL, GROUPDOC_ADD, GROUPDOC_WEAK } |
Public Member Functions | |
| Entry () | |
| Entry (const Entry &) | |
| ~Entry () | |
| int | getSize () |
| void | addSpecialListItem (const char *listName, int index) |
| void | createNavigationIndex (EntryNav *rootNav, FileStorage *storage, FileDef *fd) |
| void | setParent (Entry *parent) |
| Entry * | parent () const |
| const QList< Entry > * | children () const |
| void | addSubEntry (Entry *e) |
| void | reset () |
| void | marshall (StorageIntf *) |
| void | unmarshall (StorageIntf *) |
| const char * | groupDocCmd () const |
| return the command name used to define GROUPDOC_SEC | |
| Grouping::GroupPri_t | groupingPri () const |
Public Attributes | |
| int | section |
| entry type (see Sections); | |
| QCString | type |
| member type | |
| QCString | name |
| member name | |
| TagInfo * | tagInfo |
| tag file info | |
| Protection | protection |
| class protection | |
| MethodTypes | mtype |
| signal, slot, (dcop) method, or property? | |
| int | spec |
| class/member specifiers | |
| int | initLines |
| define/variable initializer lines to show | |
| bool | stat |
| static ? | |
| bool | explicitExternal |
| explicitly defined as external? | |
| bool | proto |
| prototype ? | |
| bool | subGrouping |
| automatically group class members? | |
| bool | callGraph |
| do we need to draw the call graph? | |
| bool | callerGraph |
| do we need to draw the caller graph? | |
| Specifier | virt |
| virtualness of the entry | |
| QCString | args |
| member argument string | |
| QCString | bitfields |
| member's bit fields | |
| ArgumentList * | argList |
| member arguments as a list | |
| QList< ArgumentList > * | tArgLists |
| template argument declarations | |
| QGString | program |
| the program text | |
| QGString | 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) | |
| bool | relatesDup |
| keep duplicate doc in original file also | |
| 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 definition in the source | |
| int | endBodyLine |
| line number where the definition ends | |
| int | mGrpId |
| member group id | |
| QList< BaseInfo > * | extends |
| list of base classes | |
| QList< Grouping > * | groups |
| list of groups this entry belongs to | |
| QList< 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 | |
| QList< ListItemInfo > * | sli |
| special lists (test/todo/bug/deprecated/..) this entry is in | |
| bool | objc |
| Objective-C construct. | |
| bool | hidden |
| does this represent an entity that is hidden from the output | |
| bool | artificial |
| Artificially introduced item. | |
| GroupDocType | groupDocType |
Static Public Attributes | |
| static int | num |
| counts the total number of entries | |
parseMain() in scanner.l will generate a tree of these entries.
Definition at line 185 of file entry.h.
| enum Entry::Sections |
Kind of entries that are supported
| enum Entry::GroupDocType |
| Entry::Entry | ( | ) |
Definition at line 51 of file entry.cpp.
References anchors, argList, EMPTY_SEC, extends, GROUPDOC_NORMAL, groupDocType, groups, hidden, mGrpId, num, relatesDup, reset(), section, sli, tagInfo, tArgLists, and typeConstr.
| Entry::Entry | ( | const Entry & | ) |
Definition at line 78 of file entry.cpp.
References anchors, argList, args, artificial, bitfields, bodyLine, brief, briefFile, briefLine, callerGraph, callGraph, ArgumentList::constSpecifier, copyArgumentLists(), doc, docFile, docLine, endBodyLine, exception, explicitExternal, extends, fileName, groupDocType, groups, hidden, inbodyDocs, inbodyFile, inbodyLine, includeFile, includeName, initializer, initLines, inside, m_parent, m_sublist, mGrpId, mtype, name, num, objc, program, protection, ArgumentList::pureSpecifier, read, relates, relatesDup, section, sli, spec, startLine, stat, tagInfo, tArgLists, type, typeConstr, virt, ArgumentList::volatileSpecifier, and write.
| Entry::~Entry | ( | ) |
| void Entry::addSpecialListItem | ( | const char * | listName, | |
| int | index | |||
| ) |
Definition at line 345 of file entry.cpp.
References ListItemInfo::itemId, sli, and ListItemInfo::type.
| void Entry::createNavigationIndex | ( | EntryNav * | rootNav, | |
| FileStorage * | storage, | |||
| FileDef * | fd | |||
| ) |
| void Entry::setParent | ( | Entry * | parent | ) | [inline] |
| Entry* Entry::parent | ( | ) | const [inline] |
Definition at line 304 of file entry.h.
Referenced by VhdlDocGen::findFunction(), VhdlDocGen::getEntryAtLine(), mapLibPackage(), and marshalEntryTree().
| void Entry::addSubEntry | ( | Entry * | e | ) |
Adds entry as a child to this entry
Definition at line 232 of file entry.cpp.
References m_parent.
Referenced by TagFileParser::buildLists(), mapLibPackage(), VHDLLanguageScanner::parsePrototype(), and unmarshalEntryTree().
| void Entry::reset | ( | ) |
Restore the state of this Entry to the default value it has at construction time.
Definition at line 243 of file entry.cpp.
References anchors, argList, args, artificial, bitfields, bodyLine, brief, briefFile, briefLine, callerGraph, callGraph, doc, docFile, docLine, EMPTY_SEC, endBodyLine, exception, explicitExternal, extends, fileName, GROUPDOC_NORMAL, groupDocType, groups, hidden, inbodyDocs, inbodyFile, inbodyLine, includeFile, includeName, initializer, initLines, inside, Method, mGrpId, mtype, name, Normal, objc, program, protection, proto, Public, relates, relatesDup, section, sli, spec, startLine, stat, subGrouping, tagInfo, tArgLists, type, typeConstr, and virt.
Referenced by Entry().
| void Entry::marshall | ( | StorageIntf * | ) |
| void Entry::unmarshall | ( | StorageIntf * | ) |
| const char* Entry::groupDocCmd | ( | ) | const [inline] |
return the command name used to define GROUPDOC_SEC
Definition at line 376 of file entry.h.
References GROUPDOC_ADD, GROUPDOC_NORMAL, GROUPDOC_WEAK, and groupDocType.
| Grouping::GroupPri_t Entry::groupingPri | ( | ) | const [inline] |
Definition at line 386 of file entry.h.
References GROUPDOC_ADD, GROUPDOC_NORMAL, GROUPDOC_SEC, GROUPDOC_WEAK, groupDocType, Grouping::GROUPING_AUTO_ADD, Grouping::GROUPING_AUTO_DEF, Grouping::GROUPING_AUTO_WEAK, Grouping::GROUPING_LOWEST, and section.
| int Entry::section |
entry type (see Sections);
Definition at line 318 of file entry.h.
Referenced by addSignals(), TagFileParser::buildLists(), Entry(), getType(), groupingPri(), mapLibPackage(), marshalEntry(), VHDLLanguageScanner::parsePrototype(), reset(), and unmarshalEntry().
| QCString Entry::type |
member type
Definition at line 319 of file entry.h.
Referenced by addSignals(), TagFileParser::buildLists(), Entry(), marshalEntry(), VHDLLanguageScanner::parsePrototype(), reset(), unmarshalEntry(), and VhdlDocGen::writeDoc().
| QCString Entry::name |
member name
Definition at line 320 of file entry.h.
Referenced by VhdlDocGen::addFuncDoc(), addSignals(), TagFileParser::buildLists(), Entry(), VhdlDocGen::findFunction(), marshalEntry(), VHDLLanguageScanner::parsePrototype(), reset(), and unmarshalEntry().
tag file info
Definition at line 321 of file entry.h.
Referenced by TagFileParser::buildLists(), Entry(), EntryNav::EntryNav(), reset(), and ~Entry().
class protection
Definition at line 324 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
signal, slot, (dcop) method, or property?
Definition at line 325 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
| int Entry::spec |
class/member specifiers
Definition at line 326 of file entry.h.
Referenced by VhdlDocGen::addFuncDoc(), addSignals(), TagFileParser::buildLists(), Entry(), VhdlDocGen::findFunction(), getType(), mapLibPackage(), marshalEntry(), VHDLLanguageScanner::parsePrototype(), reset(), and unmarshalEntry().
| int Entry::initLines |
define/variable initializer lines to show
Definition at line 327 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
| bool Entry::stat |
static ?
Definition at line 328 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
explicitly defined as external?
Definition at line 329 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
| bool Entry::proto |
prototype ?
Definition at line 330 of file entry.h.
Referenced by marshalEntry(), reset(), and unmarshalEntry().
| bool Entry::subGrouping |
automatically group class members?
Definition at line 331 of file entry.h.
Referenced by marshalEntry(), reset(), and unmarshalEntry().
| bool Entry::callGraph |
do we need to draw the call graph?
Definition at line 332 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
| bool Entry::callerGraph |
do we need to draw the caller graph?
Definition at line 333 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
virtualness of the entry
Definition at line 334 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
| QCString Entry::args |
member argument string
Definition at line 335 of file entry.h.
Referenced by TagFileParser::buildLists(), Entry(), marshalEntry(), VHDLLanguageScanner::parsePrototype(), reset(), and unmarshalEntry().
| QCString Entry::bitfields |
member's bit fields
Definition at line 336 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
member arguments as a list
Definition at line 337 of file entry.h.
Referenced by Entry(), VhdlDocGen::findFunction(), marshalEntry(), VHDLLanguageScanner::parsePrototype(), reset(), unmarshalEntry(), and ~Entry().
template argument declarations
Definition at line 338 of file entry.h.
Referenced by TagFileParser::buildLists(), Entry(), marshalEntry(), reset(), unmarshalEntry(), and ~Entry().
| QGString Entry::program |
the program text
Definition at line 339 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
| QGString Entry::initializer |
initial value (for variables)
Definition at line 340 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
| QCString Entry::includeFile |
include file (2 arg of \class, must be unique)
Definition at line 341 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
| QCString Entry::includeName |
include name (3 arg of \class)
Definition at line 342 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
| QCString Entry::doc |
documentation block (partly parsed)
Definition at line 343 of file entry.h.
Referenced by addMemberToGroups(), addSignals(), Entry(), VhdlDocGen::findFunction(), marshalEntry(), reset(), and unmarshalEntry().
| int Entry::docLine |
line number at which the documentation was found
Definition at line 344 of file entry.h.
Referenced by VhdlDocGen::addFuncDoc(), Entry(), VhdlDocGen::findFunction(), marshalEntry(), reset(), and unmarshalEntry().
| QCString Entry::docFile |
file in which the documentation was found
Definition at line 345 of file entry.h.
Referenced by Entry(), VhdlDocGen::findFunction(), marshalEntry(), reset(), and unmarshalEntry().
| QCString Entry::brief |
brief description (doc block)
Definition at line 346 of file entry.h.
Referenced by addSignals(), Entry(), VhdlDocGen::findFunction(), marshalEntry(), reset(), and unmarshalEntry().
| int Entry::briefLine |
line number at which the brief desc. was found
Definition at line 347 of file entry.h.
Referenced by Entry(), VhdlDocGen::findFunction(), marshalEntry(), reset(), and unmarshalEntry().
| QCString Entry::briefFile |
file in which the brief desc. was found
Definition at line 348 of file entry.h.
Referenced by Entry(), VhdlDocGen::findFunction(), marshalEntry(), reset(), and unmarshalEntry().
| QCString Entry::inbodyDocs |
documentation inside the body of a function
Definition at line 349 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
line number at which the body doc was found
Definition at line 350 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
| QCString Entry::inbodyFile |
file in which the body doc was found
Definition at line 351 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
| QCString Entry::relates |
related class (doc block)
Definition at line 352 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
| bool Entry::relatesDup |
keep duplicate doc in original file also
Definition at line 353 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
| QCString Entry::read |
property read accessor
Definition at line 354 of file entry.h.
Referenced by Entry(), marshalEntry(), and unmarshalEntry().
| QCString Entry::write |
property write accessor
Definition at line 355 of file entry.h.
Referenced by Entry(), marshalEntry(), and unmarshalEntry().
| QCString Entry::inside |
name of the class in which documents are found
Definition at line 356 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
| QCString Entry::exception |
throw specification
Definition at line 357 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
where clause (C#) for type constraints
Definition at line 358 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
| int Entry::bodyLine |
line number of the definition in the source
Definition at line 359 of file entry.h.
Referenced by addSignals(), Entry(), VhdlDocGen::getEntryAtLine(), marshalEntry(), reset(), and unmarshalEntry().
line number where the definition ends
Definition at line 360 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
| int Entry::mGrpId |
member group id
Definition at line 361 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
list of base classes
Definition at line 362 of file entry.h.
Referenced by TagFileParser::buildLists(), VhdlDocGen::computeVhdlComponentRelations(), Entry(), VhdlDocGen::foundInsertedComponent(), marshalEntry(), reset(), unmarshalEntry(), and ~Entry().
list of groups this entry belongs to
Definition at line 363 of file entry.h.
Referenced by addClassToGroups(), addDirToGroups(), addExampleToGroups(), addGroupToGroups(), addMemberToGroups(), addNamespaceToGroups(), Entry(), marshalEntry(), reset(), unmarshalEntry(), and ~Entry().
list of anchors defined in this entry
Definition at line 364 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), unmarshalEntry(), and ~Entry().
| QCString Entry::fileName |
file this entry was extracted from
Definition at line 365 of file entry.h.
Referenced by VhdlDocGen::addFuncDoc(), addGroupToGroups(), addMemberToGroups(), TagFileParser::buildLists(), Entry(), marshalEntry(), reset(), and unmarshalEntry().
| int Entry::startLine |
start line of entry in the source
Definition at line 366 of file entry.h.
Referenced by addGroupToGroups(), addMemberToGroups(), addSignals(), VhdlDocGen::computeVhdlComponentRelations(), Entry(), marshalEntry(), reset(), and unmarshalEntry().
special lists (test/todo/bug/deprecated/..) this entry is in
Definition at line 367 of file entry.h.
Referenced by addSpecialListItem(), Entry(), marshalEntry(), reset(), unmarshalEntry(), and ~Entry().
| bool Entry::objc |
Objective-C construct.
Definition at line 368 of file entry.h.
Referenced by TagFileParser::buildLists(), Entry(), marshalEntry(), reset(), and unmarshalEntry().
| bool Entry::hidden |
does this represent an entity that is hidden from the output
Definition at line 369 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
| bool Entry::artificial |
Artificially introduced item.
Definition at line 370 of file entry.h.
Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().
Definition at line 371 of file entry.h.
Referenced by Entry(), groupDocCmd(), groupingPri(), marshalEntry(), reset(), and unmarshalEntry().
int Entry::num [static] |
1.5.1