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

Public Member Functions

 MemberDefImpl (const QCString &defFileName, int defLine, int defColumn, const QCString &type, const QCString &name, const QCString &args, const QCString &excp, Protection prot, Specifier virt, bool stat, Relationship related, MemberType t, const ArgumentList &tal, const ArgumentList &al, const QCString &metaData)
 
DefType definitionType () const override
 
MemberDefresolveAlias () override
 
const MemberDefresolveAlias () const override
 
CodeSymbolType codeSymbolType () const override
 
std::unique_ptr< MemberDefdeepCopy () const override
 
void moveTo (Definition *) override
 
QCString getOutputFileBase () const override
 
QCString getReference () const override
 
QCString anchor () const override
 
QCString declaration () const override
 
QCString definition () const override
 
QCString typeString () const override
 
QCString argsString () const override
 
QCString excpString () const override
 
QCString bitfieldString () const override
 
QCString extraTypeChars () const override
 
const QCStringinitializer () const override
 
int initializerLines () const override
 
TypeSpecifier getMemberSpecifiers () const override
 
VhdlSpecifier getVhdlSpecifiers () const override
 
const MemberListgetSectionList (const Definition *) const override
 
QCString displayDefinition () const override
 
const ClassDefgetClassDef () const override
 
ClassDefgetClassDef () override
 
const FileDefgetFileDef () const override
 
FileDefgetFileDef () override
 
const NamespaceDefgetNamespaceDef () const override
 
NamespaceDefgetNamespaceDef () override
 
const GroupDefgetGroupDef () const override
 
const ModuleDefgetModuleDef () const override
 
ClassDefaccessorClass () const override
 
QCString getReadAccessor () const override
 
QCString getWriteAccessor () const override
 
Grouping::GroupPri_t getGroupPri () const override
 
QCString getGroupFileName () const override
 
int getGroupStartLine () const override
 
bool getGroupHasDocs () const override
 
QCString qualifiedName () const override
 
QCString objCMethodName (bool localLink, bool showStatic) const override
 
Protection protection () const override
 
Specifier virtualness (int count=0) const override
 
MemberType memberType () const override
 
QCString memberTypeName () const override
 
bool isSignal () const override
 
bool isSlot () const override
 
bool isVariable () const override
 
bool isEnumerate () const override
 
bool isEnumValue () const override
 
bool isTypedef () const override
 
bool isSequence () const override
 
bool isDictionary () const override
 
bool isFunction () const override
 
bool isFunctionPtr () const override
 
bool isDefine () const override
 
bool isFriend () const override
 
bool isDCOP () const override
 
bool isProperty () const override
 
bool isEvent () const override
 
bool isRelated () const override
 
bool isForeign () const override
 
bool isStatic () const override
 
bool isInline () const override
 
bool isExplicit () const override
 
bool isMutable () const override
 
bool isGettable () const override
 
bool isPrivateGettable () const override
 
bool isProtectedGettable () const override
 
bool isSettable () const override
 
bool isPrivateSettable () const override
 
bool isProtectedSettable () const override
 
bool isReadable () const override
 
bool isWritable () const override
 
bool isAddable () const override
 
bool isRemovable () const override
 
bool isRaisable () const override
 
bool isFinal () const override
 
bool isAbstract () const override
 
bool isOverride () const override
 
bool isInitonly () const override
 
bool isOptional () const override
 
bool isRequired () const override
 
bool isNonAtomic () const override
 
bool isCopy () const override
 
bool isAssign () const override
 
bool isRetain () const override
 
bool isWeak () const override
 
bool isStrong () const override
 
bool isEnumStruct () const override
 
bool isUnretained () const override
 
bool isNew () const override
 
bool isSealed () const override
 
bool isImplementation () const override
 
bool isExternal () const override
 
bool isTypeAlias () const override
 
bool isDefault () const override
 
bool isDelete () const override
 
bool isNoExcept () const override
 
bool isAttribute () const override
 
bool isUNOProperty () const override
 
bool isReadonly () const override
 
bool isBound () const override
 
bool isConstrained () const override
 
bool isTransient () const override
 
bool isMaybeVoid () const override
 
bool isMaybeDefault () const override
 
bool isMaybeAmbiguous () const override
 
bool isPublished () const override
 
bool isTemplateSpecialization () const override
 
bool isObjCMethod () const override
 
bool isObjCProperty () const override
 
bool isCSharpProperty () const override
 
bool isConstructor () const override
 
bool isDestructor () const override
 
bool hasOneLineInitializer () const override
 
bool hasMultiLineInitializer () const override
 
bool isCallable () const override
 
bool isStrongEnumValue () const override
 
bool livesInsideEnum () const override
 
bool isSliceLocal () const override
 
bool isNoDiscard () const override
 
bool isConstExpr () const override
 
bool isConstEval () const override
 
bool isConstInit () const override
 
int numberOfFlowKeyWords () const override
 
bool isFriendToHide () const override
 
bool isNotFriend () const override
 
bool isFunctionOrSignalSlot () const override
 
bool isRelatedOrFriend () const override
 
bool isLinkableInProject () const override
 
bool isLinkable () const override
 
bool hasDocumentation () const override
 
bool isDeleted () const override
 
bool isBriefSectionVisible () const override
 
bool isDetailedSectionVisible (MemberListContainer container) const override
 
bool hasDetailedDescription () const override
 
bool isFriendClass () const override
 
bool isDocumentedFriendClass () const override
 
const MemberDefreimplements () const override
 
const MemberVectorreimplementedBy () const override
 
bool isReimplementedBy (const ClassDef *cd) const override
 
ClassDefrelatedAlso () const override
 
bool hasDocumentedEnumValues () const override
 
const MemberDefgetAnonymousEnumType () const override
 
bool isDocsForDefinition () const override
 
const MemberDefgetEnumScope () const override
 
const MemberVectorenumFieldList () const override
 
void setEnumBaseType (const QCString &type) override
 
QCString enumBaseType () const override
 
bool hasExamples () const override
 
const ExampleListgetExamples () const override
 
bool isPrototype () const override
 
const ArgumentListargumentList () const override
 
const ArgumentListdeclArgumentList () const override
 
const ArgumentListtemplateArguments () const override
 
const ArgumentLists & definitionTemplateParameterLists () const override
 
std::optional< ArgumentListformalTemplateArguments () const override
 
int getMemberGroupId () const override
 
MemberGroupgetMemberGroup () const override
 
bool fromAnonymousScope () const override
 
MemberDeffromAnonymousMember () const override
 
bool hasCallGraph () const override
 
bool hasCallerGraph () const override
 
bool hasReferencesRelation () const override
 
bool hasReferencedByRelation () const override
 
bool hasInlineSource () const override
 
const MemberDeftemplateMaster () const override
 
QCString getScopeString () const override
 
ClassDefgetClassDefOfAnonymousType () const override
 
bool isTypedefValCached () const override
 
const ClassDefgetCachedTypedefVal () const override
 
QCString getCachedTypedefTemplSpec () const override
 
QCString getCachedResolvedTypedef () const override
 
MemberDefmemberDefinition () const override
 
MemberDefmemberDeclaration () const override
 
const MemberDefinheritsDocsFrom () const override
 
const MemberDefgetGroupAlias () const override
 
ClassDefcategory () const override
 
const MemberDefcategoryRelation () const override
 
QCString displayName (bool=TRUE) const override
 
QCString getDeclType () const override
 
StringVector getLabels (const Definition *container) const override
 
const ArgumentListtypeConstraints () const override
 
QCString requiresClause () const override
 
QCString documentation () const override
 
QCString briefDescription (bool abbr=FALSE) const override
 
QCString fieldType () const override
 
bool isReference () const override
 
QCString getDeclFileName () const override
 
int getDeclLine () const override
 
int getDeclColumn () const override
 
void setMemberType (MemberType t) override
 
void setDefinition (const QCString &d) override
 
void setFileDef (FileDef *fd) override
 
void setAnchor () override
 
void setProtection (Protection p) override
 
void setMemberSpecifiers (TypeSpecifier s) override
 
void setVhdlSpecifiers (VhdlSpecifier s) override
 
void mergeMemberSpecifiers (TypeSpecifier s) override
 
void setInitializer (const QCString &i) override
 
void setBitfields (const QCString &s) override
 
void setMaxInitLines (int lines) override
 
void setMemberClass (ClassDef *cd) override
 
void setSectionList (const Definition *container, const MemberList *sl) override
 
void setGroupDef (const GroupDef *gd, Grouping::GroupPri_t pri, const QCString &fileName, int startLine, bool hasDocs, MemberDef *member=nullptr) override
 
void setReadAccessor (const QCString &r) override
 
void setWriteAccessor (const QCString &w) override
 
void setTemplateSpecialization (bool b) override
 
void makeRelated () override
 
void makeForeign () override
 
void setInheritsDocsFrom (const MemberDef *md) override
 
void setTagInfo (const TagInfo *i) override
 
void setArgsString (const QCString &as) override
 
void setReimplements (MemberDef *md) override
 
void insertReimplementedBy (MemberDef *md) override
 
void setRelatedAlso (ClassDef *cd) override
 
void insertEnumField (MemberDef *md) override
 
void setEnumScope (const MemberDef *md, bool livesInsideEnum=FALSE) override
 
void setEnumClassScope (ClassDef *cd) override
 
void setDocumentedEnumValues (bool value) override
 
void setAnonymousEnumType (const MemberDef *md) override
 
bool addExample (const QCString &anchor, const QCString &name, const QCString &file) override
 
void setPrototype (bool p, const QCString &df, int line, int column) override
 
void setExplicitExternal (bool b, const QCString &df, int line, int column) override
 
void setDeclFile (const QCString &df, int line, int column) override
 
void moveArgumentList (std::unique_ptr< ArgumentList > al) override
 
void moveDeclArgumentList (std::unique_ptr< ArgumentList > al) override
 
void setDefinitionTemplateParameterLists (const ArgumentLists &lists) override
 
void setTypeConstraints (const ArgumentList &al) override
 
void setType (const QCString &t) override
 
void setAccessorType (ClassDef *cd, const QCString &t) override
 
void setNamespace (NamespaceDef *nd) override
 
void setMemberGroup (MemberGroup *grp) override
 
void setMemberGroupId (int id) override
 
void makeImplementationDetail () override
 
void setFromAnonymousScope (bool b) override
 
void setFromAnonymousMember (MemberDef *m) override
 
void overrideCallGraph (bool e) override
 
void overrideCallerGraph (bool e) override
 
void overrideReferencedByRelation (bool e) override
 
void overrideReferencesRelation (bool e) override
 
void overrideInlineSource (bool e) override
 
void setTemplateMaster (MemberDef *mt) override
 
void setFormalTemplateArguments (const ArgumentList &al) override
 
void addListReference (Definition *d) override
 
void setDocsForDefinition (bool b) override
 
void setGroupAlias (const MemberDef *md) override
 
void cacheTypedefVal (const ClassDef *val, const QCString &templSpec, const QCString &resolvedType) override
 
void invalidateTypedefValCache () override
 
void invalidateCachedArgumentTypes () override
 
void setMemberDefinition (MemberDef *md) override
 
void setMemberDeclaration (MemberDef *md) override
 
void copyArgumentNames (const MemberDef *bmd) override
 
void setCategory (ClassDef *) override
 
void setCategoryRelation (const MemberDef *) override
 
void setDocumentation (const QCString &d, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE) override
 
void setBriefDescription (const QCString &b, const QCString &briefFile, int briefLine) override
 
void setInbodyDocumentation (const QCString &d, const QCString &inbodyFile, int inbodyLine) override
 
void setHidden (bool b) override
 
void setRequiresClause (const QCString &req) override
 
void incrementFlowKeyWordCount () override
 
void writeDeclaration (OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod, bool inGroup, int indentLevel, const ClassDef *inheritFrom=nullptr, const QCString &inheritId=QCString()) const override
 
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 override
 
void writeMemberDocSimple (OutputList &ol, const Definition *container) const override
 
void writeEnumDeclaration (OutputList &typeDecl, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod) const override
 
void writeTagFile (TextStream &, bool useQualifiedName, bool showNamespaceMembers) const override
 
void warnIfUndocumented () const override
 
void warnIfUndocumentedParams () const override
 
bool visibleInIndex () const override
 
void detectUndocumentedParams (bool hasParamCommand, bool hasReturnCommand) const override
 
std::unique_ptr< MemberDefcreateTemplateInstanceMember (const ArgumentList &formalArgs, const std::unique_ptr< ArgumentList > &actualArgs) const override
 
void findSectionsInDocumentation () override
 
void writeLink (OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod, bool onlyText=FALSE) const override
 
void resolveUnnamedParameters (const MemberDef *md) override
 
void addQualifiers (const StringVector &qualifiers) override
 
StringVector getQualifiers () const override
 
ClassDefMutablegetClassDefMutable () override
 
void setModuleDef (ModuleDef *mod) override
 
- Public Member Functions inherited from DefinitionMixin< MemberDefMutable >
 DefinitionMixin (const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=TRUE)
 
bool isAlias () const override
 
const QCStringname () const override
 
bool isAnonymous () const override
 
const QCStringlocalName () const override
 
QCString qualifiedName () const override
 
QCString symbolName () const override
 
QCString getSourceFileBase () const override
 
QCString getSourceAnchor () const override
 
QCString documentation () const override
 
int docLine () const override
 
QCString docFile () const override
 
QCString briefDescription (bool abbreviate=FALSE) const override
 
QCString briefDescriptionAsTooltip () const override
 
int briefLine () const override
 
QCString inbodyDocumentation () const override
 
QCString inbodyFile () const override
 
int inbodyLine () const override
 
QCString briefFile () const override
 
QCString getDefFileName () const override
 
QCString getDefFileExtension () const override
 
int getDefLine () const override
 
int getDefColumn () const override
 
bool hasDocumentation () const override
 
bool hasUserDocumentation () const override
 
bool isVisibleInProject () const override
 
bool isVisible () const override
 
bool isHidden () const override
 
bool isArtificial () const override
 
bool isExported () const override
 
QCString getReference () const override
 
bool isReference () const override
 
QCString externalReference (const QCString &relPath) const override
 
int getStartDefLine () const override
 
int getStartBodyLine () const override
 
int getEndBodyLine () const override
 
const FileDefgetBodyDef () const override
 
SrcLangExt getLanguage () const override
 
const GroupListpartOfGroups () const override
 
bool isLinkableViaGroup () const override
 
const RefItemVector & xrefListItems () const override
 
const DefinitionfindInnerCompound (const QCString &name) const override
 
DefinitiongetOuterScope () const override
 
const MemberVectorgetReferencesMembers () const override
 
const MemberVectorgetReferencedByMembers () const override
 
bool hasSections () const override
 
bool hasSources () const override
 
bool hasBriefDescription () const override
 
QCString id () const override
 
const SectionRefsgetSectionRefs () const override
 
void setName (const QCString &name) override
 
void setId (const QCString &name) override
 
void setDefFile (const QCString &df, int defLine, int defColumn) override
 
void setDocumentation (const QCString &doc, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE) override
 
void setBriefDescription (const QCString &brief, const QCString &briefFile, int briefLine) override
 
void setInbodyDocumentation (const QCString &doc, const QCString &docFile, int docLine) override
 
void setReference (const QCString &r) override
 
void addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList) override
 
void setBodySegment (int defLine, int bls, int ble) override
 
void setBodyDef (const FileDef *fd) override
 
void addSourceReferencedBy (MemberDef *md) override
 
void addSourceReferences (MemberDef *md) override
 
void setRefItems (const RefItemVector &sli) override
 
void mergeRefItems (Definition *def) override
 
void mergeReferences (const Definition *other) override
 
void mergeReferencedBy (const Definition *other) override
 
void addInnerCompound (Definition *def) override
 
void setOuterScope (Definition *def) override
 
void setHidden (bool b) override
 
void setArtificial (bool b) override
 
void setExported (bool b) override
 
void setLanguage (SrcLangExt lang) override
 
void writeSourceDef (OutputList &ol, const QCString &scopeName) const override
 
void writeInlineCode (OutputList &ol, const QCString &scopeName) const override
 
bool hasSourceRefs () const override
 
bool hasSourceReffedBy () const override
 
void writeSourceRefs (OutputList &ol, const QCString &scopeName) const override
 
void writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const override
 
void makePartOfGroup (GroupDef *gd) override
 
void writeNavigationPath (OutputList &ol) const override
 
QCString navigationPathAsString () const override
 
void writeQuickMemberLinks (OutputList &ol, const MemberDef *md) const override
 
void writeSummaryLinks (OutputList &ol) const override
 
QCString pathFragment () const override
 
void writeDocAnchorsToTagFile (TextStream &fs) const override
 
void setLocalName (const QCString &name) override
 
void addSectionsToIndex () override
 
void writeToc (OutputList &ol, const LocalToc &lt) const override
 
void computeTooltip () override
 
void _setSymbolName (const QCString &name) override
 
QCString _symbolName () const override
 

Additional Inherited Members

- Public Types inherited from Definition
enum  DefType {
  TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeModule = 3,
  TypeMember = 4, TypeGroup = 5, TypePackage = 6, TypePage = 7,
  TypeDir = 8, TypeConcept = 9
}
 
- Protected Member Functions inherited from DefinitionMixin< MemberDefMutable >
 DefinitionMixin (const DefinitionMixin &def)=default
 

Constructor & Destructor Documentation

◆ MemberDefImpl()

MemberDefImpl::MemberDefImpl ( const QCString df,
int  dl,
int  dc,
const QCString t,
const QCString na,
const QCString a,
const QCString e,
Protection  p,
Specifier  v,
bool  s,
Relationship  r,
MemberType  mt,
const ArgumentList tal,
const ArgumentList al,
const QCString meta 
)

Creates a new member definition.

Parameters
dfFile containing the definition of this member.
dlLine at which the member definition was found.
dcColumn at which the member definition was found.
tA string representing the type of the member.
naA string representing the name of the member.
aA string representing the arguments of the member.
eA string representing the throw clause of the members.
pThe protection context of the member, possible values are: Public, Protected, Private.
vThe degree of 'virtualness' of the member, possible values are: Normal, Virtual, Pure.
sA boolean that is true iff the member is static.
rThe relationship between the class and the member.
mtThe kind of member. See #MemberType for a list of all types.
talThe template arguments of this member.
alThe arguments of this member. This is a structured form of the string past as argument a.
metaSlice metadata.

Member Function Documentation

◆ anchor()

QCString MemberDefImpl::anchor ( ) const
overridevirtual

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

Implements MemberDef.

◆ briefDescription()

QCString MemberDefImpl::briefDescription ( bool  abbreviate = FALSE) const
overridevirtual

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

Implements MemberDef.

◆ codeSymbolType()

CodeSymbolType MemberDefImpl::codeSymbolType ( ) const
overridevirtual

Used for syntax highlighting symbol class

Implements Definition.

◆ definitionType()

DefType MemberDefImpl::definitionType ( ) const
inlineoverridevirtual

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

Implements MemberDef.

◆ displayName()

QCString MemberDefImpl::displayName ( bool  includeScope = TRUE) const
overridevirtual

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

Implements MemberDef.

◆ documentation()

QCString MemberDefImpl::documentation ( ) const
overridevirtual

Returns the detailed description of this definition

Implements MemberDef.

◆ getClassDefOfAnonymousType()

ClassDef * MemberDefImpl::getClassDefOfAnonymousType ( ) const
overridevirtual

If this member has an anonymous class/struct/union as its type, then this method will return the ClassDef that describes this return type.

Implements MemberDef.

◆ getOutputFileBase()

QCString MemberDefImpl::getOutputFileBase ( ) const
overridevirtual

Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.

Implements MemberDef.

◆ getReference()

QCString MemberDefImpl::getReference ( ) const
overridevirtual

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

Implements MemberDef.

◆ hasDocumentation()

bool MemberDefImpl::hasDocumentation ( ) const
overridevirtual

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

See also
hasUserDocumentation()

Implements MemberDef.

◆ isBriefSectionVisible()

bool MemberDefImpl::isBriefSectionVisible ( ) const
overridevirtual

This methods returns TRUE iff the brief section (also known as declaration section) is visible in the documentation.

Implements MemberDef.

◆ isLinkable()

bool MemberDefImpl::isLinkable ( ) const
overridevirtual

Returns TRUE iff it is possible to link to this item. This can be a link to another project imported via a tag file.

Implements MemberDef.

◆ isLinkableInProject()

bool MemberDefImpl::isLinkableInProject ( ) const
overridevirtual

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

Implements MemberDef.

◆ isReference()

bool MemberDefImpl::isReference ( ) const
overridevirtual

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

Implements MemberDef.

◆ qualifiedName()

QCString MemberDefImpl::qualifiedName ( ) const
overridevirtual

Returns the fully qualified name of this definition

Implements MemberDef.

◆ setBriefDescription()

void MemberDefImpl::setBriefDescription ( const QCString b,
const QCString briefFile,
int  briefLine 
)
overridevirtual

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

Implements MemberDefMutable.

◆ setDocumentation()

void MemberDefImpl::setDocumentation ( const QCString d,
const QCString docFile,
int  docLine,
bool  stripWhiteSpace = TRUE 
)
overridevirtual

Sets the documentation of this definition to d.

Implements MemberDefMutable.

◆ setInbodyDocumentation()

void MemberDefImpl::setInbodyDocumentation ( const QCString d,
const QCString docFile,
int  docLine 
)
overridevirtual

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

◆ writeDeclaration()

void MemberDefImpl::writeDeclaration ( OutputList ol,
const ClassDef cd,
const NamespaceDef nd,
const FileDef fd,
const GroupDef gd,
const ModuleDef mod,
bool  inGroup,
int  indentLevel,
const ClassDef inheritFrom = nullptr,
const QCString inheritId = QCString() 
) const
overridevirtual

init.isEmpty() && initLines==0 && // one line initializer

Implements MemberDef.

◆ writeDocumentation()

void MemberDefImpl::writeDocumentation ( const MemberList ml,
int  memCount,
int  memTotal,
OutputList ol,
const QCString scName,
const Definition container,
bool  inGroup,
bool  showEnumValues = FALSE,
bool  showInline = FALSE 
) const
overridevirtual

Writes the "detailed documentation" section of this member to all active output formats.

Implements MemberDefMutable.


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