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

#include <definition.h>

类 Definition 继承关系图:

类
struct	Cookie

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

Public 成员函数
virtual DefType	definitionType () const =0

virtual CodeSymbolType	codeSymbolType () const =0

virtual bool	isAlias () const =0

virtual QCString	name () const =0

virtual bool	isAnonymous () const =0

virtual QCString	displayName (bool includeScope=TRUE) const =0

virtual 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 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

virtual	~Definition ()=default

Private 成员函数
virtual DefinitionMutable *	toDefinitionMutable_ ()=0

virtual const DefinitionImpl *	toDefinitionImpl_ () const =0

友元
class	DefinitionImpl

DefinitionMutable *	toDefinitionMutable (Definition *)

DefinitionMutable *	toDefinitionMutable (const Definition *)

详细描述

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.h 第 76 行定义.

成员枚举类型说明

◆ DefType

enum Definition::DefType

Types of derived classes

枚举值
TypeClass
TypeFile
TypeNamespace
TypeMember
TypeGroup
TypePackage
TypePage
TypeDir
TypeConcept

在文件 definition.h 第 85 行定义.

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

构造及析构函数说明

◆ ~Definition()

virtual Definition::~Definition ( )

virtualdefault

成员函数说明

◆ _setSymbolName()

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

pure virtual

在 DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionMixin< PageDef >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< FileDef >, DefinitionMixin< NamespaceDefMutable > , 以及 DefinitionMixin< DirDef > 内被实现.

被这些函数引用 addToMap().

◆ _symbolName()

virtual QCString Definition::_symbolName ( ) const

pure virtual

◆ anchor()

virtual QCString Definition::anchor ( ) const

pure virtual

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

在 ClassDef, DirDef, FileDef, MemberDef, NamespaceDef, GroupDef, ConceptDef, PageDef, ClassDefAliasImpl, MemberDefAliasImpl, ClassDefImpl, NamespaceDefAliasImpl, ConceptDefAliasImpl, MemberDefImpl, GroupDefImpl, FileDefImpl, NamespaceDefImpl, ConceptDefImpl, DirDefImpl , 以及 PageDefImpl 内被实现.

被这些函数引用 TooltipManager::addTooltip(), DefinitionContext< FileContext::Private >::anchor(), NestingNodeContext::Private::anchor(), NavPathElemContext::Private::anchor(), SymbolContext::Private::anchor(), DocParser::handleLinkedWord(), DefinitionImpl::navigationPathAsString(), validatingParseDoc(), writeJavaScriptSearchIndex() , 以及 TooltipManager::writeTooltips().

◆ briefDescription()

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

pure virtual

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

在 DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionMixin< PageDef >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< FileDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< DirDef >, MemberDef, MemberDefAliasImpl , 以及 MemberDefImpl 内被实现.

被这些函数引用 MemberDefImpl::_writeEnumValues(), DefinitionAliasMixin< ConceptDef >::briefDescription(), DefinitionContext< FileContext::Private >::createBrief(), NestingNodeContext::Private::createBrief(), createTagLessInstance(), DocParser::findDocsForMemberOrCompound(), generateBriefDoc(), generateDEFForClass(), generateDEFForFile(), generateDEFForNamespace(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForConcept(), PerlModGenerator::generatePerlModForFile(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForNamespace(), generateXMLForClass(), generateXMLForConcept(), generateXMLForDir(), generateXMLForFile(), generateXMLForGroup(), generateXMLForNamespace(), generateXMLForPage(), MemberList::writePlainDeclarations(), writeSingleFileIndex() , 以及 writeVhdlEntityToolTip().

◆ briefDescriptionAsTooltip()

virtual QCString Definition::briefDescriptionAsTooltip ( ) const

pure virtual

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

被这些函数引用 DotClassGraph::addClass(), DotGfxHierarchyTable::addHierarchy(), DefinitionAliasMixin< ConceptDef >::briefDescriptionAsTooltip(), DotInclDepGraph::buildGraph(), DotCallGraph::DotCallGraph(), DotClassGraph::DotClassGraph(), DotGroupCollaboration::DotGroupCollaboration(), DotInclDepGraph::DotInclDepGraph(), DocParser::handleLinkedWord(), writeColumn(), writeMapArea(), DocSets::writeToken() , 以及 TooltipManager::writeTooltips().

◆ briefFile()

virtual QCString Definition::briefFile ( ) const

pure virtual

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

被这些函数引用 ClassDefImpl::addMembersToTemplateInstance(), DefinitionAliasMixin< ConceptDef >::briefFile(), combineDeclarationAndDefinition(), DefinitionContext< FileContext::Private >::createBrief(), NestingNodeContext::Private::createBrief(), createTagLessInstance(), MemberGroup::distributeMemberGroupDocumentation(), findUsingDeclImports(), generateBriefDoc(), generateXMLForClass(), generateXMLForConcept(), generateXMLForDir(), generateXMLForFile(), generateXMLForGroup(), generateXMLForMember(), generateXMLForNamespace(), generateXMLForPage(), inheritDocumentation(), writeSingleFileIndex() , 以及 VhdlDocGen::writeVHDLDeclaration().

◆ briefLine()

virtual int Definition::briefLine ( ) const

pure virtual

◆ codeSymbolType()

virtual CodeSymbolType Definition::codeSymbolType ( ) const

pure virtual

Used for syntax highlighting symbol class

在 MemberDefAliasImpl, ClassDefAliasImpl, NamespaceDefAliasImpl, ClassDefImpl, ConceptDefAliasImpl, MemberDefImpl, GroupDefImpl, FileDefImpl, NamespaceDefImpl, DirDefImpl, ConceptDefImpl , 以及 PageDefImpl 内被实现.

被这些函数引用 ConceptDefAliasImpl::codeSymbolType(), NamespaceDefAliasImpl::codeSymbolType(), ClassDefAliasImpl::codeSymbolType() , 以及 MemberDefAliasImpl::codeSymbolType().

◆ definitionType()

virtual DefType Definition::definitionType ( ) const

pure virtual

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

在 ClassDef, DirDef, FileDef, NamespaceDef, GroupDef, MemberDef, ConceptDef, PageDef, MemberDefAliasImpl, ClassDefAliasImpl, NamespaceDefAliasImpl, ClassDefImpl, ConceptDefAliasImpl, MemberDefImpl, GroupDefImpl, FileDefImpl, NamespaceDefImpl, DirDefImpl, ConceptDefImpl , 以及 PageDefImpl 内被实现.

◆ displayName()

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

pure virtual

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

在 MemberDef, DirDef, FileDef, NamespaceDef, GroupDef, PageDef, MemberDefImpl, NamespaceDefImpl, GroupDefImpl, PageDefImpl, FileDefImpl, DirDefImpl, ClassDef, ConceptDef, ClassDefAliasImpl, ClassDefImpl, ConceptDefAliasImpl, ConceptDefImpl, MemberDefAliasImpl , 以及 NamespaceDefAliasImpl 内被实现.

被这些函数引用 DefinitionContext< FileContext::Private >::bareName(), DefinitionImpl::briefDescription(), SymbolContext::Private::createScope(), DefinitionContext< FileContext::Private >::DefinitionContext(), DefinitionContext< FileContext::Private >::name(), NestingNodeContext::Private::name(), MemberDefImpl::writeDeclaration() , 以及 MemberDefImpl::writeDocumentation().

◆ docFile()

virtual QCString Definition::docFile ( ) const

pure virtual

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

被这些函数引用 addMembersToMemberGroup(), ClassDefImpl::addMembersToTemplateInstance(), addRelatedPage(), DocParser::checkArgumentName(), combineDeclarationAndDefinition(), computePageRelations(), DefinitionContext< FileContext::Private >::createDetails(), ArgumentContext::Private::createDocs(), PageContext::Private::createExample(), MemberContext::Private::createParamDocs(), createTagLessInstance(), MemberGroup::distributeMemberGroupDocumentation(), DefinitionAliasMixin< ConceptDef >::docFile(), findUsingDeclImports(), PerlModGenerator::generatePerlModForPage(), generateXMLForClass(), generateXMLForConcept(), generateXMLForDir(), generateXMLForFile(), generateXMLForGroup(), generateXMLForMember(), generateXMLForNamespace(), generateXMLForPage(), generateXMLSection(), inheritDocumentation(), parseCode() , 以及 writeTypeConstraints().

◆ docLine()

virtual int Definition::docLine ( ) const

pure virtual

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

被这些函数引用 ClassDefImpl::addMembersToTemplateInstance(), DocParser::checkArgumentName(), combineDeclarationAndDefinition(), computePageRelations(), DefinitionContext< FileContext::Private >::createDetails(), ArgumentContext::Private::createDocs(), PageContext::Private::createExample(), MemberContext::Private::createParamDocs(), createTagLessInstance(), MemberGroup::distributeMemberGroupDocumentation(), DefinitionAliasMixin< ConceptDef >::docLine(), findUsingDeclImports(), PerlModGenerator::generatePerlModForPage(), generateXMLForClass(), generateXMLForConcept(), generateXMLForDir(), generateXMLForFile(), generateXMLForGroup(), generateXMLForMember(), generateXMLForNamespace(), generateXMLForPage(), generateXMLSection(), inheritDocumentation() , 以及 writeTypeConstraints().

◆ documentation()

virtual QCString Definition::documentation ( ) const

pure virtual

Returns the detailed description of this definition

在 MemberDef, MemberDefAliasImpl , 以及 MemberDefImpl 内被实现.

被这些函数引用 MemberDefImpl::_writeEnumValues(), DefinitionContext< FileContext::Private >::createDetails(), createTagLessInstance(), DefinitionAliasMixin< ConceptDef >::documentation(), DocParser::findDocsForMemberOrCompound(), generateDEFForClass(), generateDEFForFile(), generateDEFForNamespace(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForConcept(), PerlModGenerator::generatePerlModForFile(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForNamespace(), PerlModGenerator::generatePerlModForPage(), generateXMLForClass(), generateXMLForConcept(), generateXMLForDir(), generateXMLForFile(), generateXMLForGroup(), generateXMLForNamespace(), generateXMLForPage() , 以及 MemberList::writeDeclarations().

◆ externalReference()

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

pure virtual

Convenience method to return a resolved external link

在 DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionMixin< PageDef >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< FileDef >, DefinitionMixin< NamespaceDefMutable > , 以及 DefinitionMixin< DirDef > 内被实现.

被这些函数引用 DefinitionAliasMixin< ConceptDef >::externalReference(), DefinitionContext< FileContext::Private >::externalReference(), NestingNodeContext::Private::externalReference() , 以及 NavPathElemContext::Private::externalReference().

◆ findInnerCompound()

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

pure virtual

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

被这些函数引用 DefinitionImpl::_writeSourceRefList(), addSourceReferences(), combineDeclarationAndDefinition(), createLinkedText(), SymbolContext::Private::createScope(), MemberContext::Private::createSourceCode(), createTagLessInstance(), DefinitionContext< FileContext::Private >::DefinitionContext(), findMember(), findUsingDeclImports(), generateXMLForClass(), generateXMLForMember(), DefinitionAliasMixin< ConceptDef >::getBodyDef(), parseCode(), writeDefArgumentList(), writeExceptionListImpl(), writeJavaScriptSearchIndex(), writeMemberReference() , 以及 TooltipManager::writeTooltips().

◆ getDefColumn()

virtual int Definition::getDefColumn ( ) const

pure virtual

returns the column number at which the definition was found

被这些函数引用 addVariableToFile(), createTagLessInstance(), findUsedClassesForClass(), generateXMLForClass(), generateXMLForConcept(), generateXMLForMember(), generateXMLForNamespace() , 以及 DefinitionAliasMixin< ConceptDef >::getDefColumn().

◆ getDefFileExtension()

virtual QCString Definition::getDefFileExtension ( ) const

pure virtual

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

被这些函数引用 DefinitionAliasMixin< ConceptDef >::getDefFileExtension(), HtmlDocVisitor::HtmlDocVisitor(), parseCode(), parseDoc(), ManGenerator::writeDoc(), RTFGenerator::writeDoc(), LatexGenerator::writeDoc(), DocbookGenerator::writeDoc(), writeXMLCodeBlock() , 以及 writeXMLDocBlock().

◆ getDefFileName()

virtual QCString Definition::getDefFileName ( ) const

pure virtual

returns the file in which this definition was found

被这些函数引用 addInstance(), addMemberFunction(), addVariableToFile(), DocParser::checkArgumentName(), DocParser::checkRetvalName(), DocParser::checkUnOrMultipleDocumentedParams(), createTagLessInstance(), dumpSymbol(), findGlobalMember(), findUsedClassesForClass(), formatBriefNote(), generateDEFForClass(), generateDEFForFile(), generateDEFForMember(), generateDEFForNamespace(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForConcept(), PerlModGenerator::generatePerlModForFile(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForMember(), PerlModGenerator::generatePerlModForNamespace(), generateXMLForClass(), generateXMLForConcept(), generateXMLForFile(), generateXMLForMember(), generateXMLForNamespace(), generateXMLForPage(), genericCompareMembers(), DefinitionAliasMixin< ConceptDef >::getDefFileName(), MemberDefImpl::IMPL::init(), ClassDefImpl::internalInsertMember(), SymbolResolver::Private::newResolveTypedef(), resolveClassNestingRelations(), writeDirTreeNode(), writeExceptionListImpl() , 以及 writeGroupTreeNode().

◆ getDefLine()

virtual int Definition::getDefLine ( ) const

pure virtual

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

被这些函数引用 addMemberFunction(), addVariableToFile(), DocParser::checkArgumentName(), DocParser::checkRetvalName(), DocParser::checkUnOrMultipleDocumentedParams(), combineDeclarationAndDefinition(), createTagLessInstance(), dumpSymbol(), findGlobalMember(), findMember(), findUsedClassesForClass(), findUsingDeclImports(), generateDEFForClass(), generateDEFForFile(), generateDEFForMember(), generateDEFForNamespace(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForConcept(), PerlModGenerator::generatePerlModForFile(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForMember(), PerlModGenerator::generatePerlModForNamespace(), generateXMLForClass(), generateXMLForConcept(), generateXMLForMember(), generateXMLForNamespace(), genericCompareMembers(), DefinitionAliasMixin< ConceptDef >::getDefLine(), ClassDefImpl::internalInsertMember(), resolveClassNestingRelations(), writeDirTreeNode(), writeExceptionListImpl() , 以及 writeGroupTreeNode().

◆ getEndBodyLine()

virtual int Definition::getEndBodyLine ( ) const

pure virtual

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

被这些函数引用 combineDeclarationAndDefinition(), VhdlDocGen::createFlowChart(), MemberContext::Private::createSourceCode(), createTagLessInstance(), findMember(), findUsingDeclImports(), PerlModGenerator::generatePerlModForClass(), generateXMLForClass(), generateXMLForMember(), DefinitionAliasMixin< ConceptDef >::getEndBodyLine(), writeMemberReference() , 以及 VhdlDocGen::writeSource().

◆ getLanguage()

virtual SrcLangExt Definition::getLanguage ( ) const

pure virtual

Returns the programming language this definition was written in.

◆ getOuterScope()

virtual Definition* Definition::getOuterScope ( ) const

pure virtual

被这些函数引用 SymbolResolver::Private::accessibleViaUsingNamespace(), NestingContext::Private::addClass(), NestingContext::Private::addConcept(), addEnumValuesToEnums(), addMemberDocs(), NestingContext::Private::addNamespace(), NestingContext::Private::addPage(), addSourceReferences(), ClassContext::Private::addTemplateDecls(), addVariableToFile(), buildNamespaceList(), checkPageRelations(), combineDeclarationAndDefinition(), computeMemberRelations(), DefinitionImpl::computeTooltip(), ConceptContext::Private::createInitializerAsCode(), MemberContext::Private::createLabels(), createLinkedText(), DefinitionContext< FileContext::Private >::createNavigationPath(), SymbolContext::Private::createScope(), createTagLessInstance(), DotCallGraph::DotCallGraph(), dumpSymbol(), DefinitionContext< FileContext::Private >::fillPath(), findGlobalMember(), VhdlDocGen::findMember(), findMember(), findMembersWithSpecificName(), findTagLessClasses(), findUsingDirectives(), generateClassList(), generateConceptDocs(), PerlModGenerator::generatePerlModForMember(), generateXMLForMember(), getDefs(), getResolvedConcept(), SymbolResolver::Private::getResolvedSymbol(), ClassDefImpl::getTemplateParameterLists(), DocPara::handleInheritDoc(), GroupDefImpl::insertMember(), SymbolResolver::Private::isAccessibleFrom(), SymbolResolver::Private::isAccessibleFromWithExpScope(), isSymbolHidden(), linkifyText(), makeQualifiedNameWithTemplateParameters(), ClassDefImpl::mergeMembers(), SymbolResolver::Private::newResolveTypedef(), resolveClassNestingRelations(), resolveRef(), resolveTypeDef(), scopeIsTemplate(), searchTemplateSpecs(), DefinitionImpl::setOuterScope(), transferFunctionReferences(), transferRelatedFunctionDocumentation(), writeClassTree(), writeClassTreeInsideNamespaceElement(), writeConceptTreeInsideNamespaceElement(), writeJavaScriptSearchIndex(), writeMemberToIndex(), writeNamespaceTreeElement() , 以及 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.

在 ClassDef, DirDef, FileDef, MemberDef, NamespaceDef, GroupDef, PageDef, ConceptDef, MemberDefAliasImpl, ClassDefAliasImpl, NamespaceDefAliasImpl, ClassDefImpl, ConceptDefAliasImpl, MemberDefImpl, GroupDefImpl, FileDefImpl, NamespaceDefImpl, DirDefImpl, ConceptDefImpl , 以及 PageDefImpl 内被实现.

被这些函数引用 Qhp::addIndexItem(), DocSets::addIndexItem(), HtmlHelp::addIndexItem(), MemberGroup::addListReferences(), DefinitionImpl::addSectionsToIndex(), TooltipManager::addTooltip(), DocLink::DocLink(), DocRef::DocRef(), dumpSymbol(), DefinitionContext< FileContext::Private >::fileName(), NestingNodeContext::Private::fileName(), NavPathElemContext::Private::fileName(), SymbolContext::Private::fileName(), generateBriefDoc(), generateLink(), ClassDefImpl::getOutputFileBase(), DocParser::handleLinkedWord(), DefinitionImpl::navigationPathAsString(), SearchIndex::setCurrentDoc(), SearchIndexExternal::setCurrentDoc(), LayoutNavEntry::url(), validatingParseDoc(), writeJavaScriptSearchIndex(), writeMemberToIndex(), DocSets::writeToken(), TooltipManager::writeTooltips() , 以及 VhdlDocGen::writeVHDLDeclaration().

◆ 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

在 ClassDef, MemberDef, MemberDefAliasImpl, ClassDefAliasImpl, ClassDefImpl, ConceptDefAliasImpl , 以及 MemberDefImpl 内被实现.

被这些函数引用 MemberDefImpl::_writeGroupInclude(), addRelatedPage(), DotInclDepGraph::buildGraph(), DocLink::DocLink(), DocRef::DocRef(), DotGroupCollaboration::DotGroupCollaboration(), DotInclDepGraph::DotInclDepGraph(), generateFileRef(), generateLink(), MemberDefImpl::getReference(), ConceptDefAliasImpl::getReference(), DefinitionAliasMixin< ConceptDef >::getReference(), DocParser::handleLinkedWord(), linkifyText(), SymbolContext::Private::relPath(), writeAlphabeticalClassList(), writeClassTreeInsideNamespaceElement(), writeConceptTreeInsideNamespaceElement(), writeDirTreeNode(), writeGroupTreeNode(), FileDefImpl::writeIncludeFiles(), writeJavaScriptSearchIndex(), MemberDefImpl::writeLink(), writeMemberToIndex(), writeNamespaceTreeElement(), writePages(), writePartialDirPath(), writePartialFilePath() , 以及 TooltipManager::writeTooltips().

◆ getReferencedByMembers()

virtual const MemberVector& Definition::getReferencedByMembers ( ) const

pure virtual

被这些函数引用 DotCallGraph::buildGraph(), MemberContext::Private::createSourceRefBys(), generateDEFForMember(), generateXMLForMember(), DefinitionAliasMixin< ConceptDef >::getReferencedByMembers() , 以及 DotCallGraph::isTrivial().

◆ getReferencesMembers()

virtual const MemberVector& Definition::getReferencesMembers ( ) const

pure virtual

被这些函数引用 DotCallGraph::buildGraph(), MemberContext::Private::createSourceRefs(), generateDEFForMember(), generateXMLForMember(), DefinitionAliasMixin< ConceptDef >::getReferencesMembers() , 以及 DotCallGraph::isTrivial().

◆ getSectionRefs()

virtual const SectionRefs& Definition::getSectionRefs ( ) const

pure virtual

returns the section dictionary, only of importance for pagedef

被这些函数引用 generateXMLForPage() , 以及 DefinitionAliasMixin< ConceptDef >::getSectionRefs().

◆ getSourceAnchor()

virtual QCString Definition::getSourceAnchor ( ) const

pure virtual

Returns the anchor of the source listing of this definition.

被这些函数引用 DefinitionContext< FileContext::Private >::DefinitionContext(), DefinitionAliasMixin< ConceptDef >::getSourceAnchor() , 以及 TooltipManager::writeTooltips().

◆ getSourceFileBase()

virtual QCString Definition::getSourceFileBase ( ) const

pure virtual

Returns the name of the source listing of this definition.

在 ClassDef, FileDef, ClassDefAliasImpl, ClassDefImpl , 以及 FileDefImpl 内被实现.

被这些函数引用 DefinitionContext< FileContext::Private >::DefinitionContext(), DocLink::DocLink(), DocRef::DocRef(), DefinitionAliasMixin< ConceptDef >::getSourceFileBase(), DocParser::handleLinkedWord(), DefinitionContext< FileContext::Private >::sourceFileName() , 以及 TooltipManager::writeTooltips().

◆ getStartBodyLine()

virtual int Definition::getStartBodyLine ( ) const

pure virtual

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

被这些函数引用 DefinitionImpl::_writeSourceRefList(), addMemberDocs(), addRelatedPage(), combineDeclarationAndDefinition(), VhdlDocGen::createFlowChart(), MemberContext::Private::createSourceCode(), createTagLessInstance(), DefinitionContext< FileContext::Private >::DefinitionContext(), findMember(), findMemFlow(), findUsingDeclImports(), PerlModGenerator::generatePerlModForClass(), generateXMLForClass(), generateXMLForMember(), DefinitionAliasMixin< ConceptDef >::getStartBodyLine(), writeMemberReference(), VhdlDocGen::writeSource() , 以及 TooltipManager::writeTooltips().

◆ getStartDefLine()

virtual int Definition::getStartDefLine ( ) const

pure virtual

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

被这些函数引用 addSourceReferences() , 以及 DefinitionAliasMixin< ConceptDef >::getStartDefLine().

◆ hasBriefDescription()

virtual bool Definition::hasBriefDescription ( ) const

pure virtual

returns TRUE if this class has a brief description

被这些函数引用 DefinitionContext< FileContext::Private >::createBrief(), NestingNodeContext::Private::createBrief() , 以及 DefinitionAliasMixin< ConceptDef >::hasBriefDescription().

◆ hasDocumentation()

virtual bool Definition::hasDocumentation ( ) const

pure virtual

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

参见: hasUserDocumentation()

在 MemberDef, ClassDef, MemberDefAliasImpl, ClassDefAliasImpl, MemberDefImpl , 以及 ClassDefImpl 内被实现.

被这些函数引用 dirHasVisibleChildren() , 以及 DefinitionAliasMixin< ConceptDef >::hasDocumentation().

◆ hasSections()

virtual bool Definition::hasSections ( ) const

pure virtual

被这些函数引用 DefinitionAliasMixin< ConceptDef >::hasSections() , 以及 writePages().

◆ hasSources()

virtual bool Definition::hasSources ( ) const

pure virtual

被这些函数引用 DefinitionAliasMixin< ConceptDef >::hasSources() , 以及 MemberContext::Private::hasSources().

◆ hasUserDocumentation()

virtual bool Definition::hasUserDocumentation ( ) const

pure virtual

Returns TRUE iff the definition is documented by the user.

被这些函数引用 DefinitionAliasMixin< ConceptDef >::hasUserDocumentation().

◆ id()

virtual QCString Definition::id ( ) const

pure virtual

被这些函数引用 DefinitionAliasMixin< ConceptDef >::id().

◆ inbodyDocumentation()

virtual QCString Definition::inbodyDocumentation ( ) const

pure virtual

Returns the documentation found inside the body of a member

被这些函数引用 addEnumDocs(), addMemberDocs(), ClassDefImpl::addMembersToTemplateInstance(), combineDeclarationAndDefinition(), DefinitionContext< FileContext::Private >::createInbodyDocs(), MemberGroup::distributeMemberGroupDocumentation(), findDefineDocumentation(), findUsingDeclImports(), generateXMLForMember(), DefinitionAliasMixin< ConceptDef >::inbodyDocumentation() , 以及 inheritDocumentation().

◆ inbodyFile()

virtual QCString Definition::inbodyFile ( ) const

pure virtual

Returns the file in which the in body documentation was found

被这些函数引用 ClassDefImpl::addMembersToTemplateInstance(), combineDeclarationAndDefinition(), DefinitionContext< FileContext::Private >::createInbodyDocs(), MemberGroup::distributeMemberGroupDocumentation(), findUsingDeclImports(), DefinitionAliasMixin< ConceptDef >::inbodyFile() , 以及 inheritDocumentation().

◆ inbodyLine()

virtual int Definition::inbodyLine ( ) const

pure virtual

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

被这些函数引用 ClassDefImpl::addMembersToTemplateInstance(), combineDeclarationAndDefinition(), DefinitionContext< FileContext::Private >::createInbodyDocs(), MemberGroup::distributeMemberGroupDocumentation(), findUsingDeclImports(), generateXMLForMember(), DefinitionAliasMixin< ConceptDef >::inbodyLine() , 以及 inheritDocumentation().

◆ isAlias()

virtual bool Definition::isAlias ( ) const

pure virtual

Returns TRUE if this is an alias of another definition

被这些函数引用 MemberList::addListReferences(), findGlobalMember() , 以及 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

被这些函数引用 DotClassGraph::addClass(), addEnumValuesToEnums(), NestingContext::Private::addNamespace(), addToIndices(), addVariableToFile(), findEnums(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForMember(), generateXMLForClass(), MemberDefImpl::getOutputFileBase(), DefinitionAliasMixin< ConceptDef >::isAnonymous(), MemberContext::Private::isAnonymous(), makeDisplayName(), AllMembersListContext::Private::Private(), writeClassTreeInsideNamespaceElement(), writeConceptTreeInsideNamespaceElement(), writeListOfAllMembers(), ClassDefImpl::writeMemberList(), writeMemberToIndex(), writeNamespaceTreeElement() , 以及 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.

被这些函数引用 buildNamespaceList(), findClassRelation(), generateXMLForClass(), DefinitionAliasMixin< ConceptDef >::isArtificial(), AllMembersListContext::Private::Private() , 以及 ClassDefImpl::writeMemberList().

◆ isHidden()

virtual bool Definition::isHidden ( ) const

pure virtual

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

被这些函数引用 DotClassGraph::addClass(), GroupDefImpl::addClass(), GroupDefImpl::addConcept(), GroupDefImpl::addDir(), GroupDefImpl::addExample(), GroupDefImpl::addFile(), DotGfxHierarchyTable::addHierarchy(), GroupDefImpl::addNamespace(), GroupDefImpl::addPage(), DotInclDepGraph::buildGraph(), DotClassGraph::DotClassGraph(), generateClassList(), generateConceptDocs(), generateNamespaceClassDocs(), generateNamespaceConceptDocs(), generateXMLForClass(), generateXMLForConcept(), generateXMLForMember(), generateXMLForNamespace(), FileDefImpl::insertClass(), FileDefImpl::insertConcept(), NamespaceDefImpl::insertMember(), GroupDefImpl::insertMember(), FileDefImpl::insertMember(), FileDefImpl::insertNamespace(), ClassDefImpl::internalInsertMember(), DefinitionAliasMixin< ConceptDef >::isHidden(), isSymbolHidden(), SymbolResolver::resolveClass() , 以及 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.

在 ClassDef, MemberDef, DirDef, FileDef, GroupDef, NamespaceDef, ConceptDef, PageDef, MemberDefAliasImpl, ClassDefAliasImpl, NamespaceDefAliasImpl, MemberDefImpl, ClassDefImpl, ConceptDefAliasImpl, GroupDefImpl, NamespaceDefImpl, FileDefImpl, ConceptDefImpl, DirDefImpl , 以及 PageDefImpl 内被实现.

被这些函数引用 DocSets::addIndexItem(), DocLink::DocLink(), DocRef::DocRef(), DocParser::handleLinkedWord(), DefinitionContext< FileContext::Private >::isLinkable(), NestingNodeContext::Private::isLinkable(), NavPathElemContext::Private::isLinkable(), DefinitionImpl::isVisible(), DefinitionImpl::navigationPathAsString(), DefinitionImpl::pathFragment() , 以及 LayoutNavEntry::url().

◆ isLinkableInProject()

virtual bool Definition::isLinkableInProject ( ) const

pure virtual

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

在 ClassDef, MemberDef, DirDef, FileDef, GroupDef, NamespaceDef, ConceptDef, PageDef, MemberDefAliasImpl, ClassDefAliasImpl, NamespaceDefAliasImpl, MemberDefImpl, ClassDefImpl, ConceptDefAliasImpl, GroupDefImpl, NamespaceDefImpl, FileDefImpl, ConceptDefImpl, DirDefImpl , 以及 PageDefImpl 内被实现.

被这些函数引用 ClassDefImpl::getOutputFileBase(), DefinitionContext< FileContext::Private >::isLinkableInProject() , 以及 DefinitionImpl::isVisibleInProject().

◆ isLinkableViaGroup()

virtual bool Definition::isLinkableViaGroup ( ) const

pure virtual

被这些函数引用 DefinitionAliasMixin< ConceptDef >::isLinkableViaGroup().

◆ isReference()

virtual bool Definition::isReference ( ) const

pure virtual

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

在 MemberDef, ClassDef, MemberDefAliasImpl, ClassDefAliasImpl, MemberDefImpl, ClassDefImpl , 以及 ConceptDefAliasImpl 内被实现.

◆ isVisible()

virtual bool Definition::isVisible ( ) const

pure virtual

Returns TRUE iff the name may appear in the output

被这些函数引用 DefinitionAliasMixin< ConceptDef >::isVisible() , 以及 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

被这些函数引用 DefinitionAliasMixin< ConceptDef >::isVisibleInProject().

◆ localName()

virtual QCString Definition::localName ( ) const

pure virtual

Returns the local name without any scope qualifiers.

在 NamespaceDef, NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 MemberDefImpl::_computeIsConstructor(), NamespaceDefImpl::addInnerCompound(), ClassDefImpl::addInnerCompound(), addToIndices(), SymbolContext::Private::createScope(), getDefs(), NamespaceDefImpl::insertMember(), DefinitionAliasMixin< ConceptDef >::localName(), makeQualifiedNameWithTemplateParameters(), DefinitionAliasImpl::qualifiedName(), searchName(), searchTemplateSpecs(), NavPathElemContext::Private::text(), writeJavaScriptSearchIndex() , 以及 VhdlDocGen::writeVHDLDeclaration().

◆ name()

virtual QCString Definition::name ( ) const

pure virtual

Returns the name of the definition

在 FileDef, MemberDefAliasImpl , 以及 FileDefImpl 内被实现.

被这些函数引用 DefinitionImpl::_writeSourceRefList(), DotClassGraph::addClass(), GroupDefImpl::addClass(), addClassMemberNameToIndex(), addClassToContext(), GroupDefImpl::addConcept(), addConceptToContext(), GroupDefImpl::addExample(), addFileMemberNameToIndex(), addGroupToGroups(), DotGfxHierarchyTable::addHierarchy(), Qhp::addIndexItem(), DocSets::addIndexItem(), HtmlHelp::addIndexItem(), PageDefImpl::addInnerCompound(), addInstance(), PerlModGenerator::addListOfAllMembers(), MemberDefImpl::addListReference(), addMemberDocs(), addMemberFunction(), addMemberToGroups(), addMemberToSearchIndex(), GroupDefImpl::addNamespace(), addNamespaceMemberNameToIndex(), addOverloaded(), GroupDefImpl::addPage(), addPageToContext(), addRelatedPage(), DefinitionImpl::addSourceReferencedBy(), DefinitionImpl::addSourceReferences(), addTemplateList(), addVariableToFile(), FlowChart::alignFuncProc(), buildExampleList(), DotCallGraph::buildGraph(), buildNamespaceList(), DocParser::checkArgumentName(), classInheritedProtectionLevel(), computePageRelations(), computeTemplateClassRelations(), FlowChart::convertNameToFileName(), VhdlDocGen::correctMemberProperties(), MemberList::countEnumValues(), PageContext::Private::createExample(), MemberContext::Private::createInitializerAsCode(), ConceptContext::Private::createInitializerAsCode(), MemberContext::Private::createSourceCode(), createTagLessInstance(), DefinitionContext< FileContext::Private >::DefinitionContext(), DotCallGraph::DotCallGraph(), DotGroupCollaboration::DotGroupCollaboration(), dumpSymbol(), extractNamespaceName(), VhdlDocGen::findArchitecture(), findClassRelation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findGlobalMember(), findGroupScope(), VhdlDocGen::findMember(), findMember(), findMemFlow(), findScopeFromQualifiedName(), findTemplateInstanceRelation(), findUsedClassesForClass(), findUsingDeclarations(), generateClassList(), generateConceptDocs(), generateDEFForClass(), generateDEFForMember(), generateDEFForNamespace(), generateNamespaceClassDocs(), generateNamespaceConceptDocs(), generateNamespaceDocs(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForConcept(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForMember(), PerlModGenerator::generatePerlModForNamespace(), PerlModGenerator::generatePerlModForPage(), generateXMLForClass(), generateXMLForConcept(), generateXMLForDir(), generateXMLForGroup(), generateXMLForMember(), generateXMLForNamespace(), generateXMLForPage(), genericCompareMembers(), getCanonicalTypeForIdentifier(), MemberDefImpl::getClassDefOfAnonymousType(), VhdlDocGen::getClassName(), getDefs(), SymbolResolver::Private::getResolvedClassRec(), getResolvedConcept(), DocPara::handleInheritDoc(), MemberContext::Private::handleNameWithContextFor(), MemberDefImpl::IMPL::init(), NamespaceDefImpl::insertClass(), FileDefImpl::insertClass(), NamespaceDefImpl::insertConcept(), FileDefImpl::insertConcept(), NamespaceDefImpl::insertMember(), GroupDefImpl::insertMember(), FileDefImpl::insertMember(), NamespaceDefImpl::insertNamespace(), FileDefImpl::insertNamespace(), ClassDefImpl::internalInsertMember(), SymbolResolver::Private::isAccessibleFromWithExpScope(), ClassDefImpl::isBaseClass(), isStandardFunc(), VhdlDocGen::isSubClass(), ClassDefImpl::isSubClass(), DiagramItem::label(), linkifyText(), makeDisplayName(), mergeCategories(), ClassDefImpl::mergeMembers(), minClassDistance(), MemberDefAliasImpl::name(), normalizeNonTemplateArgumentsInString(), MemberDefImpl::objCMethodName(), DocXRefItem::parse(), processTagLessClasses(), DefinitionImpl::qualifiedName(), MemberDefImpl::qualifiedName(), GroupDefImpl::removeMember(), resolveClassNestingRelations(), resolveLink(), ScopedTypeVariant::ScopedTypeVariant(), SearchIndex::setCurrentDoc(), ScopedTypeVariant::setGlobal(), NamespaceDefImpl::sortMemberLists(), GroupDefImpl::sortMemberLists(), FileDefImpl::sortMemberLists(), PageContext::Private::title(), transferRelatedFunctionDocumentation(), trimBaseClassScope(), validatingParseDoc(), HtmlDocVisitor::visitPre(), MemberDefImpl::warnIfUndocumented(), writeClassToDot(), writeClassTree(), writeClassTreeToOutput(), writeColumn(), MemberDefImpl::writeDeclaration(), writeDefArgumentList(), ConceptDefImpl::writeDefinition(), writeDirTreeNode(), MemberDefImpl::writeDocumentation(), MemberList::writeDocumentationPage(), MemberDefImpl::writeEnumDeclaration(), writeExceptionListImpl(), writeGroupTreeNode(), ClassDefImpl::writeIncludeFilesForSlice(), writeJavaScriptSearchIndex(), writeLink(), writeListOfAllMembers(), MemberDefImpl::writeMemberDocSimple(), ClassDefImpl::writeMemberList(), writeMemberReference(), writeMemberToIndex(), VhdlDocGen::writeOverview(), writePages(), VhdlDocGen::writePlainVHDLDeclarations(), ClassDefImpl::writeQuickMemberLinks(), VhdlDocGen::writeRecordUnit(), VhdlDocGen::writeStringLink(), VhdlDocGen::writeTagFile(), ClassDefImpl::writeTagFile(), DocSets::writeToken(), writeUCFLink(), VhdlDocGen::writeVHDLDeclaration(), writeVhdlEntityToolTip() , 以及 VhdlDocGen::writeVHDLTypeDocumentation().

◆ navigationPathAsString()

virtual QCString Definition::navigationPathAsString ( ) const

pure virtual

被这些函数引用 endFileWithNavPath(), DefinitionImpl::navigationPathAsString() , 以及 DefinitionAliasMixin< ConceptDef >::navigationPathAsString().

◆ partOfGroups()

virtual const GroupList& Definition::partOfGroups ( ) const

pure virtual

被这些函数引用 DotGroupCollaboration::addCollaborationMember(), NestingNodeContext::Private::addMembers(), DotGroupCollaboration::buildGraph(), DefinitionContext< FileContext::Private >::createPartOfGroups(), createTagLessInstance(), distributeClassGroupRelations(), NestingNodeContext::Private::partOfGroup(), DefinitionAliasMixin< ConceptDef >::partOfGroups(), recursivelyAddGroupListToTitle(), writeClassTree(), ClassLinkedRefMap::writeDocumentation() , 以及 writeNamespaceTreeElement().

◆ pathFragment()

virtual QCString Definition::pathFragment ( ) const

pure virtual

被这些函数引用 DefinitionImpl::pathFragment(), DefinitionAliasMixin< ConceptDef >::pathFragment() , 以及 DirRelation::writeDocumentation().

◆ qualifiedName()

virtual QCString Definition::qualifiedName ( ) const

pure virtual

Returns the fully qualified name of this definition

在 MemberDef, MemberDefAliasImpl , 以及 MemberDefImpl 内被实现.

被这些函数引用 DotGroupCollaboration::addCollaborationMember(), DocSets::addIndexItem(), NamespaceDefImpl::addUsingDeclaration(), FileDefImpl::addUsingDeclaration(), NamespaceDefImpl::addUsingDirective(), FileDefImpl::addUsingDirective(), SymbolContext::Private::createScope(), findGlobalMember(), getCanonicalTypeForIdentifier(), SymbolResolver::Private::getResolvedSymbol(), makeQualifiedNameWithTemplateParameters(), SymbolResolver::Private::newResolveTypedef(), DefinitionImpl::qualifiedName(), DefinitionAliasImpl::qualifiedName(), resolveClassNestingRelations(), searchTemplateSpecs(), SearchIndex::setCurrentDoc(), SearchIndexExternal::setCurrentDoc(), writeJavaScriptSearchIndex() , 以及 TooltipManager::writeTooltips().

◆ symbolName()

virtual QCString Definition::symbolName ( ) const

pure virtual

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

被这些函数引用 VhdlDocGen::findMemberDef() , 以及 DefinitionAliasMixin< ConceptDef >::symbolName().

◆ toDefinitionImpl_()

virtual const DefinitionImpl* Definition::toDefinitionImpl_ ( ) const

privatepure virtual

被这些函数引用 DefinitionImpl::mergeReferencedBy() , 以及 DefinitionImpl::mergeReferences().

◆ toDefinitionMutable_()

virtual DefinitionMutable* Definition::toDefinitionMutable_ ( )

privatepure virtual

在 DefinitionAliasMixin< MemberDef >, DefinitionAliasMixin< NamespaceDef >, DefinitionAliasMixin< ClassDef >, DefinitionAliasMixin< ConceptDef >, DefinitionMixin< PageDef >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ClassDefMutable >, DefinitionMixin< FileDef >, DefinitionMixin< NamespaceDefMutable > , 以及 DefinitionMixin< DirDef > 内被实现.

被这些函数引用 toDefinitionMutable().

◆ xrefListItems()

virtual const RefItemVector& Definition::xrefListItems ( ) const

pure virtual

被这些函数引用 DefinitionImpl::mergeRefItems() , 以及 DefinitionAliasMixin< ConceptDef >::xrefListItems().

友元及相关函数文档

◆ DefinitionImpl

friend class DefinitionImpl

friend

在文件 definition.h 第 301 行定义.

◆ toDefinitionMutable [1/2]

DefinitionMutable* toDefinitionMutable ( const Definition * )

friend

在文件 definition.cpp 第 1962 行定义.

 {
   return toDefinitionMutable(const_cast<Definition*>(d));
 }

◆ toDefinitionMutable [2/2]

DefinitionMutable* toDefinitionMutable ( Definition * )

friend

在文件 definition.cpp 第 1956 行定义.

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

被这些函数引用 PageDefImpl::writeDocumentation().

该类的文档由以下文件生成:

src/definition.h

类

Public 类型

Public 成员函数

Private 成员函数

友元

详细描述

成员枚举类型说明

◆ DefType

构造及析构函数说明

◆ ~Definition()

成员函数说明

◆ _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()

◆ isHidden()

◆ isLinkable()

◆ isLinkableInProject()

◆ isLinkableViaGroup()

◆ isReference()

◆ isVisible()

◆ isVisibleInProject()

◆ localName()

◆ name()

◆ navigationPathAsString()

◆ partOfGroups()

◆ pathFragment()

◆ qualifiedName()

◆ symbolName()

◆ toDefinitionImpl_()

◆ toDefinitionMutable_()

◆ xrefListItems()

友元及相关函数文档

◆ DefinitionImpl

◆ toDefinitionMutable [1/2]

◆ toDefinitionMutable [2/2]