The `Definition` Class Reference

The common base class of all entity definitions found in the sources. More...

Declaration

class Definition { ... }

Included Headers

Derived Classes

class	ClassDef
	A abstract class representing of a compound symbol. More...

class	ConceptDef


class	DirDef
	A model of a directory symbol. More...

class	FileDef
	A model of a file symbol. More...

class	GroupDef
	A model of a group of symbols. More...

class	MemberDef
	A model of a class/file/namespace member symbol. More...

class	ModuleDef


class	NamespaceDef
	An abstract interface of a namespace symbol. More...

class	PageDef
	A model of a page symbol. More...

Enumerations Index

enum	DefType { ... }

Friends Index

class	DefinitionImpl


DefinitionMutable *	toDefinitionMutable

Public Member Functions Index

DefType	definitionType () const =0


CodeSymbolType	codeSymbolType () const =0


bool	isAlias () const =0


const QCString &	name () const =0


bool	isAnonymous () const =0


QCString	displayName (bool includeScope=TRUE) const =0


const QCString &	localName () const =0


QCString	qualifiedName () const =0


QCString	symbolName () const =0


QCString	getOutputFileBase () const =0


QCString	anchor () const =0


QCString	getSourceFileBase () const =0


QCString	getSourceAnchor () const =0


QCString	documentation () const =0


int	docLine () const =0


QCString	docFile () const =0


QCString	briefDescription (bool abbreviate=FALSE) const =0


QCString	briefDescriptionAsTooltip () const =0


int	briefLine () const =0


QCString	inbodyDocumentation () const =0


QCString	inbodyFile () const =0


int	inbodyLine () const =0


QCString	briefFile () const =0


QCString	getDefFileName () const =0


QCString	getDefFileExtension () const =0


int	getDefLine () const =0


int	getDefColumn () const =0


bool	hasDocumentation () const =0


bool	hasUserDocumentation () const =0


bool	isLinkableInProject () const =0


bool	isLinkable () const =0


bool	isVisibleInProject () const =0


bool	isVisible () const =0


bool	isHidden () const =0


bool	isArtificial () const =0


bool	isExported () const =0


QCString	getReference () const =0


bool	isReference () const =0


QCString	externalReference (const QCString &relPath) const =0


int	getStartDefLine () const =0


int	getStartBodyLine () const =0


int	getEndBodyLine () const =0


const FileDef *	getBodyDef () const =0


SrcLangExt	getLanguage () const =0
	Returns the programming language this definition was written in. More...

const GroupList &	partOfGroups () const =0


bool	isLinkableViaGroup () const =0


const RefItemVector &	xrefListItems () const =0


const Definition *	findInnerCompound (const QCString &name) const =0


Definition *	getOuterScope () const =0


const MemberVector &	getReferencesMembers () const =0


const MemberVector &	getReferencedByMembers () const =0


bool	hasSections () const =0


bool	hasSources () const =0


bool	hasBriefDescription () const =0
	returns TRUE if this class has a brief description More...

QCString	id () const =0


const SectionRefs &	getSectionRefs () const =0
	returns the section dictionary, only of importance for pagedef More...

QCString	navigationPathAsString () const =0


QCString	pathFragment () const =0


void	_setSymbolName (const QCString &name)=0


QCString	_symbolName () const =0

Private Member Functions Index

DefinitionMutable *	toDefinitionMutable_ ()=0


const DefinitionImpl *	toDefinitionImpl_ () const =0

Description

The common base class of all entity definitions found in the sources.

This can be a class or a member function, or a file, or a namespace, etc. Use definitionType() to find which type of definition this is.

Definition at line 75 of file definition.h.

Enumerations

DefType

enum Definition::DefType

Enumeration values

TypeClass	(= 0)
TypeFile	(= 1)
TypeNamespace	(= 2)
TypeModule	(= 3)
TypeMember	(= 4)
TypeGroup	(= 5)
TypePackage	(= 6)
TypePage	(= 7)
TypeDir	(= 8)
TypeConcept	(= 9)

Types of derived classes

Definition at line 81 of file definition.h.

82 {

83 TypeClass = 0,

84 TypeFile = 1,

85 TypeNamespace = 2,

86 TypeModule = 3,

87 TypeMember = 4,

88 TypeGroup = 5,

89 TypePackage = 6,

90 TypePage = 7,

91 TypeDir = 8,

92 TypeConcept = 9,

93 };

Friends

DefinitionImpl

friend class DefinitionImpl

Definition at line 299 of file definition.h.

299 friend class DefinitionImpl;

Reference DefinitionImpl.

Referenced by DefinitionImpl and toDefinitionImpl_.

toDefinitionMutable

friend DefinitionMutable * Definition * d

Declaration at line 300 of file definition.h, definition at line 1929 of file definition.cpp.

1929DefinitionMutable *toDefinitionMutable(Definition *d)

1930{

1931 if (d==nullptr) return nullptr;

1932 return d->toDefinitionMutable_();

1933}

Reference toDefinitionMutable_.

Referenced by PageDefImpl::writeDocumentation.

Public Member Functions

_setSymbolName()

virtual void Definition::_setSymbolName (const QCString & name)

Definition at line 295 of file definition.h.

Reference name.

Referenced by addToMap.

_symbolName()

virtual QCString Definition::_symbolName ()

Definition at line 296 of file definition.h.

anchor()

virtual QCString Definition::anchor ()

Returns the anchor within a page where this item can be found

Definition at line 137 of file definition.h.

briefDescription()

virtual QCString Definition::briefDescription (bool abbreviate=FALSE)

Returns the brief description of this definition. This can include commands.

Definition at line 157 of file definition.h.

References abbreviate and FALSE.

Referenced by MemberDefImpl::_writeEnumValues, ClassDefImpl::addMemberToTemplateInstance, MemberDefAliasImpl::briefDescription, buildFunctionList, combineDeclarationAndDefinition, createTagLessInstance, createUsingMemberImportForClass, MemberGroup::distributeMemberGroupDocumentation, DocParser::findDocsForMemberOrCompound, findFriends, findUsingDeclImports, generateBriefDoc, generateDEFForClass, generateDEFForFile, generateDEFForMember, generateDEFForNamespace, PerlModGenerator::generatePerlModForClass, PerlModGenerator::generatePerlModForConcept, PerlModGenerator::generatePerlModForFile, PerlModGenerator::generatePerlModForGroup, PerlModGenerator::generatePerlModForMember, PerlModGenerator::generatePerlModForModule, PerlModGenerator::generatePerlModForNamespace, generateSqlite3ForClass, generateSqlite3ForConcept, generateSqlite3ForDir, generateSqlite3ForFile, generateSqlite3ForGroup, generateSqlite3ForMember, generateSqlite3ForModule, generateSqlite3ForNamespace, generateSqlite3ForPage, generateXMLForClass, generateXMLForConcept, generateXMLForDir, generateXMLForFile, generateXMLForGroup, generateXMLForMember, generateXMLForModule, generateXMLForNamespace, generateXMLForPage, DocPara::handleInheritDoc, inheritDocumentation, ModuleDefImpl::writeExports, ModuleDefImpl::writeFiles, MemberList::writePlainDeclarations, writeSingleFileIndex and VhdlDocGen::writeVHDLDeclaration.

briefDescriptionAsTooltip()

virtual QCString Definition::briefDescriptionAsTooltip ()

Returns a plain text version of the brief description suitable for use as a tool tip.

Definition at line 162 of file definition.h.

Referenced by DotClassGraph::addClass, DotGfxHierarchyTable::addHierarchy, DotInclDepGraph::buildGraph, common_attributes, DotCallGraph::DotCallGraph, DotClassGraph::DotClassGraph, DotGroupCollaboration::DotGroupCollaboration, DotInclDepGraph::DotInclDepGraph, DocParser::handleLinkedWord, writeMapArea, writeMultiLineCodeLink, writeMultiLineCodeLink, writeMultiLineCodeLink, writeMultiLineCodeLink and DocSets::writeToken.

briefFile()

virtual QCString Definition::briefFile ()

Returns the file in which the brief description was found. This can differ from getDefFileName().

Definition at line 180 of file definition.h.

Referenced by ClassDefImpl::addMemberToTemplateInstance, combineDeclarationAndDefinition, createTagLessInstance, createUsingMemberImportForClass, MemberGroup::distributeMemberGroupDocumentation, findFriends, findUsingDeclImports, generateBriefDoc, generateXMLForClass, generateXMLForConcept, generateXMLForDir, generateXMLForFile, generateXMLForGroup, generateXMLForMember, generateXMLForModule, generateXMLForNamespace, generateXMLForPage, inheritDocumentation, DocParser::processCopyDoc, writeSingleFileIndex, writeTemplateArgumentList and VhdlDocGen::writeVHDLDeclaration.

briefLine()

virtual int Definition::briefLine ()

Returns the line number at which the brief description was found.

Definition at line 165 of file definition.h.

codeSymbolType()

virtual CodeSymbolType Definition::codeSymbolType ()

Used for syntax highlighting symbol class

Definition at line 104 of file definition.h.

Referenced by ClassDefAliasImpl::codeSymbolType, ConceptDefAliasImpl::codeSymbolType, MemberDefAliasImpl::codeSymbolType, NamespaceDefAliasImpl::codeSymbolType, writeMultiLineCodeLink, writeMultiLineCodeLink, writeMultiLineCodeLink and writeMultiLineCodeLink.

definitionType()

virtual DefType Definition::definitionType ()

Use this for dynamic inspection of the type of the derived class

Definition at line 101 of file definition.h.

Referenced by addConceptToContext, DocSets::addIndexItem, ClassDefImpl::addInnerCompound, NamespaceDefImpl::addInnerCompound, PageDefImpl::addInnerCompound, MemberDefImpl::addListReference, MemberList::addListReferences, buildNamespaceList, codeFolding, definitionToName, DocLink::DocLink, DocRef::DocRef, dumpSymbol, findMemberLink, findModuleDef, findTagLessClasses, findUsingDeclImports, findUsingDirectives, SymbolResolver::Private::followPath, generateClassDocs, generateClassMemberLink, generateClassOrGlobalLink, generateClassOrGlobalLink, generateSqlite3Section, generateXMLForMember, getDefsNew, MemberDefImpl::getLabels, getMemberFromSymbol, SymbolResolver::Private::getResolvedSymbol, SymbolResolver::Private::getResolvedType, ClassDefImpl::getTemplateParameterLists, DocParser::handleLinkedWord, PageDefImpl::hasParentPage, GroupDefImpl::insertMember, NamespaceDefImpl::insertMember, insertMemberAlias, SymbolResolver::Private::isAccessibleFrom, SymbolResolver::Private::isAccessibleFromWithExpScope, linkifyText, makeQualifiedNameWithTemplateParameters, SearchTerm::makeTitle, memberVisible, ClassDefImpl::moveTo, MemberDefImpl::moveTo, SymbolResolver::Private::newResolveTypedef, DocParser::processCopyDoc, SymbolResolver::resolveClass, resolveClassNestingRelations, SymbolResolver::resolveSymbol, resolveTypeDef, scopeIsTemplate, searchTemplateSpecs, SearchIndex::setCurrentDoc, SearchIndexExternal::setCurrentDoc, updateCallContextForSmartPointer, validatingParseDoc, writeClassTree, writeDefArgumentList, MemberDefImpl::writeDocumentation, writeJavasScriptSearchDataPage, MemberDefImpl::writeMemberDocSimple, writeMemberToIndex and writeObjCMethodCall.

displayName()

virtual QCString Definition::displayName (bool includeScope=TRUE)

Returns the name of the definition as it appears in the output

Definition at line 118 of file definition.h.

Reference TRUE.

Referenced by MemberDefImpl::_writeCategoryRelation, MemberDefImpl::_writeReimplementedBy, MemberDefImpl::_writeReimplements, DotClassGraph::addClass, DotGfxHierarchyTable::addHierarchy, ConceptDefAliasImpl::displayName, MemberDefAliasImpl::displayName, DotClassGraph::DotClassGraph, generateClassOrGlobalLink, generateConceptDocs, generateSqlite3ForDir, generateXMLForDir, MemberDefImpl::getScopeString, recursivelyAddGroupListToTitle, writeClassLinkForMember, writeClassTree, writeClassTreeToOutput, MemberDefImpl::writeDeclaration, MemberList::writeDeclarations, MemberDefImpl::writeDocumentation, ModuleDefImpl::writeExports, ModuleDefImpl::writeFiles, ClassDefImpl::writeInheritanceGraph, MemberDefImpl::writeLink, writeMapArea, ClassDefImpl::writeMemberList, writeModuleLinkForMember, writeNamespaceLinkForMember and ClassDefImpl::writeTagFile.

docFile()

virtual QCString Definition::docFile ()

Returns the file in which the detailed documentation block was found. This can differ from getDefFileName().

Definition at line 154 of file definition.h.

Referenced by addMembersToMemberGroup, ClassDefImpl::addMemberToTemplateInstance, addRelatedPage, DocParser::checkArgumentName, combineDeclarationAndDefinition, computePageRelations, createTagLessInstance, createUsingMemberImportForClass, MemberGroup::distributeMemberGroupDocumentation, findFriends, findUsingDeclImports, PerlModGenerator::generatePerlModForPage, generateXMLForClass, generateXMLForConcept, generateXMLForDir, generateXMLForFile, generateXMLForGroup, generateXMLForMember, generateXMLForModule, generateXMLForNamespace, generateXMLForPage, generateXMLSection, getSQLDesc, getSQLDescCompound, inheritDocumentation, DocParser::processCopyDoc and writeTypeConstraints.

docLine()

virtual int Definition::docLine ()

Returns the line number at which the detailed documentation was found.

Definition at line 149 of file definition.h.

Referenced by ClassDefImpl::addMemberToTemplateInstance, DocParser::checkArgumentName, combineDeclarationAndDefinition, computePageRelations, createTagLessInstance, createUsingMemberImportForClass, MemberGroup::distributeMemberGroupDocumentation, findFriends, findUsingDeclImports, PerlModGenerator::generatePerlModForPage, generateXMLForClass, generateXMLForConcept, generateXMLForDir, generateXMLForFile, generateXMLForGroup, generateXMLForMember, generateXMLForModule, generateXMLForNamespace, generateXMLForPage, generateXMLSection, getSQLDesc, getSQLDescCompound, inheritDocumentation, DocParser::processCopyDoc and writeTypeConstraints.

documentation()

virtual QCString Definition::documentation ()

Returns the detailed description of this definition

Definition at line 146 of file definition.h.

externalReference()

virtual QCString Definition::externalReference (const QCString & relPath)

Convenience method to return a resolved external link

Definition at line 243 of file definition.h.

findInnerCompound()

virtual const Definition * Definition::findInnerCompound (const QCString & name)

Definition at line 271 of file definition.h.

Reference name.

Referenced by ClassDefAliasImpl::findInnerCompound, NamespaceDefAliasImpl::findInnerCompound, findScopeFromQualifiedName, SymbolResolver::Private::followPath, generateClassMemberLink and resolveTypeDef.

getBodyDef()

virtual const FileDef * Definition::getBodyDef ()

Returns the file in which the body of this item is located or 0 if no body is available.

Definition at line 261 of file definition.h.

Referenced by DefinitionImpl::_writeSourceRefList, addSourceReferences, combineDeclarationAndDefinition, createTagLessInstance, createUsingMemberImportForClass, findFriends, findMember, findUsingDeclImports, generateClassOrGlobalLink, generateSqlite3ForMember, generateXMLForClass, generateXMLForMember, getLink, getLinkInScope, insertMemberFunctionParams, writeDefArgumentList, writeExceptionListImpl, writeJavasScriptSearchDataPage and writeMemberReference.

getDefColumn()

virtual int Definition::getDefColumn ()

returns the column number at which the definition was found

Definition at line 192 of file definition.h.

Referenced by addVariableToFile, buildFunctionList, createTagLessInstance, findUsedClassesForClass, generateSqlite3ForClass, generateSqlite3ForConcept, generateSqlite3ForDir, generateSqlite3ForFile, generateSqlite3ForGroup, generateSqlite3ForMember, generateSqlite3ForModule, generateSqlite3ForNamespace, generateSqlite3ForPage, generateXMLForClass, generateXMLForConcept, generateXMLForMember, generateXMLForModule and generateXMLForNamespace.

getDefFileExtension()

virtual QCString Definition::getDefFileExtension ()

returns the extension of the file in which this definition was found

Definition at line 186 of file definition.h.

Referenced by getSQLDocBlock, HtmlDocVisitor::HtmlDocVisitor, DocbookGenerator::writeDoc, LatexGenerator::writeDoc, ManGenerator::writeDoc, RTFGenerator::writeDoc, writeXMLCodeBlock and writeXMLDocBlock.

getDefFileName()

virtual QCString Definition::getDefFileName ()

returns the file in which this definition was found

Definition at line 183 of file definition.h.

Referenced by addInstance, addVariableToFile, buildFunctionList, createTagLessInstance, dumpSymbol, findUsedClassesForClass, generateDEFForClass, generateDEFForFile, generateDEFForMember, generateDEFForNamespace, PerlModGenerator::generatePerlModForClass, PerlModGenerator::generatePerlModForConcept, PerlModGenerator::generatePerlModForFile, PerlModGenerator::generatePerlModForGroup, PerlModGenerator::generatePerlModForMember, PerlModGenerator::generatePerlModForModule, PerlModGenerator::generatePerlModForNamespace, generateSqlite3ForClass, generateSqlite3ForConcept, generateSqlite3ForDir, generateSqlite3ForFile, generateSqlite3ForGroup, generateSqlite3ForMember, generateSqlite3ForModule, generateSqlite3ForNamespace, generateSqlite3ForPage, generateXMLForClass, generateXMLForConcept, generateXMLForFile, generateXMLForMember, generateXMLForModule, generateXMLForNamespace, generateXMLForPage, genericCompareMembers, MemberDefImpl::init, ClassDefImpl::internalInsertMember, SearchTerm::makeTitle, SymbolResolver::Private::newResolveTypedef, resolveClassNestingRelations, writeDirTreeNode, writeExceptionListImpl, writeGroupTreeNode and writePages.

getDefLine()

virtual int Definition::getDefLine ()

returns the line number at which the definition was found (can be the declaration)

Definition at line 189 of file definition.h.

Referenced by addVariableToFile, buildFunctionList, combineDeclarationAndDefinition, createTagLessInstance, createUsingMemberImportForClass, dumpSymbol, findFriends, findMember, findUsedClassesForClass, findUsingDeclImports, generateDEFForClass, generateDEFForFile, generateDEFForMember, generateDEFForNamespace, PerlModGenerator::generatePerlModForClass, PerlModGenerator::generatePerlModForConcept, PerlModGenerator::generatePerlModForFile, PerlModGenerator::generatePerlModForGroup, PerlModGenerator::generatePerlModForMember, PerlModGenerator::generatePerlModForModule, PerlModGenerator::generatePerlModForNamespace, generateSqlite3ForClass, generateSqlite3ForConcept, generateSqlite3ForDir, generateSqlite3ForFile, generateSqlite3ForGroup, generateSqlite3ForMember, generateSqlite3ForModule, generateSqlite3ForNamespace, generateSqlite3ForPage, generateXMLForClass, generateXMLForConcept, generateXMLForMember, generateXMLForModule, generateXMLForNamespace, genericCompareMembers, ClassDefImpl::internalInsertMember, SearchTerm::makeTitle, resolveClassNestingRelations, writeDirTreeNode, writeExceptionListImpl, writeGroupTreeNode and writePages.

getEndBodyLine()

virtual int Definition::getEndBodyLine ()

Returns the last line of the body of this item (applicable to classes and functions).

Definition at line 256 of file definition.h.

Referenced by codeFolding, codeFolding, codeFolding, codeFolding, combineDeclarationAndDefinition, VhdlDocGen::createFlowChart, createTagLessInstance, createUsingMemberImportForClass, endCodeFold, findFriends, findMember, findUsingDeclImports, PerlModGenerator::generatePerlModForClass, generateSqlite3ForMember, generateXMLForClass, generateXMLForMember, writeMemberReference and VhdlDocGen::writeSource.

getLanguage()

virtual SrcLangExt Definition::getLanguage ()

Returns the programming language this definition was written in.

Definition at line 264 of file definition.h.

Referenced by SymbolResolver::Private::accessibleViaUsingNamespace, DocSets::addIndexItem, addMemberFunction, addMethodToClass, addVariableToClass, addVariableToFile, buildNamespaceList, classHasVisibleChildren, combineDeclarationAndDefinition, compoundIcon, computeMemberRelationsForBaseClass, computeTemplateClassRelations, createTagLessInstance, DotCallGraph::DotCallGraph, findFriends, findMembersWithSpecificName, findUsedClassesForClass, findUsingDirectives, generateDEFForMember, generateFileSources, PerlModGenerator::generatePerlModForMember, generateXMLForClass, generateXMLForFile, generateXMLForMember, generateXMLForNamespace, getCanonicalTypeForIdentifier, getDefsOld, getLink, SymbolResolver::Private::getResolvedSymbol, SymbolResolver::Private::getResolvedSymbolRec, SymbolResolver::Private::getResolvedTypeRec, MemberDefImpl::init, FileDefImpl::insertMember, GroupDefImpl::insertMember, NamespaceDefImpl::insertMember, linkifyText, makeDisplayName, makeDisplayName, makeQualifiedNameWithTemplateParameters, parseFilesMultiThreading, FileDefImpl::removeMember, SymbolResolver::resolveClass, resolveClassNestingRelations, SearchIndex::setCurrentDoc, transferFunctionReferences, transferRelatedFunctionDocumentation, GroupDefImpl::updateLanguage, validatingParseDoc, writeClassTree, writeClassTreeInsideNamespaceElement, writeClassTreeToOutput, writeDefArgumentList, FileDefImpl::writeIncludeFiles, writeJavasScriptSearchDataPage, ClassDefImpl::writeMemberList, writeMemberReference, writeNamespaceTreeElement, FileDefImpl::writeTagFile and MemberList::writeTagFile.

getOuterScope()

virtual Definition * Definition::getOuterScope ()

Definition at line 272 of file definition.h.

Referenced by SymbolResolver::Private::accessibleViaUsingNamespace, addEnumValuesToEnums, addMemberDocs, addVariableToFile, buildFunctionList, buildNamespaceList, checkPageRelations, combineDeclarationAndDefinition, computeMemberRelationsForBaseClass, ClassDefImpl::containsOverload, createTagLessInstance, DotCallGraph::DotCallGraph, dumpSymbol, findFriends, findMember, VhdlDocGen::findMember, findMemberLink, findMembersWithSpecificName, findTagLessClasses, findUsingDirectives, SymbolResolver::Private::followPath, generateClassDocs, generateClassMemberLink, generateClassOrGlobalLink, generateClassOrGlobalLink, generateClassOrGlobalLink, generateConceptDocs, PerlModGenerator::generatePerlModForMember, generateXMLForMember, getDefsOld, getLink, getLinkInScope, getLinkInScope, getResolvedConcept, SymbolResolver::Private::getResolvedSymbol, SymbolResolver::Private::getResolvedType, getSQLDesc, ClassDefImpl::getTemplateParameterLists, DocPara::handleInheritDoc, GroupDefImpl::insertMember, SymbolResolver::Private::isAccessibleFrom, SymbolResolver::Private::isAccessibleFromWithExpScope, isSymbolHidden, linkifyText, makeQualifiedNameWithTemplateParameters, ClassDefImpl::mergeMembersFromBaseClasses, SymbolResolver::Private::newResolveTypedef, resolveClassNestingRelations, resolveRef, resolveTemplateInstanceInType, resolveTypeDef, scopeIsTemplate, searchTemplateSpecs, setCallContextForVar, DefinitionImpl::setOuterScope, transferFunctionReferences, transferRelatedFunctionDocumentation, updateCallContextForSmartPointer, writeClassTree, writeClassTreeInsideNamespaceElement, writeConceptTreeInsideNamespaceElement, PageDefImpl::writeDocumentation, writeJavasScriptSearchDataPage, writeMemberToIndex, writeNamespaceTreeElement and VhdlDocGen::writeVHDLDeclaration.

getOutputFileBase()

virtual QCString Definition::getOutputFileBase ()

Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.

Definition at line 134 of file definition.h.

Referenced by MemberDefImpl::_writeCategoryRelation, MemberDefImpl::_writeGroupInclude, MemberDefImpl::_writeReimplementedBy, MemberDefImpl::_writeReimplements, DefinitionImpl::_writeSourceRefList, DotClassGraph::addClass, DotGfxHierarchyTable::addHierarchy, Crawlmap::addIndexItem, DocSets::addIndexItem, HtmlHelp::addIndexItem, Qhp::addIndexItem, addInstance, addRelatedPage, TooltipManager::addTooltip, DirDefImpl::addUsesDependency, associateAllClassMembers, DotInclDepGraph::buildGraph, classOutputFileBase, common_attributes, DocRef::DocRef, DotCallGraph::DotCallGraph, DotClassGraph::DotClassGraph, DotGroupCollaboration::DotGroupCollaboration, DotInclDepGraph::DotInclDepGraph, drawClusterOpening, drawDirectory, dumpSymbol, generateBriefDoc, generateDEFForClass, generateDEFForFile, generateDEFForMember, generateDEFForNamespace, generateFileRef, generateSqlite3ForClass, generateSqlite3ForConcept, generateSqlite3ForDir, generateSqlite3ForFile, generateSqlite3ForGroup, generateSqlite3ForMember, generateSqlite3ForModule, generateSqlite3ForNamespace, generateSqlite3ForPage, generateXMLForConcept, generateXMLForDir, generateXMLForFile, generateXMLForGroup, generateXMLForMember, generateXMLForModule, generateXMLForNamespace, generateXMLForPage, getLinkInScope, ClassDefAliasImpl::getOutputFileBase, ClassDefImpl::getOutputFileBase, ConceptDefAliasImpl::getOutputFileBase, MemberDefAliasImpl::getOutputFileBase, MemberDefImpl::getOutputFileBase, NamespaceDefAliasImpl::getOutputFileBase, PageDefImpl::getOutputFileBase, getUniqueId, DocParser::handleLinkedWord, insertMemberFunctionParams, insertMemberReference, FilePair::key, linkifyText, makeURL, memberOutputFileBase, node2URL, recursivelyAddGroupListToTitle, resolveUserReferences, SearchIndex::setCurrentDoc, SearchIndexExternal::setCurrentDoc, startCodeLine, startCodeLine, startCodeLine, startCodeLine, startCodeLine, startCodeLine, startCodeLine, validatingParseDoc, writeAlphabeticalClassList, writeClassLinkForMember, writeClassTree, writeClassTreeInsideNamespaceElement, writeClassTreeToOutput, writeConceptTreeInsideNamespaceElement, MemberDefImpl::writeDeclaration, MemberList::writeDeclarations, writeDirTreeNode, MemberList::writeDocumentationPage, writeDotDirDepGraph, ModuleDefImpl::writeExports, writeExports, writeFileLinkForMember, ModuleDefImpl::writeFiles, writeGroupTreeNode, FileDefImpl::writeIncludeFiles, writeIncludeInfo, ClassDefImpl::writeInheritanceGraph, writeJavasScriptSearchDataPage, MemberDefImpl::writeLink, writeLink, writeMapArea, MemberDefImpl::writeMemberDocSimple, ClassDefImpl::writeMemberList, writeMemberReference, writeMemberToIndex, writeModuleLinkForMember, writeModuleTreeNode, writeMultiLineCodeLink, writeMultiLineCodeLink, writeMultiLineCodeLink, writeMultiLineCodeLink, writeNamespaceLinkForMember, writeNamespaceTreeElement, writePages, writePartialDirPath, writePartialFilePath, ClassDefImpl::writeQuickMemberLinks, writeSingleFileIndex, FileDefImpl::writeTagFile, ModuleDefImpl::writeTagFile, VhdlDocGen::writeTagFile, DocSets::writeToken, VhdlDocGen::writeVHDLDeclaration and VhdlDocGen::writeVhdlLink.

getReference()

virtual QCString Definition::getReference ()

If this definition was imported via a tag file, this function returns the tagfile for the external project. This can be translated into an external link target via Doxygen::tagDestinationDict

Definition at line 237 of file definition.h.

getReferencedByMembers()

virtual const MemberVector & Definition::getReferencedByMembers ()

Definition at line 275 of file definition.h.

Referenced by DotCallGraph::buildGraph, generateDEFForMember, generateSqlite3ForMember, generateXMLForMember and DotCallGraph::isTrivial.

getReferencesMembers()

virtual const MemberVector & Definition::getReferencesMembers ()

Definition at line 274 of file definition.h.

Referenced by DotCallGraph::buildGraph, generateDEFForMember, generateSqlite3ForMember, generateXMLForMember and DotCallGraph::isTrivial.

getSectionRefs()

virtual const SectionRefs & Definition::getSectionRefs ()

returns the section dictionary, only of importance for pagedef

Definition at line 287 of file definition.h.

Referenced by generateXMLForPage.

getSourceAnchor()

virtual QCString Definition::getSourceAnchor ()

Returns the anchor of the source listing of this definition.

Definition at line 143 of file definition.h.

getSourceFileBase()

virtual QCString Definition::getSourceFileBase ()

Returns the name of the source listing of this definition.

Definition at line 140 of file definition.h.

Referenced by DefinitionImpl::_writeSourceRefList, DotInclDepGraph::buildGraph, DocLink::DocLink, DocRef::DocRef, FTVHelp::Private::generateTree, ClassDefAliasImpl::getSourceFileBase, DocParser::handleLinkedWord, node2URL and writeSingleFileIndex.

getStartBodyLine()

virtual int Definition::getStartBodyLine ()

Returns the first line of the body of this item (applicable to classes and functions).

Definition at line 251 of file definition.h.

Referenced by DefinitionImpl::_writeSourceRefList, addDefineDoc, addMemberDocs, addRelatedPage, buildFunctionList, combineDeclarationAndDefinition, VhdlDocGen::createFlowChart, createTagLessInstance, createUsingMemberImportForClass, findFriends, findMember, findMemFlow, findUsingDeclImports, PerlModGenerator::generatePerlModForClass, generateSqlite3ForMember, generateXMLForClass, generateXMLForMember, writeMemberReference and VhdlDocGen::writeSource.

getStartDefLine()

virtual int Definition::getStartDefLine ()

Returns the first line of the implementation of this item. See also getDefLine()

Definition at line 246 of file definition.h.

Referenced by addSourceReferences, codeFolding, codeFolding, codeFolding and codeFolding.

hasBriefDescription()

virtual bool Definition::hasBriefDescription ()

returns TRUE if this class has a brief description

Definition at line 282 of file definition.h.

hasDocumentation()

virtual bool Definition::hasDocumentation ()

Returns TRUE iff the definition is documented (which could be generated documentation)

See Also: hasUserDocumentation()

Definition at line 198 of file definition.h.

Referenced by addClassToContext, combineDeclarationAndDefinition, computeClassRelations, dirHasVisibleChildren, ClassDefAliasImpl::hasDocumentation, MemberDefAliasImpl::hasDocumentation and MemberDefImpl::writeEnumDeclaration.

hasSections()

virtual bool Definition::hasSections ()

Definition at line 277 of file definition.h.

Referenced by writePages.

hasSources()

virtual bool Definition::hasSources ()

Definition at line 278 of file definition.h.

hasUserDocumentation()

virtual bool Definition::hasUserDocumentation ()

Returns TRUE iff the definition is documented by the user.

Definition at line 201 of file definition.h.

Referenced by MemberDefAliasImpl::hasUserDocumentation.

id()

virtual QCString Definition::id ()

Definition at line 284 of file definition.h.

inbodyDocumentation()

virtual QCString Definition::inbodyDocumentation ()

Returns the documentation found inside the body of a member

Definition at line 168 of file definition.h.

Referenced by addDefineDoc, addEnumDocs, addMemberDocs, ClassDefImpl::addMemberToTemplateInstance, combineDeclarationAndDefinition, createUsingMemberImportForClass, MemberGroup::distributeMemberGroupDocumentation, findFriends, findUsingDeclImports, generateSqlite3ForMember, generateXMLForMember and inheritDocumentation.

inbodyFile()

virtual QCString Definition::inbodyFile ()

Returns the file in which the in body documentation was found

Definition at line 171 of file definition.h.

Referenced by ClassDefImpl::addMemberToTemplateInstance, combineDeclarationAndDefinition, createUsingMemberImportForClass, MemberGroup::distributeMemberGroupDocumentation, findFriends, findUsingDeclImports and inheritDocumentation.

inbodyLine()

virtual int Definition::inbodyLine ()

Returns the line at which the first in body documentation part was found

Definition at line 175 of file definition.h.

isAlias()

virtual bool Definition::isAlias ()

Returns TRUE if this is an alias of another definition

Definition at line 107 of file definition.h.

Referenced by MemberList::addListReferences and MemberGroup::insertMember.

isAnonymous()

virtual bool Definition::isAnonymous ()

Returns TRUE iff this definition has an artificially generated name (typically starting with a @) that is used for nameless definitions

Definition at line 115 of file definition.h.

Referenced by DotClassGraph::addClass, addEnumValuesToEnums, addVariableToFile, associateMember, findEnums, PerlModGenerator::generatePerlModForClass, PerlModGenerator::generatePerlModForMember, generateSqlite3ForClass, generateXMLForClass, MemberDefImpl::getOutputFileBase, makeDisplayName, makeDisplayName, writeClassTreeInsideNamespaceElement, writeConceptTreeInsideNamespaceElement, writeListOfAllMembers, ClassDefImpl::writeMemberList, writeMemberToIndex, writeNamespaceTreeElement and TooltipManager::writeTooltips.

isArtificial()

virtual bool Definition::isArtificial ()

Returns TRUE if this entity was artificially introduced, for instance because it is used to show a template instantiation relation.

Definition at line 227 of file definition.h.

Referenced by buildNamespaceList, findClassRelation, generateXMLForClass, SymbolResolver::Private::getResolvedSymbol, resolveTemplateInstanceInType, stripTemplateSpecifiersFromScope and ClassDefImpl::writeMemberList.

isExported()

virtual bool Definition::isExported ()

Returns TRUE iff this entity was exported from a C++20 module.

Definition at line 230 of file definition.h.

Referenced by ModuleDefImpl::addClassToModule, ModuleDefImpl::addConceptToModule and ModuleDefImpl::addMemberToModule.

isHidden()

virtual bool Definition::isHidden ()

Returns TRUE iff this item is supposed to be hidden from the output.

Definition at line 222 of file definition.h.

Referenced by DotClassGraph::addClass, GroupDefImpl::addClass, GroupDefImpl::addConcept, GroupDefImpl::addDir, GroupDefImpl::addExample, GroupDefImpl::addFile, DotGfxHierarchyTable::addHierarchy, GroupDefImpl::addModule, GroupDefImpl::addNamespace, GroupDefImpl::addPage, DotInclDepGraph::buildGraph, DotClassGraph::DotClassGraph, generateConceptDocs, generateSqlite3ForClass, generateSqlite3ForConcept, generateSqlite3ForMember, generateSqlite3ForModule, generateSqlite3ForNamespace, generateXMLForClass, generateXMLForConcept, generateXMLForMember, generateXMLForModule, generateXMLForNamespace, hasNonReferenceSuperClassRec, FileDefImpl::insertClass, FileDefImpl::insertConcept, FileDefImpl::insertMember, GroupDefImpl::insertMember, NamespaceDefImpl::insertMember, FileDefImpl::insertNamespace, ClassDefImpl::internalInsertMember, isSymbolHidden, SymbolResolver::resolveClass and DefinitionImpl::setOuterScope.

isLinkable()

virtual bool Definition::isLinkable ()

Returns TRUE iff it is possible to link to this item. This can be a link to another project imported via a tag file.

Definition at line 211 of file definition.h.

Referenced by MemberDefImpl::_countReimplementedBy, MemberDefImpl::_isReimplements, MemberDefImpl::_writeGroupInclude, MemberDefImpl::_writeReimplementedBy, MemberDefImpl::_writeReimplements, DefinitionImpl::_writeSourceRefList, DotClassGraph::addClass, addEnumValuesToEnums, DotGfxHierarchyTable::addHierarchy, DocSets::addIndexItem, addMemberToSearchIndex, DotInclDepGraph::buildGraph, classVisibleInIndex, computeMemberRelationsForBaseClass, ClassDefImpl::countInheritedDecMembers, DocRef::DocRef, DotClassGraph::DotClassGraph, TreeDiagram::drawBoxes, fileVisibleInIndex, findMembersWithSpecificName, generateClassMemberLink, generateClassOrGlobalLink, generateClassOrGlobalLink, generateClassOrGlobalLink, generateFileRef, generateFuncLink, generateLink, generateMemberLink, generateMemLink, getDefsOld, getFortranDefs, getLink, getLinkInScope, getLinkInScope, MemberDefImpl::getOutputFileBase, getScopeDefs, DocParser::handleLinkedWord, MemberDefImpl::hasDetailedDescription, MemberDefImpl::isDetailedSectionVisible, MemberDefImpl::isDocumentedFriendClass, ClassDefAliasImpl::isLinkable, ConceptDefAliasImpl::isLinkable, MemberDefAliasImpl::isLinkable, NamespaceDefAliasImpl::isLinkable, linkifyText, SymbolResolver::resolveClass, resolveLink, writeAlphabeticalClassList, writeClassTreeToOutput, ModuleDefImpl::writeExports, ModuleDefImpl::writeFiles, FileDefImpl::writeIncludeFiles, ClassDefImpl::writeInheritanceGraph, ClassDefImpl::writeInheritedMemberDeclarations, writeMapArea, ClassDefImpl::writeMemberList, writeNamespaceTreeElement, writeObjCMethodCall, writePartialFilePath, ClassDefImpl::writeQuickMemberLinks, VhdlDocGen::writeStringLink, ClassDefImpl::writeTagFile, FileDefImpl::writeTagFile and VhdlDocGen::writeVHDLTypeDocumentation.

isLinkableInProject()

virtual bool Definition::isLinkableInProject ()

Returns TRUE iff it is possible to link to this item within this project.

Definition at line 206 of file definition.h.

Referenced by MemberDefImpl::_computeLinkableInProject, MemberDefImpl::_writeReimplementedBy, MemberDefImpl::_writeReimplements, addClassAndNestedClasses, Index::addClassMemberNameToIndex, Index::addFileMemberNameToIndex, Index::addModuleMemberNameToIndex, Index::addNamespaceMemberNameToIndex, addSourceReferences, classVisibleInIndex, fileVisibleInIndex, generateConceptDocs, generateNamespaceConceptDocs, ClassDefImpl::getOutputFileBase, hasNonReferenceNestedGroupRec, hasNonReferenceNestedNamespaceRec, hasNonReferenceSuperClassRec, ClassDefImpl::isEmbeddedInOuterScope, ClassDefAliasImpl::isLinkableInProject, ConceptDefAliasImpl::isLinkableInProject, MemberDefAliasImpl::isLinkableInProject, NamespaceDefAliasImpl::isLinkableInProject, linkifyText, startCodeLine, startCodeLine, startCodeLine, startCodeLine, startCodeLine, startCodeLine, writeClassTreeInsideNamespaceElement, writeConceptTreeInsideNamespaceElement, writeExports, ClassDefImpl::writeQuickMemberLinks, writeSingleFileIndex and writeTagFile.

isLinkableViaGroup()

virtual bool Definition::isLinkableViaGroup ()

Definition at line 267 of file definition.h.

isReference()

virtual bool Definition::isReference ()

Returns TRUE if this definition is imported via a tag file.

Definition at line 240 of file definition.h.

Referenced by addRelatedPage, buildNamespaceList, computeClassRelations, findMembersWithSpecificName, generateDEFForClass, generateDEFForFile, generateDEFForNamespace, generateFileSources, PerlModGenerator::generatePerlModForClass, PerlModGenerator::generatePerlModForConcept, PerlModGenerator::generatePerlModForFile, PerlModGenerator::generatePerlModForGroup, PerlModGenerator::generatePerlModForModule, PerlModGenerator::generatePerlModForNamespace, PerlModGenerator::generatePerlModForPage, generateSqlite3ForClass, generateSqlite3ForConcept, generateSqlite3ForDir, generateSqlite3ForFile, generateSqlite3ForGroup, generateSqlite3ForMember, generateSqlite3ForModule, generateSqlite3ForNamespace, generateSqlite3ForPage, generateXMLForClass, generateXMLForConcept, generateXMLForDir, generateXMLForFile, generateXMLForGroup, generateXMLForModule, generateXMLForNamespace, generateXMLForPage, SymbolResolver::Private::getResolvedType, hasNonReferenceSuperClassRec, ClassDefAliasImpl::isReference, ConceptDefAliasImpl::isReference, MemberDefAliasImpl::isReference, parseFilesMultiThreading, parseFilesSingleThreading, DocParser::processCopyDoc, MemberList::setAnchors, writeClassTreeToOutput, writeDirTreeNode, writeGroupTreeNode, writeIncludeInfo, writeModuleTreeNode, writeSingleFileIndex and FileDefImpl::writeTagFile.

isVisible()

virtual bool Definition::isVisible ()

Returns TRUE iff the name may appear in the output

Definition at line 219 of file definition.h.

Referenced by writeGroupTreeNode.

isVisibleInProject()

virtual bool Definition::isVisibleInProject ()

Returns TRUE iff the name is part of this project and may appear in the output

Definition at line 216 of file definition.h.

localName()

virtual const QCString & Definition::localName ()

Returns the local name without any scope qualifiers.

Definition at line 121 of file definition.h.

Referenced by MemberDefImpl::_computeIsConstructor, ClassDefImpl::addInnerCompound, NamespaceDefImpl::addInnerCompound, findUsingDeclImports, getDefsOld, NamespaceDefImpl::insertMember, NamespaceDefAliasImpl::localName, makeDisplayName, makeQualifiedNameWithTemplateParameters, SearchTerm::makeTitle, searchTemplateSpecs, writeClassTreeInsideNamespaceElement, writeConceptTreeInsideNamespaceElement, writeJavasScriptSearchDataPage, writeNamespaceTreeElement and VhdlDocGen::writeVHDLDeclaration.

name()

virtual const QCString & Definition::name ()

Returns the name of the definition

Definition at line 110 of file definition.h.

navigationPathAsString()

virtual QCString Definition::navigationPathAsString ()

Definition at line 289 of file definition.h.

Referenced by endFileWithNavPath and DefinitionImpl::navigationPathAsString.

partOfGroups()

virtual const GroupList & Definition::partOfGroups ()

Definition at line 266 of file definition.h.

Referenced by DotGroupCollaboration::addCollaborationMember, DotGroupCollaboration::buildGraph, createTagLessInstance, distributeClassGroupRelations, recursivelyAddGroupListToTitle, writeClassTree, ClassLinkedRefMap::writeDocumentation, GroupDefImpl::writeDocumentation and writeNamespaceTreeElement.

pathFragment()

virtual QCString Definition::pathFragment ()

Definition at line 290 of file definition.h.

qualifiedName()

virtual QCString Definition::qualifiedName ()

Returns the fully qualified name of this definition

Definition at line 125 of file definition.h.

Referenced by ModuleDefImpl::addClassToModule, DotGroupCollaboration::addCollaborationMember, ModuleDefImpl::addConceptToModule, addEnumValuesToEnums, DocSets::addIndexItem, ModuleDefImpl::addMemberToModule, FileDefImpl::addUsingDeclaration, NamespaceDefImpl::addUsingDeclaration, FileDefImpl::addUsingDirective, NamespaceDefImpl::addUsingDirective, ModuleManager::collectExportedSymbolsRecursively, DotCallGraph::DotCallGraph, findGlobalMember, findUsingDeclImports, generateXMLForMember, genericCompareMembers, getCanonicalTypeForIdentifier, getLinkInScope, SymbolResolver::Private::getResolvedSymbol, SymbolResolver::Private::getResolvedType, linkifyText, makeQualifiedNameWithTemplateParameters, SymbolResolver::Private::newResolveTypedef, MemberDefAliasImpl::qualifiedName, resolveClassNestingRelations, ModuleManager::resolveImports, SymbolResolver::resolveSymbol, searchTemplateSpecs, SearchIndex::setCurrentDoc, SearchIndexExternal::setCurrentDoc, ModuleDefImpl::sortMemberLists, transferStaticInstanceInitializers, validatingParseDoc, MemberList::writeDocumentationPage, writeJavasScriptSearchDataPage, writeMemberToIndex, writeModuleTreeNode and VhdlDocGen::writeVHDLDeclaration.

symbolName()

virtual QCString Definition::symbolName ()

Returns the name of this definition as it appears in the symbol map.

Definition at line 129 of file definition.h.

Referenced by VhdlDocGen::findMemberDef.

xrefListItems()

virtual const RefItemVector & Definition::xrefListItems ()

Definition at line 269 of file definition.h.

Referenced by DefinitionImpl::mergeRefItems.

Private Member Functions

toDefinitionImpl_()

virtual const DefinitionImpl * Definition::toDefinitionImpl_ ()

Definition at line 302 of file definition.h.

Reference DefinitionImpl.

Referenced by DefinitionImpl::mergeReferencedBy and DefinitionImpl::mergeReferences.

toDefinitionMutable_()

virtual DefinitionMutable * Definition::toDefinitionMutable_ ()

Definition at line 301 of file definition.h.

Referenced by toDefinitionMutable.

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

Generated via doxygen2docusaurus by Doxygen 1.14.0.

Declaration​

Included Headers​

Derived Classes​

Enumerations Index​

Friends Index​

Public Member Functions Index​

Private Member Functions Index​

Description​

Enumerations​

DefType​

Friends​

DefinitionImpl​

toDefinitionMutable​

Public Member Functions​

_setSymbolName()​

_symbolName()​

anchor()​

briefDescription()​

briefDescriptionAsTooltip()​

briefFile()​

briefLine()​

codeSymbolType()​

definitionType()​

displayName()​

docFile()​

docLine()​

documentation()​

externalReference()​

findInnerCompound()​

getBodyDef()​

getDefColumn()​

getDefFileExtension()​

getDefFileName()​

getDefLine()​

getEndBodyLine()​

getLanguage()​

getOuterScope()​

getOutputFileBase()​

getReference()​

getReferencedByMembers()​

getReferencesMembers()​

getSectionRefs()​

getSourceAnchor()​

getSourceFileBase()​

getStartBodyLine()​

getStartDefLine()​

hasBriefDescription()​

hasDocumentation()​

hasSections()​

hasSources()​

hasUserDocumentation()​

id()​

inbodyDocumentation()​

inbodyFile()​

inbodyLine()​

isAlias()​

isAnonymous()​

isArtificial()​

isExported()​

isHidden()​

isLinkable()​

isLinkableInProject()​

isLinkableViaGroup()​

isReference()​

isVisible()​

isVisibleInProject()​

localName()​

name()​

navigationPathAsString()​

partOfGroups()​

pathFragment()​

qualifiedName()​

symbolName()​

xrefListItems()​

Private Member Functions​

toDefinitionImpl_()​

toDefinitionMutable_()​