doxygen
Public Member Functions | List of all members
MemberDefMutable Class Referenceabstract
Inheritance diagram for MemberDefMutable:
Inheritance graph
[legend]
Collaboration diagram for MemberDefMutable:
Collaboration graph
[legend]

Public Member Functions

virtual void setMemberType (MemberType t)=0
 
virtual void setDefinition (const QCString &d)=0
 
virtual void setFileDef (const FileDef *fd)=0
 
virtual void setAnchor ()=0
 
virtual void setProtection (Protection p)=0
 
virtual void setMemberSpecifiers (uint64 s)=0
 
virtual void mergeMemberSpecifiers (uint64 s)=0
 
virtual void setInitializer (const QCString &i)=0
 
virtual void setBitfields (const QCString &s)=0
 
virtual void setMaxInitLines (int lines)=0
 
virtual void setMemberClass (const ClassDef *cd)=0
 
virtual void setSectionList (const Definition *container, const MemberList *sl)=0
 
virtual void setGroupDef (const GroupDef *gd, Grouping::GroupPri_t pri, const QCString &fileName, int startLine, bool hasDocs, MemberDef *member=0)=0
 
virtual void setReadAccessor (const QCString &r)=0
 
virtual void setWriteAccessor (const QCString &w)=0
 
virtual void setTemplateSpecialization (bool b)=0
 
virtual void makeRelated ()=0
 
virtual void makeForeign ()=0
 
virtual void setInheritsDocsFrom (const MemberDef *md)=0
 
virtual void setTagInfo (const TagInfo *i)=0
 
virtual void setArgsString (const QCString &as)=0
 
virtual void incrementFlowKeyWordCount ()=0
 
virtual void setEnumBaseType (const QCString &type)=0
 
virtual void setReimplements (const MemberDef *md)=0
 
virtual void insertReimplementedBy (const MemberDef *md)=0
 
virtual void setRelatedAlso (ClassDef *cd)=0
 
virtual void insertEnumField (const MemberDef *md)=0
 
virtual void setEnumScope (const MemberDef *md, bool livesInsideEnum=FALSE)=0
 
virtual void setEnumClassScope (const ClassDef *cd)=0
 
virtual void setDocumentedEnumValues (bool value)=0
 
virtual void setAnonymousEnumType (const MemberDef *md)=0
 
virtual bool addExample (const QCString &anchor, const QCString &name, const QCString &file)=0
 
virtual void setPrototype (bool p, const QCString &df, int line, int column)=0
 
virtual void setExplicitExternal (bool b, const QCString &df, int line, int column)=0
 
virtual void setDeclFile (const QCString &df, int line, int column)=0
 
virtual void moveArgumentList (std::unique_ptr< ArgumentList > al)=0
 
virtual void moveDeclArgumentList (std::unique_ptr< ArgumentList > al)=0
 
virtual void resolveUnnamedParameters (const MemberDef *md)=0
 
virtual void setDefinitionTemplateParameterLists (const ArgumentLists &lists)=0
 
virtual void setTypeConstraints (const ArgumentList &al)=0
 
virtual void setType (const QCString &t)=0
 
virtual void setAccessorType (ClassDef *cd, const QCString &t)=0
 
virtual void setNamespace (const NamespaceDef *nd)=0
 
virtual void setMemberGroupId (int id)=0
 
virtual void makeImplementationDetail ()=0
 
virtual void setFromAnonymousMember (MemberDef *m)=0
 
virtual void enableCallGraph (bool e)=0
 
virtual void enableCallerGraph (bool e)=0
 
virtual void enableReferencedByRelation (bool e)=0
 
virtual void enableReferencesRelation (bool e)=0
 
virtual void setTemplateMaster (const MemberDef *mt)=0
 
virtual void addListReference (Definition *d)=0
 
virtual void setDocsForDefinition (bool b)=0
 
virtual void setGroupAlias (const MemberDef *md)=0
 
virtual void cacheTypedefVal (const ClassDef *val, const QCString &templSpec, const QCString &resolvedType)=0
 
virtual void invalidateTypedefValCache ()=0
 
virtual void invalidateCachedArgumentTypes ()=0
 
virtual void setMemberDefinition (MemberDef *md)=0
 
virtual void setMemberDeclaration (MemberDef *md)=0
 
virtual void copyArgumentNames (const MemberDef *bmd)=0
 
virtual void setCategory (ClassDef *)=0
 
virtual void setCategoryRelation (const MemberDef *)=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 &inbodyFile, int inbodyLine)=0
 
virtual void setHidden (bool b)=0
 
virtual void setRequiresClause (const QCString &req)=0
 
virtual void findSectionsInDocumentation ()=0
 
virtual 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
 
virtual void writeMemberDocSimple (OutputList &ol, const Definition *container) const =0
 
virtual void writeTagFile (TextStream &) const =0
 
virtual void writeLink (OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, bool onlyText=FALSE) const =0
 
virtual void setAnonymousUsed () const =0
 
virtual void setFromAnonymousScope (bool b) const =0
 
- Public Member Functions inherited from DefinitionMutable
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 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 setArtificial (bool b)=0
 
virtual void setLanguage (SrcLangExt lang)=0
 
virtual void setLocalName (const QCString &name)=0
 
virtual void makePartOfGroup (const GroupDef *gd)=0
 
virtual void addSectionsToDefinition (const std::vector< const SectionInfo *> &anchorList)=0
 
virtual void addSourceReferencedBy (const MemberDef *d)=0
 
virtual void addSourceReferences (const MemberDef *d)=0
 
virtual void mergeRefItems (Definition *d)=0
 
virtual void addInnerCompound (const Definition *d)=0
 
virtual void addSectionsToIndex ()=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 QCString &scopeName) 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
 
- Public Member Functions inherited from MemberDef
virtual DefType definitionType () const =0
 
virtual MemberDefdeepCopy () const =0
 
virtual void moveTo (Definition *)=0
 
virtual MemberDefresolveAlias ()=0
 
virtual const MemberDefresolveAlias () const =0
 
ClassDefMutablegetClassDefMutable () const
 
virtual QCString getOutputFileBase () const =0
 
virtual QCString getReference () const =0
 
virtual QCString anchor () const =0
 
virtual QCString declaration () const =0
 
virtual QCString definition () const =0
 
virtual QCString typeString () const =0
 
virtual QCString argsString () const =0
 
virtual QCString excpString () const =0
 
virtual QCString bitfieldString () const =0
 
virtual QCString extraTypeChars () const =0
 
virtual const QCStringinitializer () const =0
 
virtual int initializerLines () const =0
 
virtual uint64 getMemberSpecifiers () const =0
 
virtual const MemberListgetSectionList (const Definition *container) const =0
 
virtual QCString displayDefinition () const =0
 
virtual const FileDefgetFileDef () const =0
 
virtual const ClassDefgetClassDef () const =0
 
virtual const NamespaceDefgetNamespaceDef () const =0
 
virtual const ClassDefaccessorClass () const =0
 
virtual QCString getReadAccessor () const =0
 
virtual QCString getWriteAccessor () const =0
 
virtual const GroupDefgetGroupDef () const =0
 
virtual Grouping::GroupPri_t getGroupPri () const =0
 
virtual QCString getGroupFileName () const =0
 
virtual int getGroupStartLine () const =0
 
virtual bool getGroupHasDocs () const =0
 
virtual QCString qualifiedName () const =0
 
virtual QCString objCMethodName (bool localLink, bool showStatic) const =0
 
virtual Protection protection () const =0
 
virtual Specifier virtualness (int count=0) const =0
 
virtual MemberType memberType () const =0
 
virtual QCString memberTypeName () const =0
 
virtual bool isSignal () const =0
 
virtual bool isSlot () const =0
 
virtual bool isVariable () const =0
 
virtual bool isEnumerate () const =0
 
virtual bool isEnumValue () const =0
 
virtual bool isTypedef () const =0
 
virtual bool isSequence () const =0
 
virtual bool isDictionary () const =0
 
virtual bool isFunction () const =0
 
virtual bool isFunctionPtr () const =0
 
virtual bool isDefine () const =0
 
virtual bool isFriend () const =0
 
virtual bool isDCOP () const =0
 
virtual bool isProperty () const =0
 
virtual bool isEvent () const =0
 
virtual bool isRelated () const =0
 
virtual bool isForeign () const =0
 
virtual bool isStatic () const =0
 
virtual bool isInline () const =0
 
virtual bool isExplicit () const =0
 
virtual bool isMutable () const =0
 
virtual bool isGettable () const =0
 
virtual bool isPrivateGettable () const =0
 
virtual bool isProtectedGettable () const =0
 
virtual bool isSettable () const =0
 
virtual bool isPrivateSettable () const =0
 
virtual bool isProtectedSettable () const =0
 
virtual bool isReadable () const =0
 
virtual bool isWritable () const =0
 
virtual bool isAddable () const =0
 
virtual bool isRemovable () const =0
 
virtual bool isRaisable () const =0
 
virtual bool isFinal () const =0
 
virtual bool isAbstract () const =0
 
virtual bool isOverride () const =0
 
virtual bool isInitonly () const =0
 
virtual bool isOptional () const =0
 
virtual bool isRequired () const =0
 
virtual bool isNonAtomic () const =0
 
virtual bool isCopy () const =0
 
virtual bool isAssign () const =0
 
virtual bool isRetain () const =0
 
virtual bool isWeak () const =0
 
virtual bool isStrong () const =0
 
virtual bool isEnumStruct () const =0
 
virtual bool isUnretained () const =0
 
virtual bool isNew () const =0
 
virtual bool isSealed () const =0
 
virtual bool isImplementation () const =0
 
virtual bool isExternal () const =0
 
virtual bool isTypeAlias () const =0
 
virtual bool isDefault () const =0
 
virtual bool isDelete () const =0
 
virtual bool isNoExcept () const =0
 
virtual bool isAttribute () const =0
 
virtual bool isUNOProperty () const =0
 
virtual bool isReadonly () const =0
 
virtual bool isBound () const =0
 
virtual bool isConstrained () const =0
 
virtual bool isTransient () const =0
 
virtual bool isMaybeVoid () const =0
 
virtual bool isMaybeDefault () const =0
 
virtual bool isMaybeAmbiguous () const =0
 
virtual bool isPublished () const =0
 
virtual bool isTemplateSpecialization () const =0
 
virtual bool isObjCMethod () const =0
 
virtual bool isObjCProperty () const =0
 
virtual bool isConstructor () const =0
 
virtual bool isDestructor () const =0
 
virtual bool hasOneLineInitializer () const =0
 
virtual bool hasMultiLineInitializer () const =0
 
virtual bool showInCallGraph () const =0
 
virtual bool isStrongEnumValue () const =0
 
virtual bool livesInsideEnum () const =0
 
virtual bool isSliceLocal () const =0
 
virtual bool isConstExpr () const =0
 
virtual int numberOfFlowKeyWords () const =0
 
virtual bool isFriendToHide () const =0
 
virtual bool isNotFriend () const =0
 
virtual bool isFunctionOrSignalSlot () const =0
 
virtual bool isRelatedOrFriend () const =0
 
virtual bool isLinkableInProject () const =0
 
virtual bool isLinkable () const =0
 
virtual bool hasDocumentation () const =0
 
virtual bool isDeleted () const =0
 
virtual bool isBriefSectionVisible () const =0
 
virtual bool isDetailedSectionVisible (MemberListContainer container) const =0
 
virtual bool hasDetailedDescription () const =0
 
virtual bool isFriendClass () const =0
 
virtual bool isDocumentedFriendClass () const =0
 
virtual const MemberDefreimplements () const =0
 
virtual const MemberVectorreimplementedBy () const =0
 
virtual bool isReimplementedBy (const ClassDef *cd) const =0
 
virtual ClassDefrelatedAlso () const =0
 
virtual bool hasDocumentedEnumValues () const =0
 
virtual const MemberDefgetAnonymousEnumType () const =0
 
virtual bool isDocsForDefinition () const =0
 
virtual const MemberDefgetEnumScope () const =0
 
virtual const MemberVectorenumFieldList () const =0
 
virtual QCString enumBaseType () const =0
 
virtual bool hasExamples () const =0
 
virtual const ExampleListgetExamples () const =0
 
virtual bool isPrototype () const =0
 
virtual const ArgumentListargumentList () const =0
 
virtual const ArgumentListdeclArgumentList () const =0
 
virtual const ArgumentListtemplateArguments () const =0
 
virtual const ArgumentLists & definitionTemplateParameterLists () const =0
 
virtual int getMemberGroupId () const =0
 
virtual MemberGroupgetMemberGroup () const =0
 
virtual bool fromAnonymousScope () const =0
 
virtual bool anonymousDeclShown () const =0
 
virtual MemberDeffromAnonymousMember () const =0
 
virtual bool hasCallGraph () const =0
 
virtual bool hasCallerGraph () const =0
 
virtual bool visibleMemberGroup (bool hideNoHeader) const =0
 
virtual bool hasReferencesRelation () const =0
 
virtual bool hasReferencedByRelation () const =0
 
virtual const MemberDeftemplateMaster () const =0
 
virtual QCString getScopeString () const =0
 
virtual ClassDefgetClassDefOfAnonymousType () const =0
 
virtual bool isTypedefValCached () const =0
 
virtual const ClassDefgetCachedTypedefVal () const =0
 
virtual QCString getCachedTypedefTemplSpec () const =0
 
virtual QCString getCachedResolvedTypedef () const =0
 
virtual MemberDefmemberDefinition () const =0
 
virtual MemberDefmemberDeclaration () const =0
 
virtual const MemberDefinheritsDocsFrom () const =0
 
virtual const MemberDefgetGroupAlias () const =0
 
virtual ClassDefcategory () const =0
 
virtual const MemberDefcategoryRelation () const =0
 
virtual QCString displayName (bool=TRUE) const =0
 
virtual QCString getDeclType () const =0
 
virtual StringVector getLabels (const Definition *container) const =0
 
virtual const ArgumentListtypeConstraints () const =0
 
virtual QCString requiresClause () const =0
 
virtual QCString documentation () const =0
 
virtual QCString briefDescription (bool abbr=FALSE) const =0
 
virtual QCString fieldType () const =0
 
virtual bool isReference () const =0
 
virtual QCString getDeclFileName () const =0
 
virtual int getDeclLine () const =0
 
virtual int getDeclColumn () const =0
 
virtual MemberDefMutablecreateTemplateInstanceMember (const ArgumentList &formalArgs, const std::unique_ptr< ArgumentList > &actualArgs) const =0
 
virtual void writeDeclaration (OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, bool inGroup, int indentLevel=0, const ClassDef *inheritFrom=0, const QCString &inheritId=QCString()) const =0
 
virtual void writeEnumDeclaration (OutputList &typeDecl, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd) const =0
 
virtual void detectUndocumentedParams (bool hasParamCommand, bool hasReturnCommand) const =0
 
virtual void warnIfUndocumented () const =0
 
virtual void warnIfUndocumentedParams () const =0
 
virtual bool visibleInIndex () const =0
 
virtual void setMemberGroup (MemberGroup *grp)=0
 
- Public Member Functions inherited from Definition
virtual CodeSymbolType codeSymbolType () const =0
 
virtual bool isAlias () const =0
 
virtual QCString name () const =0
 
virtual bool isAnonymous () const =0
 
virtual QCString localName () const =0
 
virtual QCString symbolName () const =0
 
virtual QCString getSourceFileBase () const =0
 
virtual QCString getSourceAnchor () const =0
 
virtual int docLine () const =0
 
virtual QCString docFile () 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 hasUserDocumentation () const =0
 
virtual bool isVisibleInProject () const =0
 
virtual bool isVisible () const =0
 
virtual bool isHidden () const =0
 
virtual bool isArtificial () 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 FileDefgetBodyDef () const =0
 
virtual SrcLangExt getLanguage () const =0
 Returns the programming language this definition was written in. More...
 
virtual const GroupListpartOfGroups () const =0
 
virtual bool isLinkableViaGroup () const =0
 
virtual const RefItemVector & xrefListItems () const =0
 
virtual const DefinitionfindInnerCompound (const QCString &name) const =0
 
virtual DefinitiongetOuterScope () const =0
 
virtual const MemberVectorgetReferencesMembers () const =0
 
virtual const MemberVectorgetReferencedByMembers () 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 SectionRefsgetSectionRefs () const =0
 returns the section dictionary, only of importance for pagedef
 
virtual QCString navigationPathAsString () const =0
 
virtual QCString pathFragment () const =0
 
virtual void setCookie (Cookie *cookie) const =0
 
virtual Cookiecookie () const =0
 
virtual void _setSymbolName (const QCString &name)=0
 
virtual QCString _symbolName () const =0
 

Additional Inherited Members

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

Member Function Documentation

◆ setBriefDescription()

virtual void MemberDefMutable::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.

Implements DefinitionMutable.

Implemented in MemberDefImpl.

◆ setDocumentation()

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

Sets the documentation of this definition to d.

Implements DefinitionMutable.

Implemented in MemberDefImpl.

◆ setInbodyDocumentation()

virtual void MemberDefMutable::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.

Implements DefinitionMutable.

Implemented in MemberDefImpl.


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