Doxygen
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Friends | List of all members
DefinitionMutable Class Referenceabstract

#include <src/definition.h>

+ Inheritance diagram for DefinitionMutable:

Public Member Functions

virtual void setName (const QCString &name)=0
 
virtual void setId (const QCString &name)=0
 
virtual void setDefFile (const QCString &df, int defLine, int defColumn)=0
 
virtual void setDocumentation (const QCString &d, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)=0
 
virtual void setBriefDescription (const QCString &b, const QCString &briefFile, int briefLine)=0
 
virtual void setInbodyDocumentation (const QCString &d, const QCString &docFile, int docLine)=0
 
virtual void setReference (const QCString &r)=0
 
virtual void setBodySegment (int defLine, int bls, int ble)=0
 
virtual void setBodyDef (const FileDef *fd)=0
 
virtual void setRefItems (const RefItemVector &sli)=0
 
virtual void setOuterScope (Definition *d)=0
 
virtual void setHidden (bool b)=0
 
virtual void setArtificial (bool b)=0
 
virtual void setExported (bool b)=0
 
virtual void setLanguage (SrcLangExt lang)=0
 
virtual void setLocalName (const QCString &name)=0
 
virtual void makePartOfGroup (GroupDef *gd)=0
 
virtual void addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)=0
 
virtual void addSourceReferencedBy (MemberDef *d, const QCString &sourceRefName)=0
 
virtual void addSourceReferences (MemberDef *d, const QCString &sourceRefName)=0
 
virtual void mergeRefItems (Definition *d)=0
 
virtual void addInnerCompound (Definition *d)=0
 
virtual void mergeReferences (const Definition *other)=0
 
virtual void mergeReferencedBy (const Definition *other)=0
 
virtual void computeTooltip ()=0
 
virtual void writeSourceDef (OutputList &ol) const =0
 
virtual void writeInlineCode (OutputList &ol, const QCString &scopeName) const =0
 
virtual bool hasSourceRefs () const =0
 
virtual bool hasSourceReffedBy () const =0
 
virtual void writeSourceRefs (OutputList &ol, const QCString &scopeName) const =0
 
virtual void writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const =0
 
virtual void writeNavigationPath (OutputList &ol) const =0
 
virtual void writeQuickMemberLinks (OutputList &, const MemberDef *) const =0
 
virtual void writeSummaryLinks (OutputList &) const =0
 
virtual void writeDocAnchorsToTagFile (TextStream &) const =0
 
virtual void writeToc (OutputList &ol, const LocalToc &lt) const =0
 

Private Member Functions

virtual Definition * toDefinition_ ()=0
 

Friends

Definition * toDefinition (DefinitionMutable *dm)
 

Detailed Description

Definition at line 305 of file definition.h.

Member Function Documentation

◆ addInnerCompound()

virtual void DefinitionMutable::addInnerCompound ( Definition * d)
pure virtual

Implemented in ClassDefImpl, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< PageDef >, NamespaceDefImpl, and PageDefImpl.

References addInnerCompound().

Referenced by addConceptToContext(), addInnerCompound(), buildNamespaceList(), buildScopeFromQualifiedName(), computePageRelations(), createTagLessInstance(), findUsingDeclImports(), ClassDefImpl::insertTemplateInstance(), and resolveClassNestingRelations().

◆ addSectionsToDefinition()

virtual void DefinitionMutable::addSectionsToDefinition ( const std::vector< const SectionInfo * > & anchorList)
pure virtual

Add the list of anchors that mark the sections that are found in the documentation.

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References addSectionsToDefinition().

Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), addEnumDocs(), addMemberDocs(), addRelatedPage(), addSectionsToDefinition(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), anonymous_namespace{tagreader.cpp}::TagFileParser::buildLists(), buildNamespaceList(), buildTypedefList(), and findUsingDirectives().

◆ addSourceReferencedBy()

virtual void DefinitionMutable::addSourceReferencedBy ( MemberDef * d,
const QCString & sourceRefName )
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References addSourceReferencedBy().

Referenced by addDocCrossReference(), and addSourceReferencedBy().

◆ addSourceReferences()

virtual void DefinitionMutable::addSourceReferences ( MemberDef * d,
const QCString & sourceRefName )
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References addSourceReferences().

Referenced by addDocCrossReference(), and addSourceReferences().

◆ computeTooltip()

virtual void DefinitionMutable::computeTooltip ( )
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References computeTooltip().

Referenced by computeTooltip(), and computeTooltipTexts().

◆ hasSourceReffedBy()

virtual bool DefinitionMutable::hasSourceReffedBy ( ) const
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References hasSourceReffedBy().

Referenced by hasSourceReffedBy().

◆ hasSourceRefs()

virtual bool DefinitionMutable::hasSourceRefs ( ) const
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References hasSourceRefs().

Referenced by hasSourceRefs().

◆ makePartOfGroup()

virtual void DefinitionMutable::makePartOfGroup ( GroupDef * gd)
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References makePartOfGroup().

Referenced by addClassToGroups(), addConceptToGroups(), addDirToGroups(), addExampleToGroups(), addGroupToGroups(), addModuleToGroups(), addNamespaceToGroups(), GroupDefImpl::addPage(), buildFileList(), createTagLessInstance(), distributeClassGroupRelations(), distributeConceptGroups(), and makePartOfGroup().

◆ mergeReferencedBy()

virtual void DefinitionMutable::mergeReferencedBy ( const Definition * other)
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References mergeReferencedBy().

Referenced by mergeReferencedBy(), and transferFunctionReferences().

◆ mergeReferences()

virtual void DefinitionMutable::mergeReferences ( const Definition * other)
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References mergeReferences().

Referenced by mergeReferences(), and transferFunctionReferences().

◆ mergeRefItems()

virtual void DefinitionMutable::mergeRefItems ( Definition * d)
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References mergeRefItems().

Referenced by combineDeclarationAndDefinition(), and mergeRefItems().

◆ setArtificial()

virtual void DefinitionMutable::setArtificial ( bool b)
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References setArtificial().

Referenced by addClassToContext(), buildNamespaceList(), buildScopeFromQualifiedName(), findClassRelation(), findTemplateInstanceRelation(), findUsedClassesForClass(), findUsingDeclarations(), findUsingDirectives(), ClassDefImpl::insertTemplateInstance(), ClassDefImpl::mergeCategory(), and setArtificial().

◆ setBodyDef()

virtual void DefinitionMutable::setBodyDef ( const FileDef * fd)
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References setBodyDef().

Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), addGlobalFunction(), addInstance(), addLocalObjCMethod(), addMemberDocs(), addMemberSpecialization(), addOverloaded(), buildFunctionList(), buildNamespaceList(), combineDeclarationAndDefinition(), createTagLessInstance(), findFriends(), and setBodyDef().

◆ setBodySegment()

virtual void DefinitionMutable::setBodySegment ( int defLine,
int bls,
int ble )
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References setBodySegment().

Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), ModuleManager::addDocs(), addMemberDocs(), addRelatedPage(), buildFunctionList(), buildNamespaceList(), combineDeclarationAndDefinition(), createTagLessInstance(), findFriends(), setBodySegment(), and transferStaticInstanceInitializers().

◆ setBriefDescription()

virtual void DefinitionMutable::setBriefDescription ( const QCString & b,
const QCString & briefFile,
int briefLine )
pure virtual

Sets the brief description of this definition to b. A dot is added to the sentence if not available.

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< PageDef >, and MemberDefImpl.

References setBriefDescription().

Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), ModuleManager::addDocs(), addEnumDocs(), addMemberDocs(), addRelatedPage(), addVariableToFile(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildNamespaceList(), buildTypedefList(), combineDeclarationAndDefinition(), createTagLessInstance(), MemberGroup::distributeMemberGroupDocumentation(), findDirDocumentation(), findFriends(), findUsingDeclImports(), findUsingDirectives(), inheritDocumentation(), and setBriefDescription().

◆ setDefFile()

virtual void DefinitionMutable::setDefFile ( const QCString & df,
int defLine,
int defColumn )
pure virtual

Set a new file name and position

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References setDefFile().

Referenced by addClassToContext(), buildNamespaceList(), and setDefFile().

◆ setDocumentation()

virtual void DefinitionMutable::setDocumentation ( const QCString & d,
const QCString & docFile,
int docLine,
bool stripWhiteSpace = TRUE )
pure virtual

Sets the documentation of this definition to d.

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< PageDef >, and MemberDefImpl.

References setDocumentation(), stripWhiteSpace(), and TRUE.

Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), ModuleManager::addDocs(), addEnumDocs(), addMemberDocs(), addRelatedPage(), addVariableToFile(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildNamespaceList(), buildTypedefList(), combineDeclarationAndDefinition(), createTagLessInstance(), MemberGroup::distributeMemberGroupDocumentation(), findDirDocumentation(), findFriends(), findUsingDeclImports(), findUsingDirectives(), inheritDocumentation(), and setDocumentation().

◆ setExported()

virtual void DefinitionMutable::setExported ( bool b)
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References setExported().

Referenced by buildNamespaceList(), findUsingDirectives(), and setExported().

◆ setHidden()

virtual void DefinitionMutable::setHidden ( bool b)
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< PageDef >, and MemberDefImpl.

References setHidden().

Referenced by addClassToContext(), addConceptToContext(), ModuleManager::addDocs(), buildNamespaceList(), findUsingDirectives(), ClassDefImpl::insertTemplateInstance(), and setHidden().

◆ setId()

virtual void DefinitionMutable::setId ( const QCString & name)
pure virtual

Sets a unique id for the symbol. Used for libclang integration.

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References setId().

Referenced by addClassToContext(), addConceptToContext(), ModuleManager::addDocs(), buildNamespaceList(), findUsingDirectives(), and setId().

◆ setInbodyDocumentation()

virtual void DefinitionMutable::setInbodyDocumentation ( const QCString & d,
const QCString & docFile,
int docLine )
pure virtual

Set the documentation that was found inside the body of an item. If there was already some documentation set, the new documentation will be appended.

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< PageDef >, and MemberDefImpl.

References setInbodyDocumentation().

Referenced by addDefineDoc(), addEnumDocs(), addMemberDocs(), buildFunctionList(), buildGroupListFiltered(), buildTypedefList(), combineDeclarationAndDefinition(), createTagLessInstance(), MemberGroup::distributeMemberGroupDocumentation(), findFriends(), inheritDocumentation(), and setInbodyDocumentation().

◆ setLanguage()

virtual void DefinitionMutable::setLanguage ( SrcLangExt lang)
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References setLanguage().

Referenced by addClassToContext(), addConceptToContext(), addInstance(), addRelatedPage(), ClassDefImpl::addTypeConstraint(), buildExampleList(), buildGroupListFiltered(), buildNamespaceList(), buildScopeFromQualifiedName(), createTagLessInstance(), findClassRelation(), findTemplateInstanceRelation(), findUsedClassesForClass(), findUsingDeclarations(), findUsingDirectives(), and setLanguage().

◆ setLocalName()

virtual void DefinitionMutable::setLocalName ( const QCString & name)
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References setLocalName().

Referenced by setLocalName().

◆ setName()

virtual void DefinitionMutable::setName ( const QCString & name)
pure virtual

Sets a new name for the definition

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< PageDef >, and NamespaceDefImpl.

References setName().

Referenced by buildNamespaceList(), VhdlDocGen::correctMemberProperties(), setName(), and VhdlDocGen::writeRecordUnit().

◆ setOuterScope()

virtual void DefinitionMutable::setOuterScope ( Definition * d)
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References setOuterScope().

Referenced by addConceptToContext(), addEnumValuesToEnums(), PageDefImpl::addInnerCompound(), DirDefImpl::addSubDir(), buildNamespaceList(), buildScopeFromQualifiedName(), createTagLessInstance(), ClassDefImpl::deepCopy(), findClassRelation(), NamespaceDefImpl::insertMember(), ClassDefImpl::insertTemplateInstance(), resolveClassNestingRelations(), and setOuterScope().

◆ setReference()

virtual void DefinitionMutable::setReference ( const QCString & r)
pure virtual

Sets the tag file id via which this definition was imported.

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References setReference().

Referenced by addRelatedPage(), buildGroupListFiltered(), buildNamespaceList(), and setReference().

◆ setRefItems()

virtual void DefinitionMutable::setRefItems ( const RefItemVector & sli)
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References setRefItems().

Referenced by addClassToContext(), addConceptToContext(), addDefineDoc(), ModuleManager::addDocs(), addEnumDocs(), addMemberDocs(), addRelatedPage(), addVariableToFile(), buildFileList(), buildGroupListFiltered(), buildNamespaceList(), buildTypedefList(), findDirDocumentation(), findUsingDirectives(), and setRefItems().

◆ toDefinition_()

virtual Definition * DefinitionMutable::toDefinition_ ( )
privatepure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References readCodeFragment(), toDefinition, toDefinition_(), and toDefinitionMutable().

Referenced by toDefinition, and toDefinition_().

◆ writeDocAnchorsToTagFile()

virtual void DefinitionMutable::writeDocAnchorsToTagFile ( TextStream & ) const
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References writeDocAnchorsToTagFile().

Referenced by writeDocAnchorsToTagFile(), and VhdlDocGen::writeTagFile().

◆ writeInlineCode()

virtual void DefinitionMutable::writeInlineCode ( OutputList & ol,
const QCString & scopeName ) const
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References writeInlineCode().

Referenced by writeInlineCode().

◆ writeNavigationPath()

virtual void DefinitionMutable::writeNavigationPath ( OutputList & ol) const
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References writeNavigationPath().

Referenced by FileDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), writeNavigationPath(), and FileDefImpl::writeSourceHeader().

◆ writeQuickMemberLinks()

virtual void DefinitionMutable::writeQuickMemberLinks ( OutputList & ,
const MemberDef *  ) const
pure virtual

Implemented in ClassDefImpl, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< PageDef >, FileDefImpl, GroupDefImpl, and NamespaceDefImpl.

References writeQuickMemberLinks().

Referenced by writeQuickMemberLinks().

◆ writeSourceDef()

virtual void DefinitionMutable::writeSourceDef ( OutputList & ol) const
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References writeSourceDef().

Referenced by VhdlDocGen::writeSource(), and writeSourceDef().

◆ writeSourceReffedBy()

virtual void DefinitionMutable::writeSourceReffedBy ( OutputList & ol,
const QCString & scopeName ) const
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References writeSourceReffedBy().

Referenced by VhdlDocGen::writeSource(), and writeSourceReffedBy().

◆ writeSourceRefs()

virtual void DefinitionMutable::writeSourceRefs ( OutputList & ol,
const QCString & scopeName ) const
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References writeSourceRefs().

Referenced by VhdlDocGen::writeSource(), and writeSourceRefs().

◆ writeSummaryLinks()

virtual void DefinitionMutable::writeSummaryLinks ( OutputList & ) const
pure virtual

Implemented in ClassDefImpl, DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, DefinitionMixin< PageDef >, FileDefImpl, GroupDefImpl, ModuleDefImpl, and NamespaceDefImpl.

References writeSummaryLinks().

Referenced by startTitle(), and writeSummaryLinks().

◆ writeToc()

virtual void DefinitionMutable::writeToc ( OutputList & ol,
const LocalToc & lt ) const
pure virtual

Implemented in DefinitionMixin< ClassDefMutable >, DefinitionMixin< ConceptDefMutable >, DefinitionMixin< DirDef >, DefinitionMixin< FileDef >, DefinitionMixin< GroupDef >, DefinitionMixin< MemberDefMutable >, DefinitionMixin< ModuleDef >, DefinitionMixin< NamespaceDefMutable >, and DefinitionMixin< PageDef >.

References toDefinition, and writeToc().

Referenced by writeToc().

Friends And Related Symbol Documentation

◆ toDefinition

Definition * toDefinition ( DefinitionMutable * dm)
friend

Definition at line 1869 of file definition.cpp.

1870{
1871 if (dm==nullptr) return nullptr;
1872 return dm->toDefinition_();
1873}
DefinitionMutable::toDefinition_
virtual Definition * toDefinition_()=0

References toDefinition_().

Referenced by toClassDef(), toDefinition_(), and writeToc().

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