The MemberDefMutable Class Reference

Declaration

class MemberDefMutable { ... }

Included Headers

#include <src/memberdef.h>

Base classes

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

Derived Classes

class	DefinitionMixin<Base>

Public Member Functions Index

void	setMemberType (MemberType t)=0
void	setDefinition (const QCString &d)=0
void	setFileDef (FileDef *fd)=0
void	setAnchor ()=0
void	setProtection (Protection p)=0
void	setMemberSpecifiers (TypeSpecifier s)=0
void	setVhdlSpecifiers (VhdlSpecifier s)=0
void	mergeMemberSpecifiers (TypeSpecifier s)=0
void	setInitializer (const QCString &i)=0
void	setBitfields (const QCString &s)=0
void	setMaxInitLines (int lines)=0
void	setMemberClass (ClassDef *cd)=0
void	setSectionList (const Definition *container, const MemberList *sl)=0
void	setGroupDef (GroupDef *gd, Grouping::GroupPri_t pri, const QCString &fileName, int startLine, bool hasDocs, MemberDef *member=nullptr)=0
void	setReadAccessor (const QCString &r)=0
void	setWriteAccessor (const QCString &w)=0
void	setTemplateSpecialization (bool b)=0
void	makeRelated ()=0
void	makeForeign ()=0
void	setInheritsDocsFrom (const MemberDef *md)=0
void	setTagInfo (const TagInfo *i)=0
void	setArgsString (const QCString &as)=0
void	incrementFlowKeyWordCount ()=0
void	setEnumBaseType (const QCString &type)=0
void	setReimplements (MemberDef *md)=0
void	insertReimplementedBy (MemberDef *md)=0
void	setRelatedAlso (ClassDef *cd)=0
void	insertEnumField (MemberDef *md)=0
void	setEnumScope (MemberDef *md, bool livesInsideEnum=FALSE)=0
void	setEnumClassScope (ClassDef *cd)=0
void	setDocumentedEnumValues (bool value)=0
void	setAnonymousEnumType (const MemberDef *md)=0
bool	addExample (const QCString &anchor, const QCString &name, const QCString &file)=0
void	setPrototype (bool p, const QCString &df, int line, int column)=0
void	setExplicitExternal (bool b, const QCString &df, int line, int column)=0
void	setDeclFile (const QCString &df, int line, int column)=0
void	moveArgumentList (std::unique_ptr< ArgumentList > al)=0
void	moveDeclArgumentList (std::unique_ptr< ArgumentList > al)=0
void	resolveUnnamedParameters (const MemberDef *md)=0
void	setDefinitionTemplateParameterLists (const ArgumentLists &lists)=0
void	setTypeConstraints (const ArgumentList &al)=0
void	setType (const QCString &t)=0
void	setAccessorType (ClassDef *cd, const QCString &t)=0
void	setNamespace (NamespaceDef *nd)=0
void	setMemberGroupId (int id)=0
void	makeImplementationDetail ()=0
void	setFromAnonymousMember (MemberDef *m)=0
void	overrideCallGraph (bool e)=0
void	overrideCallerGraph (bool e)=0
void	overrideReferencedByRelation (bool e)=0
void	overrideReferencesRelation (bool e)=0
void	overrideInlineSource (bool e)=0
void	overrideEnumValues (bool e)=0
void	setTemplateMaster (const MemberDef *mt)=0
void	setFormalTemplateArguments (const ArgumentList &al)=0
void	addListReference (Definition *d)=0
void	setDocsForDefinition (bool b)=0
void	setGroupAlias (const MemberDef *md)=0
void	cacheTypedefVal (const ClassDef *val, const QCString &templSpec, const QCString &resolvedType)=0
void	invalidateTypedefValCache ()=0
void	invalidateCachedArgumentTypes ()=0
void	setMemberDefinition (MemberDef *md)=0
void	setMemberDeclaration (MemberDef *md)=0
void	copyArgumentNames (const MemberDef *bmd)=0
void	setCategory (ClassDef *)=0
void	setCategoryRelation (const MemberDef *)=0
void	setRequiresClause (const QCString &req)=0
void	addQualifiers (const StringVector &qualifiers)=0
void	setModuleDef (ModuleDef *mod)=0
void	findSectionsInDocumentation ()=0
ClassDefMutable *	getClassDefMutable ()=0
void	writeDocumentation (const MemberList *ml, int memCount, int memTotal, OutputList &ol, const QCString &scopeName, const Definition *container, bool inGroup, bool showEnumValues=FALSE, bool showInline=FALSE) const =0
void	writeMemberDocSimple (OutputList &ol, const Definition *container) const =0
void	writeTagFile (TextStream &, bool useQualifiedName, bool showNamespaceMembers) const =0
void	setFromAnonymousScope (bool b)=0

Definition at line 301 of file memberdef.h.

Public Member Functions

addExample()

virtual bool MemberDefMutable::addExample (const QCString & anchor, const QCString & name, const QCString & file)

Definition at line 353 of file memberdef.h.

References addExample, Definition::anchor and Definition::name.

Referenced by addExample, generateClassMemberLink, generateClassOrGlobalLink and getLinkInScope.

addListReference()

virtual void MemberDefMutable::addListReference (Definition * d)

Definition at line 388 of file memberdef.h.

Reference addListReference.

Referenced by addListReference and MemberList::addListReferences.

addQualifiers()

virtual void MemberDefMutable::addQualifiers (const StringVector & qualifiers)

Definition at line 408 of file memberdef.h.

Reference addQualifiers.

Referenced by addMemberDocs, addQualifiers, buildFunctionList, buildTypedefList, combineDeclarationAndDefinition and findFriends.

cacheTypedefVal()

virtual void MemberDefMutable::cacheTypedefVal (const ClassDef * val, const QCString & templSpec, const QCString & resolvedType)

Definition at line 392 of file memberdef.h.

Reference cacheTypedefVal.

Referenced by cacheTypedefVal and SymbolResolver::Private::newResolveTypedef.

copyArgumentNames()

virtual void MemberDefMutable::copyArgumentNames (const MemberDef * bmd)

Definition at line 401 of file memberdef.h.

Reference copyArgumentNames.

Referenced by copyArgumentNames and inheritDocumentation.

findSectionsInDocumentation()

virtual void MemberDefMutable::findSectionsInDocumentation ()

Definition at line 416 of file memberdef.h.

Reference findSectionsInDocumentation.

Referenced by findSectionsInDocumentation and MemberList::findSectionsInDocumentation.

getClassDefMutable()

virtual ClassDefMutable * MemberDefMutable::getClassDefMutable ()

Definition at line 419 of file memberdef.h.

Reference getClassDefMutable.

Referenced by addMemberDocs, addMemberFunction, addOverloaded and getClassDefMutable.

incrementFlowKeyWordCount()

virtual void MemberDefMutable::incrementFlowKeyWordCount ()

Definition at line 336 of file memberdef.h.

Reference incrementFlowKeyWordCount.

Referenced by incrementFlowKeyWordCount, incrementFlowKeyWordCount and incrementFlowKeyWordCount.

insertEnumField()

virtual void MemberDefMutable::insertEnumField (MemberDef * md)

Definition at line 346 of file memberdef.h.

Reference insertEnumField.

Referenced by addEnumValuesToEnums and insertEnumField.

insertReimplementedBy()

virtual void MemberDefMutable::insertReimplementedBy (MemberDef * md)

Definition at line 341 of file memberdef.h.

Reference insertReimplementedBy.

Referenced by computeMemberRelationsForBaseClass, MemberDefImpl::insertReimplementedBy and insertReimplementedBy.

invalidateCachedArgumentTypes()

virtual void MemberDefMutable::invalidateCachedArgumentTypes ()

Definition at line 395 of file memberdef.h.

Reference invalidateCachedArgumentTypes.

Referenced by flushUnresolvedRelations and invalidateCachedArgumentTypes.

invalidateTypedefValCache()

virtual void MemberDefMutable::invalidateTypedefValCache ()

Definition at line 393 of file memberdef.h.

Reference invalidateTypedefValCache.

Referenced by flushCachedTemplateRelations and invalidateTypedefValCache.

makeForeign()

virtual void MemberDefMutable::makeForeign ()

Definition at line 332 of file memberdef.h.

Reference makeForeign.

Referenced by makeForeign and transferRelatedFunctionDocumentation.

makeImplementationDetail()

virtual void MemberDefMutable::makeImplementationDetail ()

Definition at line 374 of file memberdef.h.

Reference makeImplementationDetail.

Referenced by makeImplementationDetail.

makeRelated()

virtual void MemberDefMutable::makeRelated ()

Definition at line 331 of file memberdef.h.

Reference makeRelated.

Referenced by addEnumValuesToEnums, findMember, makeRelated and transferRelatedFunctionDocumentation.

mergeMemberSpecifiers()

virtual void MemberDefMutable::mergeMemberSpecifiers (TypeSpecifier s)

Definition at line 318 of file memberdef.h.

Reference mergeMemberSpecifiers.

Referenced by addMemberDocs, combineDeclarationAndDefinition and mergeMemberSpecifiers.

moveArgumentList()

virtual void MemberDefMutable::moveArgumentList (std::unique_ptr< ArgumentList > al)

Definition at line 361 of file memberdef.h.

Reference moveArgumentList.

Referenced by addMemberFunction, buildFunctionList, combineDeclarationAndDefinition and moveArgumentList.

moveDeclArgumentList()

virtual void MemberDefMutable::moveDeclArgumentList (std::unique_ptr< ArgumentList > al)

Definition at line 362 of file memberdef.h.

Reference moveDeclArgumentList.

Referenced by buildFunctionList, combineDeclarationAndDefinition, findFriends and moveDeclArgumentList.

overrideCallerGraph()

virtual void MemberDefMutable::overrideCallerGraph (bool e)

Definition at line 380 of file memberdef.h.

Reference overrideCallerGraph.

Referenced by applyMemberOverrideOptions, mergeMemberOverrideOptions and overrideCallerGraph.

overrideCallGraph()

virtual void MemberDefMutable::overrideCallGraph (bool e)

Definition at line 379 of file memberdef.h.

Reference overrideCallGraph.

Referenced by applyMemberOverrideOptions, mergeMemberOverrideOptions and overrideCallGraph.

overrideEnumValues()

virtual void MemberDefMutable::overrideEnumValues (bool e)

Definition at line 384 of file memberdef.h.

Reference overrideEnumValues.

Referenced by applyMemberOverrideOptions, mergeMemberOverrideOptions and overrideEnumValues.

overrideInlineSource()

virtual void MemberDefMutable::overrideInlineSource (bool e)

Definition at line 383 of file memberdef.h.

Reference overrideInlineSource.

Referenced by applyMemberOverrideOptions, mergeMemberOverrideOptions and overrideInlineSource.

overrideReferencedByRelation()

virtual void MemberDefMutable::overrideReferencedByRelation (bool e)

Definition at line 381 of file memberdef.h.

Reference overrideReferencedByRelation.

Referenced by applyMemberOverrideOptions, mergeMemberOverrideOptions and overrideReferencedByRelation.

overrideReferencesRelation()

virtual void MemberDefMutable::overrideReferencesRelation (bool e)

Definition at line 382 of file memberdef.h.

Reference overrideReferencesRelation.

Referenced by applyMemberOverrideOptions, mergeMemberOverrideOptions and overrideReferencesRelation.

resolveUnnamedParameters()

virtual void MemberDefMutable::resolveUnnamedParameters (const MemberDef * md)

Definition at line 363 of file memberdef.h.

Reference resolveUnnamedParameters.

Referenced by combineDeclarationAndDefinition and resolveUnnamedParameters.

setAccessorType()

virtual void MemberDefMutable::setAccessorType (ClassDef * cd, const QCString & t)

Definition at line 367 of file memberdef.h.

Reference setAccessorType.

Referenced by processTagLessClasses and setAccessorType.

setAnchor()

virtual void MemberDefMutable::setAnchor ()

Definition at line 314 of file memberdef.h.

Reference setAnchor.

Referenced by setAnchor and MemberList::setAnchors.

setAnonymousEnumType()

virtual void MemberDefMutable::setAnonymousEnumType (const MemberDef * md)

Definition at line 350 of file memberdef.h.

Reference setAnonymousEnumType.

Referenced by setAnonymousEnumType and MemberList::setAnonymousEnumType.

setArgsString()

virtual void MemberDefMutable::setArgsString (const QCString & as)

Definition at line 335 of file memberdef.h.

Reference setArgsString.

Referenced by buildFunctionList, findFriends and setArgsString.

setBitfields()

virtual void MemberDefMutable::setBitfields (const QCString & s)

Definition at line 320 of file memberdef.h.

Reference setBitfields.

Referenced by createTagLessInstance and setBitfields.

setCategory()

virtual void MemberDefMutable::setCategory (ClassDef *)

Definition at line 403 of file memberdef.h.

Reference setCategory.

Referenced by ClassDefImpl::mergeCategory and setCategory.

setCategoryRelation()

virtual void MemberDefMutable::setCategoryRelation (const MemberDef *)

Definition at line 404 of file memberdef.h.

Reference setCategoryRelation.

Referenced by ClassDefImpl::mergeCategory and setCategoryRelation.

setDeclFile()

virtual void MemberDefMutable::setDeclFile (const QCString & df, int line, int column)

Definition at line 358 of file memberdef.h.

Reference setDeclFile.

Referenced by addVariableToFile, buildFunctionList and setDeclFile.

setDefinition()

virtual void MemberDefMutable::setDefinition (const QCString & d)

Definition at line 312 of file memberdef.h.

Reference setDefinition.

Referenced by addMemberDocs and setDefinition.

setDefinitionTemplateParameterLists()

virtual void MemberDefMutable::setDefinitionTemplateParameterLists (const ArgumentLists & lists)

Definition at line 364 of file memberdef.h.

Reference setDefinitionTemplateParameterLists.

Referenced by addMemberFunction and setDefinitionTemplateParameterLists.

setDocsForDefinition()

virtual void MemberDefMutable::setDocsForDefinition (bool b)

Definition at line 389 of file memberdef.h.

Reference setDocsForDefinition.

Referenced by addDefineDoc, addEnumDocs, addMemberDocs, buildFunctionList, buildTypedefList, combineDeclarationAndDefinition, findFriends, inheritDocumentation and setDocsForDefinition.

setDocumentedEnumValues()

virtual void MemberDefMutable::setDocumentedEnumValues (bool value)

Definition at line 349 of file memberdef.h.

Reference setDocumentedEnumValues.

Referenced by findDEV and setDocumentedEnumValues.

setEnumBaseType()

virtual void MemberDefMutable::setEnumBaseType (const QCString & type)

Definition at line 337 of file memberdef.h.

Reference setEnumBaseType.

Referenced by setEnumBaseType.

setEnumClassScope()

virtual void MemberDefMutable::setEnumClassScope (ClassDef * cd)

Definition at line 348 of file memberdef.h.

Reference setEnumClassScope.

Referenced by addEnumValuesToEnums and setEnumClassScope.

setEnumScope()

virtual void MemberDefMutable::setEnumScope (MemberDef * md, bool livesInsideEnum=FALSE)

Definition at line 347 of file memberdef.h.

References FALSE, MemberDef::livesInsideEnum and setEnumScope.

Referenced by addEnumValuesToEnums and setEnumScope.

setExplicitExternal()

virtual void MemberDefMutable::setExplicitExternal (bool b, const QCString & df, int line, int column)

Definition at line 357 of file memberdef.h.

Reference setExplicitExternal.

Referenced by addVariableToFile and setExplicitExternal.

setFileDef()

virtual void MemberDefMutable::setFileDef (FileDef * fd)

Definition at line 313 of file memberdef.h.

Reference setFileDef.

Referenced by NamespaceDefImpl::insertMember and setFileDef.

setFormalTemplateArguments()

virtual void MemberDefMutable::setFormalTemplateArguments (const ArgumentList & al)

Definition at line 387 of file memberdef.h.

Reference setFormalTemplateArguments.

Referenced by setFormalTemplateArguments.

setFromAnonymousMember()

virtual void MemberDefMutable::setFromAnonymousMember (MemberDef * m)

Definition at line 377 of file memberdef.h.

Reference setFromAnonymousMember.

Referenced by setFromAnonymousMember.

setFromAnonymousScope()

virtual void MemberDefMutable::setFromAnonymousScope (bool b)

Definition at line 433 of file memberdef.h.

References addDocCrossReference, combineDeclarationAndDefinition, createMemberDef, createMemberDefAlias, Definition::name, setFromAnonymousScope, toMemberDef and toMemberDefMutable.

Referenced by setFromAnonymousScope.

setGroupAlias()

virtual void MemberDefMutable::setGroupAlias (const MemberDef * md)

Definition at line 390 of file memberdef.h.

Reference setGroupAlias.

Referenced by GroupDefImpl::insertMember and setGroupAlias.

setGroupDef()

virtual void MemberDefMutable::setGroupDef (GroupDef * gd, Grouping::GroupPri_t pri, const QCString & fileName, int startLine, bool hasDocs, MemberDef * member=nullptr)

Definition at line 324 of file memberdef.h.

Reference setGroupDef.

Referenced by addMemberToGroups, combineDeclarationAndDefinition, MemberGroup::insertMember, setGroupDef and ClassDefImpl::setGroupDefForAllMembers.

setInheritsDocsFrom()

virtual void MemberDefMutable::setInheritsDocsFrom (const MemberDef * md)

Definition at line 333 of file memberdef.h.

Reference setInheritsDocsFrom.

Referenced by inheritDocumentation and setInheritsDocsFrom.

setInitializer()

virtual void MemberDefMutable::setInitializer (const QCString & i)

Definition at line 319 of file memberdef.h.

Reference setInitializer.

Referenced by addMemberDocs, createTagLessInstance and setInitializer.

setMaxInitLines()

virtual void MemberDefMutable::setMaxInitLines (int lines)

Definition at line 321 of file memberdef.h.

Reference setMaxInitLines.

Referenced by addDefineDoc, addMemberDocs, createTagLessInstance and setMaxInitLines.

setMemberClass()

virtual void MemberDefMutable::setMemberClass (ClassDef * cd)

Definition at line 322 of file memberdef.h.

Reference setMemberClass.

Referenced by createTagLessInstance, findMember and setMemberClass.

setMemberDeclaration()

virtual void MemberDefMutable::setMemberDeclaration (MemberDef * md)

Definition at line 399 of file memberdef.h.

Reference setMemberDeclaration.

Referenced by combineDeclarationAndDefinition and setMemberDeclaration.

setMemberDefinition()

virtual void MemberDefMutable::setMemberDefinition (MemberDef * md)

Definition at line 398 of file memberdef.h.

Reference setMemberDefinition.

Referenced by combineDeclarationAndDefinition and setMemberDefinition.

setMemberGroupId()

virtual void MemberDefMutable::setMemberGroupId (int id)

Definition at line 373 of file memberdef.h.

Reference setMemberGroupId.

Referenced by addDefineDoc, addEnumDocs, addMemberDocs, createTagLessInstance and setMemberGroupId.

setMemberSpecifiers()

virtual void MemberDefMutable::setMemberSpecifiers (TypeSpecifier s)

Definition at line 316 of file memberdef.h.

Reference setMemberSpecifiers.

Referenced by createTagLessInstance and setMemberSpecifiers.

setMemberType()

virtual void MemberDefMutable::setMemberType (MemberType t)

Definition at line 311 of file memberdef.h.

Reference setMemberType.

Referenced by ClassDefImpl::reclassifyMember and setMemberType.

setModuleDef()

virtual void MemberDefMutable::setModuleDef (ModuleDef * mod)

Definition at line 410 of file memberdef.h.

Reference setModuleDef.

Referenced by setModuleDef.

setNamespace()

virtual void MemberDefMutable::setNamespace (NamespaceDef * nd)

Definition at line 370 of file memberdef.h.

Reference setNamespace.

Referenced by NamespaceDefImpl::insertMember and setNamespace.

setProtection()

virtual void MemberDefMutable::setProtection (Protection p)

Definition at line 315 of file memberdef.h.

Reference setProtection.

Referenced by addVariableToClass and setProtection.

setPrototype()

virtual void MemberDefMutable::setPrototype (bool p, const QCString & df, int line, int column)

Definition at line 356 of file memberdef.h.

Reference setPrototype.

Referenced by buildFunctionList and setPrototype.

setReadAccessor()

virtual void MemberDefMutable::setReadAccessor (const QCString & r)

Definition at line 327 of file memberdef.h.

Reference setReadAccessor.

Referenced by setReadAccessor.

setReimplements()

virtual void MemberDefMutable::setReimplements (MemberDef * md)

Definition at line 340 of file memberdef.h.

Reference setReimplements.

Referenced by computeMemberRelationsForBaseClass and setReimplements.

setRelatedAlso()

virtual void MemberDefMutable::setRelatedAlso (ClassDef * cd)

Definition at line 343 of file memberdef.h.

Reference setRelatedAlso.

Referenced by setRelatedAlso and transferRelatedFunctionDocumentation.

setRequiresClause()

virtual void MemberDefMutable::setRequiresClause (const QCString & req)

Definition at line 406 of file memberdef.h.

Reference setRequiresClause.

Referenced by addMemberDocs, createTagLessInstance and setRequiresClause.

setSectionList()

virtual void MemberDefMutable::setSectionList (const Definition * container, const MemberList * sl)

Definition at line 323 of file memberdef.h.

Reference setSectionList.

Referenced by ClassDefImpl::addMemberToList, FileDefImpl::addMemberToList, ModuleDefImpl::addMemberToList, NamespaceDefImpl::addMemberToList and setSectionList.

setTagInfo()

virtual void MemberDefMutable::setTagInfo (const TagInfo * i)

Definition at line 334 of file memberdef.h.

Reference setTagInfo.

Referenced by setTagInfo.

setTemplateMaster()

virtual void MemberDefMutable::setTemplateMaster (const MemberDef * mt)

Definition at line 386 of file memberdef.h.

Reference setTemplateMaster.

Referenced by setTemplateMaster.

setTemplateSpecialization()

virtual void MemberDefMutable::setTemplateSpecialization (bool b)

Definition at line 329 of file memberdef.h.

Reference setTemplateSpecialization.

Referenced by setTemplateSpecialization.

setType()

virtual void MemberDefMutable::setType (const QCString & t)

Definition at line 366 of file memberdef.h.

Reference setType.

Referenced by VhdlDocGen::correctMemberProperties and setType.

setTypeConstraints()

virtual void MemberDefMutable::setTypeConstraints (const ArgumentList & al)

Definition at line 365 of file memberdef.h.

Reference setTypeConstraints.

Referenced by setTypeConstraints.

setVhdlSpecifiers()

virtual void MemberDefMutable::setVhdlSpecifiers (VhdlSpecifier s)

Definition at line 317 of file memberdef.h.

Reference setVhdlSpecifiers.

Referenced by VhdlDocGen::correctMemberProperties, createTagLessInstance and setVhdlSpecifiers.

setWriteAccessor()

virtual void MemberDefMutable::setWriteAccessor (const QCString & w)

Definition at line 328 of file memberdef.h.

Reference setWriteAccessor.

Referenced by setWriteAccessor.

writeDocumentation()

virtual void MemberDefMutable::writeDocumentation (const MemberList * ml, int memCount, int memTotal, OutputList & ol, const QCString & scopeName, const Definition * container, bool inGroup, bool showEnumValues=FALSE, bool showInline=FALSE)

Definition at line 425 of file memberdef.h.

References FALSE and writeDocumentation.

Referenced by writeDocumentation, MemberList::writeDocumentation and MemberList::writeDocumentationPage.

writeMemberDocSimple()

virtual void MemberDefMutable::writeMemberDocSimple (OutputList & ol, const Definition * container)

Definition at line 429 of file memberdef.h.

Reference writeMemberDocSimple.

Referenced by writeMemberDocSimple and MemberList::writeSimpleDocumentation.

writeTagFile()

virtual void MemberDefMutable::writeTagFile (TextStream &, bool useQualifiedName, bool showNamespaceMembers)

Definition at line 430 of file memberdef.h.

Reference writeTagFile.

Referenced by writeTagFile and MemberList::writeTagFile.

---

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

• memberdef.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.