Definition Class Reference

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

#include <src/definition.h>

Inheritance diagram for Definition:

Public Types
enum	DefType {   TypeClass = 0 , TypeFile = 1 , TypeNamespace = 2 , TypeModule = 3 ,   TypeMember = 4 , TypeGroup = 5 , TypePackage = 6 , TypePage = 7 ,   TypeDir = 8 , TypeConcept = 9 }

Public Member Functions
virtual DefType	definitionType () const =0
virtual CodeSymbolType	codeSymbolType () const =0
virtual bool	isAlias () const =0
virtual const QCString &	name () const =0
virtual bool	isAnonymous () const =0
virtual QCString	displayName (bool includeScope=TRUE) const =0
virtual const QCString &	localName () const =0
virtual QCString	qualifiedName () const =0
virtual QCString	symbolName () const =0
virtual QCString	getOutputFileBase () const =0
virtual QCString	anchor () const =0
virtual QCString	getSourceFileBase () const =0
virtual QCString	getSourceAnchor () const =0
virtual QCString	documentation () const =0
virtual int	docLine () const =0
virtual QCString	docFile () const =0
virtual QCString	briefDescription (bool abbreviate=FALSE) const =0
virtual QCString	briefDescriptionAsTooltip () const =0
virtual int	briefLine () const =0
virtual QCString	inbodyDocumentation () const =0
virtual QCString	inbodyFile () const =0
virtual int	inbodyLine () const =0
virtual QCString	briefFile () const =0
virtual QCString	getDefFileName () const =0
virtual QCString	getDefFileExtension () const =0
virtual int	getDefLine () const =0
virtual int	getDefColumn () const =0
virtual bool	hasDocumentation () const =0
virtual bool	hasUserDocumentation () const =0
virtual bool	isLinkableInProject () const =0
virtual bool	isLinkable () const =0
virtual bool	isVisibleInProject () const =0
virtual bool	isVisible () const =0
virtual bool	isHidden () const =0
virtual bool	isArtificial () const =0
virtual bool	isExported () const =0
virtual QCString	getReference () const =0
virtual bool	isReference () const =0
virtual QCString	externalReference (const QCString &relPath) const =0
virtual int	getStartDefLine () const =0
virtual int	getStartBodyLine () const =0
virtual int	getEndBodyLine () const =0
virtual const FileDef *	getBodyDef () const =0
virtual SrcLangExt	getLanguage () const =0
	Returns the programming language this definition was written in.
virtual const GroupList &	partOfGroups () const =0
virtual bool	isLinkableViaGroup () const =0
virtual const RefItemVector &	xrefListItems () const =0
virtual const Definition *	findInnerCompound (const QCString &name) const =0
virtual Definition *	getOuterScope () const =0
virtual const MemberVector &	getReferencesMembers () const =0
virtual const MemberVector &	getReferencedByMembers () const =0
virtual bool	hasSections () const =0
virtual bool	hasSources () const =0
virtual bool	hasBriefDescription () const =0
	returns TRUE if this class has a brief description
virtual QCString	id () const =0
virtual const SectionRefs &	getSectionRefs () const =0
	returns the section dictionary, only of importance for pagedef
virtual QCString	navigationPathAsString () const =0
virtual QCString	pathFragment () const =0
virtual void	_setSymbolName (const QCString &name)=0
virtual QCString	_symbolName () const =0

Private Member Functions
virtual DefinitionMutable *	toDefinitionMutable_ ()=0
virtual const DefinitionImpl *	toDefinitionImpl_ () const =0

Friends
class	DefinitionImpl
DefinitionMutable *	toDefinitionMutable (Definition *d)

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

Member Enumeration Documentation

DefType

enum Definition::DefType

Types of derived classes

Enumerator
TypeClass
TypeFile
TypeNamespace
TypeModule
TypeMember
TypeGroup
TypePackage
TypePage
TypeDir
TypeConcept

Definition at line 81 of file definition.h.

    {
      TypeClass      = 0,
      TypeFile       = 1,
      TypeNamespace  = 2,
      TypeModule     = 3,
      TypeMember     = 4,
      TypeGroup      = 5,
      TypePackage    = 6,
      TypePage       = 7,
      TypeDir        = 8,
      TypeConcept    = 9,
    };

Member Function Documentation

_setSymbolName()

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

pure virtual

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References name().

Referenced by addToMap().

_symbolName()

virtual QCString Definition::_symbolName ( ) const

pure virtual

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

anchor()

virtual QCString Definition::anchor ( ) const

pure virtual

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

Implemented in ClassDefAliasImpl, ClassDefImpl, ConceptDefAliasImpl, ConceptDefImpl, DirDefImpl, FileDefImpl, GroupDefImpl, MemberDefAliasImpl, MemberDefImpl, ModuleDefImpl, NamespaceDefAliasImpl, NamespaceDefImpl, and PageDefImpl.

Referenced by MemberDefImpl::_writeCategoryRelation(), MemberDefImpl::_writeGroupInclude(), MemberDefImpl::_writeReimplementedBy(), MemberDefImpl::_writeReimplements(), DefinitionImpl::_writeSourceRefList(), DotClassGraph::addClass(), ClassDefMutable::addExample(), MemberDefMutable::addExample(), DotGfxHierarchyTable::addHierarchy(), Crawlmap::addIndexItem(), DocSets::addIndexItem(), HtmlHelp::addIndexItem(), Qhp::addIndexItem(), TooltipManager::addTooltip(), ClassDefAliasImpl::anchor(), ConceptDefAliasImpl::anchor(), MemberDefAliasImpl::anchor(), NamespaceDefAliasImpl::anchor(), associateAllClassMembers(), DotCallGraph::DotCallGraph(), DotClassGraph::DotClassGraph(), dumpSymbol(), generateDEFForMember(), generateSqlite3ForMember(), generateXMLForMember(), MemberDefImpl::getOutputFileBase(), getUniqueId(), DocParser::handleLinkedWord(), if(), insertMemberFunctionParams(), insertMemberReference(), makeURL(), HtmlDocVisitor::operator()(), resolveLink(), validatingParseDoc(), writeClassLinkForMember(), writeClassTree(), writeClassTreeToOutput(), ClassDefImpl::writeDeclaration(), MemberDefImpl::writeDeclaration(), MemberList::writeDeclarations(), writeFileLinkForMember(), ModuleDefImpl::writeFiles(), ClassDefImpl::writeInheritanceGraph(), writeJavasScriptSearchDataPage(), writeLink(), writeListOfAllMembers(), writeMapArea(), MemberDefImpl::writeMemberDocSimple(), ClassDefImpl::writeMemberList(), writeMemberReference(), writeMemberToIndex(), writeModuleLinkForMember(), writeMultiLineCodeLink(), writeMultiLineCodeLink(), writeMultiLineCodeLink(), writeMultiLineCodeLink(), writeNamespaceLinkForMember(), ClassDefImpl::writeQuickMemberLinks(), VhdlDocGen::writeTagFile(), and VhdlDocGen::writeVHDLDeclaration().

briefDescription()

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

pure virtual

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

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< PageDef >, MemberDefAliasImpl, and MemberDefImpl.

References abbreviate(), and FALSE.

Referenced by MemberDefImpl::_writeEnumValues(), ClassDefImpl::addMembersToTemplateInstance(), 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 ( ) const

pure virtual

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

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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

pure virtual

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

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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

briefLine()

virtual int Definition::briefLine ( ) const

pure virtual

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

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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

codeSymbolType()

virtual CodeSymbolType Definition::codeSymbolType ( ) const

pure virtual

Used for syntax highlighting symbol class

Implemented in ClassDefAliasImpl, ClassDefImpl, ConceptDefAliasImpl, ConceptDefImpl, DirDefImpl, FileDefImpl, GroupDefImpl, MemberDefAliasImpl, MemberDefImpl, ModuleDefImpl, NamespaceDefAliasImpl, NamespaceDefImpl, and PageDefImpl.

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

definitionType()

virtual DefType Definition::definitionType ( ) const

pure virtual

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

Implemented in ClassDefAliasImpl, ClassDefImpl, ConceptDefAliasImpl, ConceptDefImpl, DirDefImpl, FileDefImpl, GroupDefImpl, MemberDefAliasImpl, MemberDefImpl, ModuleDefImpl, NamespaceDefAliasImpl, NamespaceDefImpl, and PageDefImpl.

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(), if(), GroupDefImpl::insertMember(), NamespaceDefImpl::insertMember(), insertMemberAlias(), SymbolResolver::Private::isAccessibleFrom(), SymbolResolver::Private::isAccessibleFromWithExpScope(), 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 ) const

pure virtual

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

Implemented in ClassDefAliasImpl, ClassDefImpl, ConceptDefAliasImpl, ConceptDefImpl, DirDefImpl, FileDefImpl, GroupDefImpl, MemberDefAliasImpl, MemberDefImpl, ModuleDefImpl, NamespaceDefAliasImpl, NamespaceDefImpl, and PageDefImpl.

References 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 ( ) const

pure virtual

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

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

Referenced by addMembersToMemberGroup(), ClassDefImpl::addMembersToTemplateInstance(), 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 ( ) const

pure virtual

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

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

Referenced by ClassDefImpl::addMembersToTemplateInstance(), 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 ( ) const

pure virtual

Returns the detailed description of this definition

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< PageDef >, MemberDefAliasImpl, and MemberDefImpl.

Referenced by MemberDefImpl::_writeEnumValues(), ClassDefImpl::addMembersToTemplateInstance(), buildFunctionList(), combineDeclarationAndDefinition(), createTagLessInstance(), createUsingMemberImportForClass(), MemberGroup::distributeMemberGroupDocumentation(), MemberDefAliasImpl::documentation(), DocParser::findDocsForMemberOrCompound(), findFriends(), findUsingDeclImports(), generateDEFForClass(), generateDEFForFile(), generateDEFForMember(), generateDEFForNamespace(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForConcept(), PerlModGenerator::generatePerlModForFile(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForMember(), PerlModGenerator::generatePerlModForModule(), PerlModGenerator::generatePerlModForNamespace(), PerlModGenerator::generatePerlModForPage(), generateSqlite3ForClass(), generateSqlite3ForConcept(), generateSqlite3ForDir(), generateSqlite3ForFile(), generateSqlite3ForGroup(), generateSqlite3ForMember(), generateSqlite3ForModule(), generateSqlite3ForNamespace(), generateSqlite3ForPage(), generateXMLForClass(), generateXMLForConcept(), generateXMLForDir(), generateXMLForFile(), generateXMLForGroup(), generateXMLForMember(), generateXMLForModule(), generateXMLForNamespace(), generateXMLForPage(), DocPara::handleInheritDoc(), inheritDocumentation(), and VhdlDocGen::writeSource().

externalReference()

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

pure virtual

Convenience method to return a resolved external link

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

findInnerCompound()

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

pure virtual

Implemented in ClassDefAliasImpl, ClassDefImpl, DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< PageDef >, NamespaceDefAliasImpl, and NamespaceDefImpl.

References name().

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

getBodyDef()

virtual const FileDef * Definition::getBodyDef ( ) const

pure virtual

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

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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

pure virtual

returns the column number at which the definition was found

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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

pure virtual

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

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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

getDefFileName()

virtual QCString Definition::getDefFileName ( ) const

pure virtual

returns the file in which this definition was found

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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(), SymbolResolver::Private::newResolveTypedef(), resolveClassNestingRelations(), writeDirTreeNode(), writeExceptionListImpl(), and writeGroupTreeNode().

getDefLine()

virtual int Definition::getDefLine ( ) const

pure virtual

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

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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(), resolveClassNestingRelations(), writeDirTreeNode(), writeExceptionListImpl(), and writeGroupTreeNode().

getEndBodyLine()

virtual int Definition::getEndBodyLine ( ) const

pure virtual

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

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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

pure virtual

Returns the programming language this definition was written in.

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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(), if(), MemberDefImpl::init(), FileDefImpl::insertMember(), GroupDefImpl::insertMember(), NamespaceDefImpl::insertMember(), 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 ( ) const

pure virtual

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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(), if(), GroupDefImpl::insertMember(), SymbolResolver::Private::isAccessibleFrom(), SymbolResolver::Private::isAccessibleFromWithExpScope(), isSymbolHidden(), 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 ( ) const

pure virtual

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

Implemented in ClassDefAliasImpl, ClassDefImpl, ConceptDefAliasImpl, ConceptDefImpl, DirDefImpl, FileDefImpl, GroupDefImpl, MemberDefAliasImpl, MemberDefImpl, ModuleDefImpl, NamespaceDefAliasImpl, NamespaceDefImpl, and PageDefImpl.

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(), if(), insertMemberFunctionParams(), insertMemberReference(), FilePair::key(), 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 ( ) const

pure virtual

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

Implemented in ClassDefAliasImpl, ClassDefImpl, ConceptDefAliasImpl, DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< PageDef >, MemberDefAliasImpl, and MemberDefImpl.

Referenced by MemberDefImpl::_writeCategoryRelation(), MemberDefImpl::_writeGroupInclude(), MemberDefImpl::_writeReimplementedBy(), MemberDefImpl::_writeReimplements(), DefinitionImpl::_writeSourceRefList(), DotClassGraph::addClass(), DotGfxHierarchyTable::addHierarchy(), addRelatedPage(), DotInclDepGraph::buildGraph(), DocLink::DocLink(), DocRef::DocRef(), DotClassGraph::DotClassGraph(), DotGroupCollaboration::DotGroupCollaboration(), DotInclDepGraph::DotInclDepGraph(), generateFileRef(), getLinkInScope(), ClassDefAliasImpl::getReference(), ConceptDefAliasImpl::getReference(), MemberDefAliasImpl::getReference(), MemberDefImpl::getReference(), getUniqueId(), DocParser::handleLinkedWord(), if(), makeURL(), recursivelyAddGroupListToTitle(), startCodeLine(), startCodeLine(), startCodeLine(), startCodeLine(), startCodeLine(), startCodeLine(), startCodeLine(), writeAlphabeticalClassList(), writeClassLinkForMember(), writeClassTree(), writeClassTreeInsideNamespaceElement(), writeClassTreeToOutput(), writeConceptTreeInsideNamespaceElement(), MemberList::writeDeclarations(), writeDirTreeNode(), ModuleDefImpl::writeExports(), writeFileLinkForMember(), ModuleDefImpl::writeFiles(), writeGroupTreeNode(), FileDefImpl::writeIncludeFiles(), ClassDefImpl::writeInheritanceGraph(), writeJavasScriptSearchDataPage(), MemberDefImpl::writeLink(), writeLink(), writeMapArea(), MemberDefImpl::writeMemberDocSimple(), ClassDefImpl::writeMemberList(), writeMemberToIndex(), writeModuleLinkForMember(), writeModuleTreeNode(), writeMultiLineCodeLink(), writeMultiLineCodeLink(), writeMultiLineCodeLink(), writeMultiLineCodeLink(), writeNamespaceLinkForMember(), writeNamespaceTreeElement(), writePages(), writePartialDirPath(), writePartialFilePath(), VhdlDocGen::writeVHDLDeclaration(), and VhdlDocGen::writeVhdlLink().

getReferencedByMembers()

virtual const MemberVector & Definition::getReferencedByMembers ( ) const

pure virtual

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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

getReferencesMembers()

virtual const MemberVector & Definition::getReferencesMembers ( ) const

pure virtual

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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

getSectionRefs()

virtual const SectionRefs & Definition::getSectionRefs ( ) const

pure virtual

returns the section dictionary, only of importance for pagedef

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

Referenced by generateXMLForPage().

getSourceAnchor()

virtual QCString Definition::getSourceAnchor ( ) const

pure virtual

Returns the anchor of the source listing of this definition.

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

getSourceFileBase()

virtual QCString Definition::getSourceFileBase ( ) const

pure virtual

Returns the name of the source listing of this definition.

Implemented in ClassDefAliasImpl, ClassDefImpl, DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< PageDef >, and FileDefImpl.

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

pure virtual

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

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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

pure virtual

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

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

Referenced by addSourceReferences(), codeFolding(), codeFolding(), codeFolding(), and codeFolding().

hasBriefDescription()

virtual bool Definition::hasBriefDescription ( ) const

pure virtual

returns TRUE if this class has a brief description

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

hasDocumentation()

virtual bool Definition::hasDocumentation ( ) const

pure virtual

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

See also

hasUserDocumentation()

Implemented in ClassDefAliasImpl, ClassDefImpl, DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< PageDef >, MemberDefAliasImpl, and MemberDefImpl.

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

hasSections()

virtual bool Definition::hasSections ( ) const

pure virtual

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

Referenced by writePages().

hasSources()

virtual bool Definition::hasSources ( ) const

pure virtual

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

hasUserDocumentation()

virtual bool Definition::hasUserDocumentation ( ) const

pure virtual

Returns TRUE iff the definition is documented by the user.

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< PageDef >, MemberDefAliasImpl, and MemberDefImpl.

Referenced by MemberDefAliasImpl::hasUserDocumentation().

id()

virtual QCString Definition::id ( ) const

pure virtual

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

inbodyDocumentation()

virtual QCString Definition::inbodyDocumentation ( ) const

pure virtual

Returns the documentation found inside the body of a member

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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

inbodyFile()

virtual QCString Definition::inbodyFile ( ) const

pure virtual

Returns the file in which the in body documentation was found

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

Referenced by ClassDefImpl::addMembersToTemplateInstance(), combineDeclarationAndDefinition(), createUsingMemberImportForClass(), MemberGroup::distributeMemberGroupDocumentation(), findFriends(), findUsingDeclImports(), and inheritDocumentation().

inbodyLine()

virtual int Definition::inbodyLine ( ) const

pure virtual

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

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

Referenced by ClassDefImpl::addMembersToTemplateInstance(), combineDeclarationAndDefinition(), createUsingMemberImportForClass(), MemberGroup::distributeMemberGroupDocumentation(), findFriends(), findUsingDeclImports(), generateXMLForMember(), and inheritDocumentation().

isAlias()

virtual bool Definition::isAlias ( ) const

pure virtual

Returns TRUE if this is an alias of another definition

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

Referenced by MemberList::addListReferences(), and MemberGroup::insertMember().

isAnonymous()

virtual bool Definition::isAnonymous ( ) const

pure virtual

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

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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

pure virtual

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

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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

isExported()

virtual bool Definition::isExported ( ) const

pure virtual

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

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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

isHidden()

virtual bool Definition::isHidden ( ) const

pure virtual

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

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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

pure virtual

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

Implemented in ClassDefAliasImpl, ClassDefImpl, ConceptDefAliasImpl, ConceptDefImpl, DirDefImpl, FileDefImpl, GroupDefImpl, MemberDefAliasImpl, MemberDefImpl, ModuleDefImpl, NamespaceDefAliasImpl, NamespaceDefImpl, and PageDefImpl.

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(), if(), MemberDefImpl::isDetailedSectionVisible(), MemberDefImpl::isDocumentedFriendClass(), ClassDefAliasImpl::isLinkable(), ConceptDefAliasImpl::isLinkable(), MemberDefAliasImpl::isLinkable(), NamespaceDefAliasImpl::isLinkable(), 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 ( ) const

pure virtual

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

Implemented in ClassDefAliasImpl, ClassDefImpl, ConceptDefAliasImpl, ConceptDefImpl, DirDefImpl, FileDefImpl, GroupDefImpl, MemberDefAliasImpl, MemberDefImpl, ModuleDefImpl, NamespaceDefAliasImpl, NamespaceDefImpl, and PageDefImpl.

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(), if(), ClassDefImpl::isEmbeddedInOuterScope(), ClassDefAliasImpl::isLinkableInProject(), ConceptDefAliasImpl::isLinkableInProject(), MemberDefAliasImpl::isLinkableInProject(), NamespaceDefAliasImpl::isLinkableInProject(), startCodeLine(), startCodeLine(), startCodeLine(), startCodeLine(), startCodeLine(), startCodeLine(), writeClassTreeInsideNamespaceElement(), writeConceptTreeInsideNamespaceElement(), writeExports(), ClassDefImpl::writeQuickMemberLinks(), writeSingleFileIndex(), and writeTagFile().

isLinkableViaGroup()

virtual bool Definition::isLinkableViaGroup ( ) const

pure virtual

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

isReference()

virtual bool Definition::isReference ( ) const

pure virtual

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

Implemented in ClassDefAliasImpl, ClassDefImpl, ConceptDefAliasImpl, DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< PageDef >, MemberDefAliasImpl, and MemberDefImpl.

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

pure virtual

Returns TRUE iff the name may appear in the output

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

Referenced by writeGroupTreeNode().

isVisibleInProject()

virtual bool Definition::isVisibleInProject ( ) const

pure virtual

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

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

localName()

virtual const QCString & Definition::localName ( ) const

pure virtual

Returns the local name without any scope qualifiers.

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< PageDef >, and NamespaceDefAliasImpl.

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

pure virtual

Returns the name of the definition

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< PageDef >, FileDefImpl, and MemberDefAliasImpl.

Referenced by _setSymbolName(), DefinitionImpl::_writeSourceRefList(), SymbolResolver::Private::accessibleViaUsingDefinition(), SymbolResolver::Private::accessibleViaUsingNamespace(), DotClassGraph::addClass(), GroupDefImpl::addClass(), Index::addClassMemberNameToIndex(), addClassToContext(), GroupDefImpl::addConcept(), addConceptToContext(), addEnumValuesToEnums(), ClassDefMutable::addExample(), GroupDefImpl::addExample(), MemberDefMutable::addExample(), Index::addFileMemberNameToIndex(), addGlobalFunction(), addGroupToGroups(), DotGfxHierarchyTable::addHierarchy(), addIncludeFile(), DocSets::addIndexItem(), HtmlHelp::addIndexItem(), Qhp::addIndexItem(), PageDefImpl::addInnerCompound(), addInstance(), PerlModGenerator::addListOfAllMembers(), MemberDefImpl::addListReference(), addMemberDocs(), addMemberFunction(), addMemberToGroups(), ClassDefImpl::addMemberToList(), addMemberToSearchIndex(), GroupDefImpl::addModule(), Index::addModuleMemberNameToIndex(), GroupDefImpl::addNamespace(), Index::addNamespaceMemberNameToIndex(), addOverloaded(), GroupDefImpl::addPage(), addPageToContext(), addRelatedPage(), addTemplateList(), addTemplateList(), DirDefImpl::addUsesDependency(), addVariableToClass(), addVariableToFile(), FlowChart::alignFuncProc(), buildExampleList(), buildFunctionList(), buildNamespaceList(), DocParser::checkArgumentName(), classInheritedProtectionLevel(), combineDeclarationAndDefinition(), compareFileDefs(), DirDefImpl::computeDependencies(), computePageRelations(), computeTemplateClassRelations(), ClassDefImpl::containsOverload(), FlowChart::convertNameToFileName(), VhdlDocGen::correctMemberProperties(), MemberList::countEnumValues(), createTagLessInstance(), createUsingMemberImportForClass(), ClassDef::deepCopy(), distributeConceptGroups(), DotCallGraph::DotCallGraph(), DotGroupCollaboration::DotGroupCollaboration(), dumpSymbol(), extractCanonicalType(), extractNamespaceName(), DocParser::findAndCopyImage(), VhdlDocGen::findArchitecture(), findClassRelation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findFriends(), findGlobalMember(), findGroupScope(), findInnerCompound(), findMember(), VhdlDocGen::findMember(), findMemberLink(), findMemFlow(), findScopeFromQualifiedName(), findTemplateInstanceRelation(), findUsedClassesForClass(), findUsingDeclarations(), findUsingDeclImports(), SymbolResolver::Private::followPath(), generateClassMemberLink(), generateClassMemberLink(), generateClassOrGlobalLink(), generateClassOrGlobalLink(), generateDEFForClass(), generateDEFForFile(), generateDEFForMember(), generateDEFForNamespace(), generateFuncLink(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForConcept(), PerlModGenerator::generatePerlModForFile(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForMember(), PerlModGenerator::generatePerlModForModule(), PerlModGenerator::generatePerlModForNamespace(), PerlModGenerator::generatePerlModForPage(), generateSqlite3ForClass(), generateSqlite3ForConcept(), generateSqlite3ForFile(), generateSqlite3ForGroup(), generateSqlite3ForMember(), generateSqlite3ForModule(), generateSqlite3ForNamespace(), generateSqlite3ForPage(), generateXMLForClass(), generateXMLForConcept(), generateXMLForDir(), generateXMLForFile(), generateXMLForGroup(), generateXMLForMember(), generateXMLForModule(), generateXMLForNamespace(), generateXMLForPage(), genericCompareMembers(), getCanonicalTypeForIdentifier(), MemberDefImpl::getClassDefOfAnonymousType(), VhdlDocGen::getClassName(), getDefs(), getDefsOld(), getFortranDefs(), getLinkInScope(), getResolvedConcept(), SymbolResolver::Private::getResolvedSymbol(), SymbolResolver::Private::getResolvedSymbolRec(), SymbolResolver::Private::getResolvedType(), SymbolResolver::Private::getResolvedTypeRec(), DocPara::handleInheritDoc(), DocParser::handleLinkedWord(), hasNonReferenceNestedGroupRec(), hasNonReferenceNestedNamespaceRec(), hasNonReferenceSuperClassRec(), if(), MemberDefImpl::init(), ClassDefMutable::insertBaseClass(), FileDefImpl::insertClass(), NamespaceDefImpl::insertClass(), FileDefImpl::insertConcept(), NamespaceDefImpl::insertConcept(), FileDefImpl::insertMember(), GroupDefImpl::insertMember(), NamespaceDefImpl::insertMember(), insertMemberAlias(), FileDefImpl::insertNamespace(), NamespaceDefImpl::insertNamespace(), ClassDefImpl::internalInsertMember(), SymbolResolver::isAccessibleFrom(), SymbolResolver::Private::isAccessibleFrom(), SymbolResolver::isAccessibleFromWithExpScope(), SymbolResolver::Private::isAccessibleFromWithExpScope(), ClassDefImpl::isBaseClass(), isEntryInGroupOfMember(), FileDef::isIncluded(), isStandardFunc(), ClassDefImpl::isSubClass(), VhdlDocGen::isSubClass(), isVarWithConstructor(), makeDisplayName(), makeTemplateInstanceRelation(), matchArgument2(), matchArguments2(), mergeCategories(), ClassDefImpl::mergeMembersFromBaseClasses(), minClassDistance(), MemberDefAliasImpl::name(), SymbolResolver::Private::newResolveTypedef(), normalizeNonTemplateArgumentsInString(), MemberDefImpl::objCMethodName(), HtmlDocVisitor::operator()(), organizeSubGroupsFiltered(), GroupDef::overrideGroupGraph(), CCodeParser::parseCode(), VHDLCodeParser::parseCode(), processTagLessClasses(), MemberDefImpl::qualifiedName(), GroupDefImpl::removeMember(), SymbolResolver::resolveClass(), resolveClassNestingRelations(), resolveLink(), ModuleManager::resolvePartitionsRecursively(), SymbolResolver::resolveSymbol(), resolveTemplateInstanceInType(), resolveTypeDef(), setCallContextForVar(), ClassDefMutable::setClassName(), SearchIndex::setCurrentDoc(), DirDef::setDiskName(), FileDef::setDiskName(), PageDef::setFileName(), MemberDefMutable::setFromAnonymousScope(), NamespaceDefMutable::setInline(), ConceptDefMutable::setModuleDef(), ClassDefMutable::sortAllMembersList(), FileDefImpl::sortMemberLists(), GroupDefImpl::sortMemberLists(), ModuleDefImpl::sortMemberLists(), NamespaceDefImpl::sortMemberLists(), startCodeLine(), startCodeLine(), startCodeLine(), startCodeLine(), startCodeLine(), stripClassName(), SymbolResolver::Private::substTypedef(), transferFunctionReferences(), transferRelatedFunctionDocumentation(), trimBaseClassScope(), validatingParseDoc(), MemberDefImpl::warnIfUndocumented(), writeClassTreeToOutput(), MemberDefImpl::writeDeclaration(), writeDefArgumentList(), ConceptDefImpl::writeDefinition(), writeDirTreeNode(), MemberDefImpl::writeDocumentation(), MemberList::writeDocumentationPage(), MemberDefImpl::writeEnumDeclaration(), writeExceptionListImpl(), writeFileLinkForMember(), writeGroupTreeNode(), ClassDefImpl::writeIncludeFilesForSlice(), writeJavasScriptSearchDataPage(), writeLink(), writeListOfAllMembers(), MemberDefImpl::writeMemberDocSimple(), ClassDefImpl::writeMemberList(), writeMemberReference(), writeMemberToIndex(), writeModuleTreeNode(), writeObjCMethodCall(), writePages(), writePartialFilePath(), VhdlDocGen::writePlainVHDLDeclarations(), ClassDefImpl::writeQuickMemberLinks(), VhdlDocGen::writeRecordUnit(), writeSingleFileIndex(), VhdlDocGen::writeStringLink(), FileDefImpl::writeTagFile(), VhdlDocGen::writeTagFile(), DocSets::writeToken(), writeUCFLink(), VhdlDocGen::writeVHDLDeclaration(), and VhdlDocGen::writeVHDLTypeDocumentation().

navigationPathAsString()

virtual QCString Definition::navigationPathAsString ( ) const

pure virtual

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

Referenced by endFileWithNavPath(), and DefinitionImpl::navigationPathAsString().

partOfGroups()

virtual const GroupList & Definition::partOfGroups ( ) const

pure virtual

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

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

pathFragment()

virtual QCString Definition::pathFragment ( ) const

pure virtual

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

qualifiedName()

virtual QCString Definition::qualifiedName ( ) const

pure virtual

Returns the fully qualified name of this definition

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< PageDef >, MemberDefAliasImpl, MemberDefImpl, and ModuleDefImpl.

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(), if(), 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 ( ) const

pure virtual

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

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

Referenced by VhdlDocGen::findMemberDef().

toDefinitionImpl_()

virtual const DefinitionImpl * Definition::toDefinitionImpl_ ( ) const

privatepure virtual

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References DefinitionImpl.

Referenced by DefinitionImpl::mergeReferencedBy(), and DefinitionImpl::mergeReferences().

toDefinitionMutable_()

virtual DefinitionMutable * Definition::toDefinitionMutable_ ( )

privatepure virtual

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

Referenced by toDefinitionMutable.

xrefListItems()

virtual const RefItemVector & Definition::xrefListItems ( ) const

pure virtual

Implemented in DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

Referenced by DefinitionImpl::mergeRefItems().

Friends And Related Symbol Documentation

DefinitionImpl

friend class DefinitionImpl

friend

Definition at line 299 of file definition.h.

References DefinitionImpl.

Referenced by DefinitionImpl, and toDefinitionImpl_().

toDefinitionMutable

DefinitionMutable * toDefinitionMutable ( Definition * d )

friend

Definition at line 1875 of file definition.cpp.

{
  if (d==nullptr) return nullptr;
  return d->toDefinitionMutable_();
}

References toDefinitionMutable_().

Referenced by PageDefImpl::writeDocumentation().

---

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

• src/definition.h