Skip to main content

The `DefinitionMutable` Class Reference

Declaration

class DefinitionMutable { ... }

Included Headers

#include <src/definition.h>

Derived Classes

class	ClassDefMutable


class	ConceptDefMutable


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

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

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

class	MemberDefMutable


class	ModuleDef


class	NamespaceDefMutable


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

Friends Index

Definition *	toDefinition

Public Member Functions Index

void	setName (const QCString &name)=0


void	setId (const QCString &name)=0


void	setDefFile (const QCString &df, int defLine, int defColumn)=0


void	setDocumentation (const QCString &d, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)=0


void	setBriefDescription (const QCString &b, const QCString &briefFile, int briefLine)=0


void	setInbodyDocumentation (const QCString &d, const QCString &docFile, int docLine)=0


void	setReference (const QCString &r)=0


void	setBodySegment (int defLine, int bls, int ble)=0


void	setBodyDef (const FileDef *fd)=0


void	setRefItems (const RefItemVector &sli)=0


void	setOuterScope (Definition *d)=0


void	setHidden (bool b)=0


void	setArtificial (bool b)=0


void	setExported (bool b)=0


void	setLanguage (SrcLangExt lang)=0


void	setLocalName (const QCString &name)=0


void	makePartOfGroup (GroupDef *gd)=0


void	addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)=0


void	addSourceReferencedBy (MemberDef *d, const QCString &sourceRefName)=0


void	addSourceReferences (MemberDef *d, const QCString &sourceRefName)=0


void	mergeRefItems (Definition *d)=0


void	addInnerCompound (Definition *d)=0


void	mergeReferences (const Definition *other)=0


void	mergeReferencedBy (const Definition *other)=0


void	computeTooltip ()=0


void	writeSourceDef (OutputList &ol) const =0


void	writeInlineCode (OutputList &ol, const QCString &scopeName) const =0


bool	hasSourceRefs () const =0


bool	hasSourceReffedBy () const =0


void	writeSourceRefs (OutputList &ol, const QCString &scopeName) const =0


void	writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const =0


void	writeNavigationPath (OutputList &ol) const =0


void	writeQuickMemberLinks (OutputList &, const MemberDef *) const =0


void	writeSummaryLinks (OutputList &) const =0


void	writePageNavigation (OutputList &) const =0


void	writeDocAnchorsToTagFile (TextStream &) const =0


void	writeToc (OutputList &ol, const LocalToc &lt) const =0

Private Member Functions Index

Definition *	toDefinition_ ()=0

Definition at line 305 of file definition.h.

Friends

toDefinition

friend Definition * DefinitionMutable * dm

Declaration at line 389 of file definition.h, definition at line 1923 of file definition.cpp.

1923Definition *toDefinition(DefinitionMutable *dm)

1924{

1925 if (dm==nullptr) return nullptr;

1926 return dm->toDefinition_();

1927}

Reference toDefinition_.

Referenced by toDefinition_ and writeToc.

Public Member Functions

addInnerCompound()

virtual void DefinitionMutable::addInnerCompound (Definition * d)

Definition at line 367 of file definition.h.

Reference 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)

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

Definition at line 363 of file definition.h.

Reference addSectionsToDefinition.

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

addSourceReferencedBy()

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

Definition at line 364 of file definition.h.

Reference addSourceReferencedBy.

Referenced by addDocCrossReference and addSourceReferencedBy.

addSourceReferences()

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

Definition at line 365 of file definition.h.

Reference addSourceReferences.

Referenced by addDocCrossReference and addSourceReferences.

computeTooltip()

virtual void DefinitionMutable::computeTooltip ()

Definition at line 370 of file definition.h.

Reference computeTooltip.

Referenced by computeTooltip and computeTooltipTexts.

hasSourceReffedBy()

virtual bool DefinitionMutable::hasSourceReffedBy ()

Definition at line 378 of file definition.h.

Reference hasSourceReffedBy.

Referenced by hasSourceReffedBy.

hasSourceRefs()

virtual bool DefinitionMutable::hasSourceRefs ()

Definition at line 377 of file definition.h.

Reference hasSourceRefs.

Referenced by hasSourceRefs.

makePartOfGroup()

virtual void DefinitionMutable::makePartOfGroup (GroupDef * gd)

Definition at line 358 of file definition.h.

Reference 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)

Definition at line 369 of file definition.h.

Reference mergeReferencedBy.

Referenced by mergeReferencedBy and transferFunctionReferences.

mergeReferences()

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

Definition at line 368 of file definition.h.

Reference mergeReferences.

Referenced by mergeReferences and transferFunctionReferences.

mergeRefItems()

virtual void DefinitionMutable::mergeRefItems (Definition * d)

Definition at line 366 of file definition.h.

Reference mergeRefItems.

Referenced by combineDeclarationAndDefinition and mergeRefItems.

setArtificial()

virtual void DefinitionMutable::setArtificial (bool b)

Definition at line 349 of file definition.h.

Reference 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)

Definition at line 342 of file definition.h.

Reference 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)

Definition at line 341 of file definition.h.

Reference 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)

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

Definition at line 329 of file definition.h.

Reference 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)

Set a new file name and position

Definition at line 321 of file definition.h.

Reference setDefFile.

Referenced by addClassToContext, buildNamespaceList and setDefFile.

setDocumentation()

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

Sets the documentation of this definition to d.

Definition at line 324 of file definition.h.

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)

Definition at line 350 of file definition.h.

Reference setExported.

Referenced by buildNamespaceList, findUsingDirectives and setExported.

setHidden()

virtual void DefinitionMutable::setHidden (bool b)

Definition at line 347 of file definition.h.

Reference setHidden.

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

setId()

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

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

Definition at line 318 of file definition.h.

Reference setId.

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

setInbodyDocumentation()

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

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.

Definition at line 335 of file definition.h.

Reference setInbodyDocumentation.

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

setLanguage()

virtual void DefinitionMutable::setLanguage (SrcLangExt lang)

Definition at line 351 of file definition.h.

Reference 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)

Definition at line 352 of file definition.h.

Reference setLocalName.

Referenced by setLocalName.

setName()

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

Sets a new name for the definition

Definition at line 315 of file definition.h.

Reference setName.

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

setOuterScope()

virtual void DefinitionMutable::setOuterScope (Definition * d)

Definition at line 345 of file definition.h.

Reference 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)

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

Definition at line 338 of file definition.h.

Reference setReference.

Referenced by addRelatedPage, buildGroupListFiltered, buildNamespaceList and setReference.

setRefItems()

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

Definition at line 344 of file definition.h.

Reference setRefItems.

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

writeDocAnchorsToTagFile()

virtual void DefinitionMutable::writeDocAnchorsToTagFile (TextStream &)

Definition at line 385 of file definition.h.

Reference writeDocAnchorsToTagFile.

Referenced by writeDocAnchorsToTagFile and VhdlDocGen::writeTagFile.

writeInlineCode()

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

Definition at line 376 of file definition.h.

Reference writeInlineCode.

Referenced by writeInlineCode.

writeNavigationPath()

virtual void DefinitionMutable::writeNavigationPath (OutputList & ol)

Definition at line 381 of file definition.h.

Reference writeNavigationPath.

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

writePageNavigation()

virtual void DefinitionMutable::writePageNavigation (OutputList &)

Definition at line 384 of file definition.h.

Reference writePageNavigation.

Referenced by endFileWithNavPath and writePageNavigation.

writeQuickMemberLinks()

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

Definition at line 382 of file definition.h.

Reference writeQuickMemberLinks.

Referenced by writeQuickMemberLinks.

writeSourceDef()

virtual void DefinitionMutable::writeSourceDef (OutputList & ol)

Definition at line 375 of file definition.h.

Reference writeSourceDef.

Referenced by VhdlDocGen::writeSource and writeSourceDef.

writeSourceReffedBy()

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

Definition at line 380 of file definition.h.

Reference writeSourceReffedBy.

Referenced by VhdlDocGen::writeSource and writeSourceReffedBy.

writeSourceRefs()

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

Definition at line 379 of file definition.h.

Reference writeSourceRefs.

Referenced by VhdlDocGen::writeSource and writeSourceRefs.

writeSummaryLinks()

virtual void DefinitionMutable::writeSummaryLinks (OutputList &)

Definition at line 383 of file definition.h.

Reference writeSummaryLinks.

Referenced by startTitle and writeSummaryLinks.

writeToc()

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

Definition at line 386 of file definition.h.

References toDefinition and writeToc.

Referenced by writeToc.

Private Member Functions

toDefinition_()

virtual Definition * DefinitionMutable::toDefinition_ ()

Definition at line 390 of file definition.h.

References readCodeFragment, toDefinition, toDefinition_ and toDefinitionMutable.

Referenced by toDefinition and toDefinition_.

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

Generated via doxygen2docusaurus by Doxygen 1.14.0.