Doxygen
Loading...
Searching...
No Matches
MemberDefImpl Class Reference
Inheritance diagram for MemberDefImpl:
Collaboration diagram for MemberDefImpl:

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)
 ~MemberDefImpl () override=default
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
GroupDefgetGroupDef () 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 hasUserDocumentation () 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 ArgumentListsdefinitionTemplateParameterLists () 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 hasEnumValues () const override
bool hasInlineSource () const override
QCString sourceRefName () 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 (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 (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 overrideEnumValues (bool e) override
void overrideInlineSource (bool e) override
void setTemplateMaster (const 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
int redefineCount () const override
void setRedefineCount (int) 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)
DefinitionMixinoperator= (const DefinitionMixin &other)
 ~DefinitionMixin () override=default
bool isAlias () const override
const QCStringname () const override
bool isAnonymous () const override
const QCStringlocalName () const override
QCString symbolName () const override
QCString getSourceFileBase () const override
QCString getSourceAnchor () const override
int docLine () const override
QCString docFile () 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 isVisibleInProject () const override
bool isVisible () const override
bool isHidden () const override
bool isArtificial () const override
bool isExported () 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 RefItemVectorxrefListItems () 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 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, const QCString &sourceRefName) override
void addSourceReferences (MemberDef *md, const QCString &sourceRefName) 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 setArtificial (bool b) override
void setExported (bool b) override
void setLanguage (SrcLangExt lang) override
void writeSourceDef (OutputList &ol) 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
void writePageNavigation (OutputList &ol) const override
QCString pathFragment () const override
void writeDocAnchorsToTagFile (TextStream &fs) const override
void setLocalName (const QCString &name) override
void writeToc (OutputList &ol, const LocalToc &lt) const override
void computeTooltip () override
void _setSymbolName (const QCString &name) override
QCString _symbolName () const override

Private Member Functions

void _computeLinkableInProject ()
void _computeIsConstructor ()
void _computeIsDestructor ()
void _writeGroupInclude (OutputList &ol, bool inGroup) const
void _writeMultiLineInitializer (OutputList &ol, const QCString &scopeName) const
void _writeCallGraph (OutputList &ol) const
void _writeCallerGraph (OutputList &ol) const
void _writeReimplements (OutputList &ol) const
bool _isReimplements () const
void _writeReimplementedBy (OutputList &ol) const
size_t _countReimplementedBy () const
void _writeExamples (OutputList &ol) const
void _writeTypeConstraints (OutputList &ol) const
void _writeEnumValues (OutputList &ol, const Definition *container, const QCString &cfname, const QCString &ciname, const QCString &cname) const
void _writeCategoryRelation (OutputList &ol) const
void _writeTagData (const DefType) const
void _writeTemplatePrefix (OutputList &ol, const Definition *def, const ArgumentList &al, bool writeReqClause=true) const
bool _hasVisibleCallGraph () const
bool _hasVisibleCallerGraph () const
bool _isAnonymousBitField () const
void init (Definition *def, const QCString &t, 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)

Private Attributes

uint8_t m_isLinkableCached
uint8_t m_isConstructorCached
uint8_t m_isDestructorCached
ClassDefm_classDef = nullptr
FileDefm_fileDef = nullptr
NamespaceDefm_nspace = nullptr
ModuleDefm_moduleDef = nullptr
const MemberDefm_enumScope = nullptr
bool m_livesInsideEnum = false
const MemberDefm_annEnumType = nullptr
MemberVector m_enumFields
MemberDefm_redefines = nullptr
MemberVector m_redefinedBy
MemberDefm_memDef = nullptr
MemberDefm_memDec = nullptr
ClassDefm_relatedAlso = nullptr
ExampleList m_examples
QCString m_type
QCString m_accessorType
ClassDefm_accessorClass = nullptr
QCString m_args
QCString m_def
QCString m_anc
Specifier m_virt = Specifier::Normal
Protection m_prot = Protection::Public
QCString m_decl
QCString m_bitfields
QCString m_read
QCString m_write
QCString m_exception
QCString m_initializer
QCString m_extraTypeChars
QCString m_enumBaseType
QCString m_requiresClause
int m_initLines = 0
TypeSpecifier m_memSpec
VhdlSpecifier m_vhdlSpec
MemberType m_mtype = MemberType::Define
int m_maxInitLines = 0
int m_userInitLines = 0
MemberDefm_annMemb = nullptr
ArgumentList m_defArgList
ArgumentList m_declArgList
ArgumentList m_tArgList
ArgumentList m_typeConstraints
const MemberDefm_templateMaster = nullptr
std::optional< ArgumentListm_formalTemplateArguments
ArgumentLists m_defTmpArgLists
QCString m_metaData
ClassDefm_cachedAnonymousType = nullptr
std::map< const Definition *, const MemberList * > m_sectionMap
const MemberDefm_groupAlias = nullptr
int m_grpId = 0
MemberGroupm_memberGroup = nullptr
GroupDefm_group = nullptr
Grouping::GroupPri_t m_grouppri = Grouping::GROUPING_AUTO_DEF
QCString m_groupFileName
int m_groupStartLine = 0
MemberDefm_groupMember = nullptr
bool m_isTypedefValCached = false
const ClassDefm_cachedTypedefValue = nullptr
QCString m_cachedTypedefTemplSpec
QCString m_cachedResolvedType
const MemberDefm_docProvider = nullptr
QCString m_explicitOutputFileBase
StringVector m_qualifiers
bool m_implOnly = false
bool m_hasDocumentedParams = false
bool m_hasDocumentedReturnType = false
bool m_isDMember = false
Relationship m_related = Relationship::Member
bool m_stat = false
bool m_proto = false
bool m_docEnumValues = false
bool m_annScope = false
bool m_hasDetailedDescriptionCached = false
bool m_detailedDescriptionCachedValue = false
bool m_hasCallGraph = false
bool m_hasCallerGraph = false
bool m_hasReferencedByRelation = false
bool m_hasReferencesRelation = false
bool m_hasInlineSource = false
bool m_hasEnumValues = false
bool m_explExt = false
bool m_tspec = false
bool m_groupHasDocs = false
bool m_docsForDefinition = false
ClassDefm_category = nullptr
const MemberDefm_categoryRelation = nullptr
QCString m_declFileName
int m_declLine = -1
int m_declColumn = -1
int m_numberOfFlowKW = 0
int m_redefineCount = 0

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
}

Detailed Description

Definition at line 53 of file memberdef.cpp.

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.

Definition at line 1433 of file memberdef.cpp.

1438{
1439 //printf("MemberDefImpl::MemberDef(%s)\n",qPrint(na));
1440 init(this,t,a,e,p,v,s,r,mt,tal,al,meta);
1444}
DefinitionMixin(const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=TRUE)
void init(Definition *def, const QCString &t, 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)
uint8_t m_isConstructorCached
uint8_t m_isDestructorCached
uint8_t m_isLinkableCached
QCString removeRedundantWhiteSpace(const QCString &s)
Definition util.cpp:579

References DefinitionMixin< MemberDefMutable >::DefinitionMixin(), init(), m_isConstructorCached, m_isDestructorCached, m_isLinkableCached, and removeRedundantWhiteSpace().

Referenced by deepCopy(), isConstructor(), isDestructor(), isLinkableInProject(), and ~MemberDefImpl().

◆ ~MemberDefImpl()

MemberDefImpl::~MemberDefImpl ( )
overridedefault

References MemberDefImpl().

Member Function Documentation

◆ _computeIsConstructor()

void MemberDefImpl::_computeIsConstructor ( )
private

Definition at line 4679 of file memberdef.cpp.

4680{
4681 m_isConstructorCached=1; // FALSE
4682 if (getClassDef())
4683 {
4684 if (m_isDMember) // for D
4685 {
4686 m_isConstructorCached = name()=="this" ? 2 : 1;
4687 return;
4688 }
4689 else if (getLanguage()==SrcLangExt::PHP) // for PHP
4690 {
4691 m_isConstructorCached = name()=="__construct" ? 2 : 1;
4692 return;
4693 }
4694 else if (name()=="__init__" &&
4695 getLanguage()==SrcLangExt::Python) // for Python
4696 {
4697 m_isConstructorCached = 2; // TRUE
4698 return;
4699 }
4700 else // for other languages
4701 {
4702 QCString locName = getClassDef()->localName();
4703 int i=locName.find('<');
4704 if (i==-1) // not a template class
4705 {
4706 m_isConstructorCached = name()==locName ? 2 : 1;
4707 }
4708 else
4709 {
4710 m_isConstructorCached = name()==locName.left(i) ? 2 : 1;
4711 }
4712 return;
4713 }
4714 }
4715}
virtual const QCString & localName() const =0
const QCString & name() const override
SrcLangExt getLanguage() const override
const ClassDef * getClassDef() const override
int find(char c, int index=0, bool cs=TRUE) const
Definition qcstring.cpp:43
QCString left(size_t len) const
Definition qcstring.h:214

References QCString::find(), getClassDef(), DefinitionMixin< MemberDefMutable >::getLanguage(), QCString::left(), Definition::localName(), m_isConstructorCached, m_isDMember, and DefinitionMixin< MemberDefMutable >::name().

Referenced by isConstructor().

◆ _computeIsDestructor()

void MemberDefImpl::_computeIsDestructor ( )
private

Definition at line 4729 of file memberdef.cpp.

4730{
4731 bool isDestructor = false;
4732 if (m_isDMember) // for D
4733 {
4734 isDestructor = name()=="~this";
4735 }
4736 else if (getLanguage()==SrcLangExt::PHP) // for PHP
4737 {
4738 isDestructor = name()=="__destruct";
4739 }
4740 else if (name()=="__del__" &&
4741 getLanguage()==SrcLangExt::Python) // for Python
4742 {
4743 isDestructor = true;
4744 }
4745 else if (getLanguage()==SrcLangExt::Fortran) // for Fortran
4746 {
4747 isDestructor = typeString()=="final";
4748 }
4749 else // other languages
4750 {
4751 isDestructor =
4752 (name().find('~')!=-1 || name().find('!')!=-1) // The ! is for C++/CLI
4753 && name().find("operator")==-1;
4754 }
4756}
bool isDestructor() const override
QCString typeString() const override

References QCString::find(), DefinitionMixin< MemberDefMutable >::getLanguage(), isDestructor(), m_isDestructorCached, m_isDMember, DefinitionMixin< MemberDefMutable >::name(), and typeString().

Referenced by isDestructor().

◆ _computeLinkableInProject()

void MemberDefImpl::_computeLinkableInProject ( )
private

Definition at line 1786 of file memberdef.cpp.

1787{
1788 AUTO_TRACE("name={}",qualifiedName());
1789 bool extractStatic = Config_getBool(EXTRACT_STATIC);
1790 bool extractPrivateVirtual = Config_getBool(EXTRACT_PRIV_VIRTUAL);
1791 m_isLinkableCached = 2; // linkable
1792 //printf("MemberDefImpl::isLinkableInProject(name=%s)\n",qPrint(name()));
1793 if (isHidden())
1794 {
1795 AUTO_TRACE_ADD("is hidden");
1797 return;
1798 }
1799 if (templateMaster())
1800 {
1801 AUTO_TRACE_ADD("has master template");
1803 return;
1804 }
1805 if (isAnonymous())
1806 {
1807 AUTO_TRACE_ADD("name invalid");
1808 m_isLinkableCached = 1; // not a valid or a dummy name
1809 return;
1810 }
1811 if (!hasDocumentation() || isReference())
1812 {
1813 AUTO_TRACE_ADD("no docs or reference");
1814 m_isLinkableCached = 1; // no documentation
1815 return;
1816 }
1817 const GroupDef *groupDef = getGroupDef();
1818 const ClassDef *classDef = getClassDef();
1819 if (groupDef && !groupDef->isLinkableInProject())
1820 {
1821 AUTO_TRACE_ADD("in not linkable group");
1822 m_isLinkableCached = 1; // group but group not linkable
1823 return;
1824 }
1825 if (!groupDef && classDef && !classDef->isLinkableInProject())
1826 {
1827 AUTO_TRACE_ADD("in not linkable class");
1828 m_isLinkableCached = 1; // in class but class not linkable
1829 return;
1830 }
1831 const NamespaceDef *nspace = getNamespaceDef();
1832 const FileDef *fileDef = getFileDef();
1833 if (!groupDef && nspace /*&& m_related==Relationship::Member*/ && !nspace->isLinkableInProject()
1834 && (fileDef==nullptr || !fileDef->isLinkableInProject()))
1835 {
1836 AUTO_TRACE_ADD("in not linkable namespace");
1837 m_isLinkableCached = 1; // in namespace but namespace not linkable
1838 return;
1839 }
1840 if (!groupDef && !nspace &&
1841 /*m_related==Relationship::Member &&*/ !classDef &&
1842 fileDef && !fileDef->isLinkableInProject())
1843 {
1844 AUTO_TRACE_ADD("in not linkable file");
1845 m_isLinkableCached = 1; // in file (and not in namespace) but file not linkable
1846 return;
1847 }
1849 !(m_prot==Protection::Private && (m_virt!=Specifier::Normal || isOverride() || isFinal()) && extractPrivateVirtual))
1850 {
1851 AUTO_TRACE_ADD("private and invisible");
1852 m_isLinkableCached = 1; // hidden due to protection
1853 return;
1854 }
1855 if (m_stat && classDef==nullptr && !extractStatic)
1856 {
1857 AUTO_TRACE_ADD("static and invisible");
1858 m_isLinkableCached = 1; // hidden due to staticness
1859 return;
1860 }
1861 AUTO_TRACE_ADD("linkable");
1862 return; // linkable!
1863}
virtual bool isLinkableInProject() const =0
MemberType m_mtype
const NamespaceDef * getNamespaceDef() const override
QCString qualifiedName() const override
Specifier m_virt
bool isReference() const override
Protection m_prot
const GroupDef * getGroupDef() const override
const MemberDef * templateMaster() const override
bool isFinal() const override
bool hasDocumentation() const override
const FileDef * getFileDef() const override
bool isOverride() const override
#define Config_getBool(name)
Definition config.h:33
#define AUTO_TRACE_ADD(...)
Definition docnode.cpp:47
#define AUTO_TRACE(...)
Definition docnode.cpp:46
bool protectionLevelVisible(Protection prot)
Definition util.cpp:6456

References AUTO_TRACE, AUTO_TRACE_ADD, Config_getBool, Friend, getClassDef(), getFileDef(), getGroupDef(), getNamespaceDef(), hasDocumentation(), DefinitionMixin< MemberDefMutable >::isAnonymous(), isFinal(), DefinitionMixin< MemberDefMutable >::isHidden(), Definition::isLinkableInProject(), isOverride(), isReference(), m_isLinkableCached, m_mtype, m_prot, m_stat, m_virt, protectionLevelVisible(), qualifiedName(), and templateMaster().

Referenced by isLinkableInProject().

◆ _countReimplementedBy()

size_t MemberDefImpl::_countReimplementedBy ( ) const
private

Definition at line 3047 of file memberdef.cpp.

3048{
3049 const MemberVector &bml=reimplementedBy();
3050 size_t count=0;
3051 for (const auto &bmd : bml)
3052 {
3053 const ClassDef *bcd=bmd->getClassDef();
3054 // count the members that directly inherit from md and for
3055 // which the member and class are visible in the docs.
3056 if ( bcd && bmd->isLinkable() && bcd->isLinkable() )
3057 {
3058 count++;
3059 }
3060 }
3061 return count;
3062}
virtual bool isLinkable() const =0
const MemberVector & reimplementedBy() const override

References Definition::isLinkable(), and reimplementedBy().

Referenced by _writeReimplementedBy(), and hasDetailedDescription().

◆ _hasVisibleCallerGraph()

bool MemberDefImpl::_hasVisibleCallerGraph ( ) const
private

Definition at line 5701 of file memberdef.cpp.

5702{
5703 bool enabled = m_hasCallerGraph &&
5704 (isFunction() || isSlot() || isSignal()) &&
5705 Config_getBool(HAVE_DOT);
5706 if (enabled)
5707 {
5708 bool trivial = DotCallGraph::isTrivial(this,TRUE);
5709 return !trivial;
5710 }
5711 return FALSE;
5712}
bool isTrivial() const
bool isFunction() const override
bool m_hasCallerGraph
bool isSlot() const override
bool isSignal() const override
#define TRUE
Definition qcstring.h:37
#define FALSE
Definition qcstring.h:34

References Config_getBool, FALSE, isFunction(), isSignal(), isSlot(), DotCallGraph::isTrivial(), m_hasCallerGraph, and TRUE.

Referenced by _writeCallerGraph(), and hasDetailedDescription().

◆ _hasVisibleCallGraph()

bool MemberDefImpl::_hasVisibleCallGraph ( ) const
private

Definition at line 5683 of file memberdef.cpp.

5684{
5685 bool enabled = m_hasCallGraph &&
5686 (isFunction() || isSlot() || isSignal()) &&
5687 Config_getBool(HAVE_DOT);
5688 if (enabled)
5689 {
5690 bool trivial = DotCallGraph::isTrivial(this,FALSE);
5691 return !trivial;
5692 }
5693 return FALSE;
5694}

References Config_getBool, FALSE, isFunction(), isSignal(), isSlot(), DotCallGraph::isTrivial(), and m_hasCallGraph.

Referenced by _writeCallGraph(), and hasDetailedDescription().

◆ _isAnonymousBitField()

bool MemberDefImpl::_isAnonymousBitField ( ) const
private

Definition at line 2213 of file memberdef.cpp.

2214{
2215 return !m_bitfields.isEmpty() && name().startsWith("__pad"); // anonymous bitfield
2216}
QCString m_bitfields
bool startsWith(const char *s) const
Definition qcstring.h:492

References m_bitfields, DefinitionMixin< MemberDefMutable >::name(), and QCString::startsWith().

Referenced by warnIfUndocumented(), and writeDeclaration().

◆ _isReimplements()

bool MemberDefImpl::_isReimplements ( ) const
private

Definition at line 2974 of file memberdef.cpp.

2975{
2976 const MemberDef *bmd=reimplements();
2977 const ClassDef *bcd=nullptr;
2978 if (bmd && (bcd=bmd->getClassDef()))
2979 {
2980 // write class that contains a member that is reimplemented by this one
2981 if (bcd->isLinkable())
2982 {
2983 return true;
2984 }
2985 }
2986 return false;
2987}
virtual const ClassDef * getClassDef() const =0
const MemberDef * reimplements() const override

References MemberDef::getClassDef(), Definition::isLinkable(), and reimplements().

Referenced by hasDetailedDescription().

◆ _writeCallerGraph()

void MemberDefImpl::_writeCallerGraph ( OutputList & ol) const
private

Definition at line 2952 of file memberdef.cpp.

2953{
2955 {
2956 DotCallGraph callerGraph(this, TRUE);
2957 if (callerGraph.isTooBig())
2958 {
2959 warn_uncond("Caller graph for '{}' not generated, too many nodes ({}), threshold is {}. Consider increasing DOT_GRAPH_MAX_NODES.\n",
2960 qualifiedName(), callerGraph.numNodes(), Config_getInt(DOT_GRAPH_MAX_NODES));
2961 }
2962 else if (!callerGraph.isTrivial())
2963 {
2964 msg("Generating caller graph for function {}\n",qualifiedName());
2966 ol.startCallGraph();
2968 ol.endCallGraph(callerGraph);
2969 ol.enableAll();
2970 }
2971 }
2972}
bool _hasVisibleCallerGraph() const
void disable(OutputType o)
void startCallGraph()
Definition outputlist.h:658
void endCallGraph(DotCallGraph &g)
Definition outputlist.h:660
void enableAll()
void parseText(const QCString &textStr)
virtual QCString trCallerGraph()=0
#define Config_getInt(name)
Definition config.h:34
Translator * theTranslator
Definition language.cpp:71
#define warn_uncond(fmt,...)
Definition message.h:122
#define msg(fmt,...)
Definition message.h:94

References _hasVisibleCallerGraph(), Config_getInt, OutputList::disable(), OutputList::enableAll(), OutputList::endCallGraph(), DotCallGraph::isTooBig(), DotCallGraph::isTrivial(), Man, msg, DotCallGraph::numNodes(), OutputList::parseText(), qualifiedName(), OutputList::startCallGraph(), theTranslator, TRUE, and warn_uncond.

Referenced by writeDocumentation().

◆ _writeCallGraph()

void MemberDefImpl::_writeCallGraph ( OutputList & ol) const
private

Definition at line 2929 of file memberdef.cpp.

2930{
2931 // write call graph
2933 {
2934 DotCallGraph callGraph(this,FALSE);
2935 if (callGraph.isTooBig())
2936 {
2937 warn_uncond("Call graph for '{}' not generated, too many nodes ({}), threshold is {}. Consider increasing DOT_GRAPH_MAX_NODES.\n",
2938 qualifiedName(), callGraph.numNodes(), Config_getInt(DOT_GRAPH_MAX_NODES));
2939 }
2940 else if (!callGraph.isTrivial())
2941 {
2942 msg("Generating call graph for function {}\n",qualifiedName());
2944 ol.startCallGraph();
2946 ol.endCallGraph(callGraph);
2947 ol.enableAll();
2948 }
2949 }
2950}
bool _hasVisibleCallGraph() const
virtual QCString trCallGraph()=0

References _hasVisibleCallGraph(), Config_getInt, OutputList::disable(), OutputList::enableAll(), OutputList::endCallGraph(), FALSE, DotCallGraph::isTooBig(), DotCallGraph::isTrivial(), Man, msg, DotCallGraph::numNodes(), OutputList::parseText(), qualifiedName(), OutputList::startCallGraph(), theTranslator, and warn_uncond.

Referenced by writeDocumentation().

◆ _writeCategoryRelation()

void MemberDefImpl::_writeCategoryRelation ( OutputList & ol) const
private

Definition at line 3123 of file memberdef.cpp.

3124{
3125 if (getClassDef()) // this should be a member of a class/category
3126 {
3127 //printf("%s: category %s relation %s class=%s categoryOf=%s\n",
3128 // qPrint(name()),
3129 // m_category ? qPrint(m_category->name()) : "<none>",
3130 // m_categoryRelation ? qPrint(m_categoryRelation->name()) : "<none>",
3131 // qPrint(m_classDef->name()),
3132 // m_classDef->categoryOf() ? qPrint(m_classDef->categoryOf()->name()) : "<none>"
3133 // );
3134 QCString text;
3135 QCString ref;
3136 QCString file;
3137 QCString anc;
3138 QCString name;
3139 int i=-1;
3140 if (m_categoryRelation && m_categoryRelation->isLinkable())
3141 {
3142 if (m_category)
3143 {
3144 // this member is in a normal class and implements method categoryRelation from category
3145 // so link to method 'categoryRelation' with 'provided by category 'category' text.
3147 name = m_category->displayName();
3148 }
3149 else if (getClassDef()->categoryOf())
3150 {
3151 // this member is part of a category so link to the corresponding class member of the class we extend
3152 // so link to method 'categoryRelation' with 'extends class 'classDef->categoryOf()'
3153 text = theTranslator->trExtendsClass();
3155 }
3156 i=text.find("@0");
3157 if (i!=-1)
3158 {
3159 const MemberDef *md = m_categoryRelation;
3160 ref = md->getReference();
3161 file = md->getOutputFileBase();
3162 anc = md->anchor();
3163 }
3164 }
3165 if (i!=-1 && !name.isEmpty())
3166 {
3167 ol.startParagraph();
3168 ol.parseText(text.left(i));
3169 ol.writeObjectLink(ref,file,anc,name);
3170 ol.parseText(text.mid(i+2));
3171 ol.endParagraph();
3172 }
3173 }
3174}
virtual ClassDef * categoryOf() const =0
Returns the class of which this is a category (Objective-C only).
virtual QCString anchor() const =0
virtual QCString getReference() const =0
virtual QCString displayName(bool includeScope=TRUE) const =0
virtual QCString getOutputFileBase() const =0
virtual const QCString & name() const =0
const MemberDef * m_categoryRelation
ClassDef * m_category
void writeObjectLink(const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name)
Definition outputlist.h:441
void startParagraph(const QCString &classDef=QCString())
Definition outputlist.h:409
void endParagraph()
Definition outputlist.h:411
QCString mid(size_t index, size_t len=static_cast< size_t >(-1)) const
Definition qcstring.h:226
virtual QCString trProvidedByCategory()=0
virtual QCString trExtendsClass()=0

References Definition::anchor(), ClassDef::categoryOf(), Definition::displayName(), OutputList::endParagraph(), QCString::find(), getClassDef(), Definition::getOutputFileBase(), Definition::getReference(), QCString::left(), m_category, m_categoryRelation, QCString::mid(), DefinitionMixin< MemberDefMutable >::name(), OutputList::parseText(), OutputList::startParagraph(), theTranslator, and OutputList::writeObjectLink().

Referenced by writeDocumentation().

◆ _writeEnumValues()

void MemberDefImpl::_writeEnumValues ( OutputList & ol,
const Definition * container,
const QCString & cfname,
const QCString & ciname,
const QCString & cname ) const
private

Definition at line 3197 of file memberdef.cpp.

3200{
3201 // For enum, we also write the documented enum values
3202 if (isEnumerate())
3203 {
3204 bool first=true;
3205 //printf("** %s: enum values=%zu\n",qPrint(name()),enumFieldList().size());
3206 bool hasInits = false;
3207 if (hasEnumValues())
3208 {
3209 for (const auto &fmd : enumFieldList())
3210 {
3211 if (fmd->isLinkable())
3212 {
3213 if (!fmd->initializer().isEmpty())
3214 {
3215 hasInits = true;
3216 break;
3217 }
3218 }
3219 }
3220 }
3221 for (const auto &fmd : enumFieldList())
3222 {
3223 //printf("Enum %p: isLinkable()=%d\n",fmd,fmd->isLinkable());
3224 if (fmd->isLinkable())
3225 {
3226 if (first)
3227 {
3229 first=false;
3230 }
3231
3232 ol.startDescTableRow();
3233 ol.addIndexItem(fmd->name(),ciname);
3234 ol.addIndexItem(ciname,fmd->name());
3235
3237 ol.startDoxyAnchor(cfname,cname,fmd->anchor(),fmd->name(),fmd->argsString());
3238 ol.addLabel(cfname,fmd->anchor());
3239 ol.docify(fmd->name());
3241 ol.writeString(" ");
3242 ol.enableAll();
3243 ol.endDoxyAnchor(cfname,fmd->anchor());
3244 ol.endDescTableTitle();
3245 if (hasInits)
3246 {
3247 ol.startDescTableInit();
3248 if (!fmd->initializer().isEmpty())
3249 {
3250 QCString initStr = fmd->initializer().stripWhiteSpace();
3251 if (initStr.startsWith("=")) initStr = initStr.mid(1).stripWhiteSpace();
3253 ol.writeString("(");
3254 ol.enableAll();
3255 ol.docify(initStr);
3257 ol.writeString(")");
3258 ol.enableAll();
3259 }
3260 ol.endDescTableInit();
3261 }
3262 ol.startDescTableData();
3263
3264 bool hasBrief = !fmd->briefDescription().isEmpty();
3265 bool hasDetails = !fmd->documentation().isEmpty();
3266
3267 if (hasBrief)
3268 {
3269 ol.generateDoc(fmd->briefFile(),fmd->briefLine(),
3270 getOuterScope()?getOuterScope():container,
3271 fmd,fmd->briefDescription(),TRUE,FALSE,
3272 QCString(),FALSE,FALSE);
3273 }
3274 if (hasDetails)
3275 {
3276 ol.generateDoc(fmd->docFile(),fmd->docLine(),
3277 getOuterScope()?getOuterScope():container,
3278 fmd,fmd->documentation()+"\n",TRUE,FALSE,
3279 QCString(),FALSE,FALSE);
3280 }
3281 ol.endDescTableData();
3282 ol.endDescTableRow();
3283 }
3284 }
3285 if (!first)
3286 {
3287 ol.endDescTable();
3288 }
3289 }
3290}
virtual QCString briefDescription(bool abbreviate=FALSE) const =0
virtual QCString documentation() const =0
virtual Definition * getOuterScope() const =0
Definition * getOuterScope() const override
bool isEnumerate() const override
bool hasEnumValues() const override
const MemberVector & enumFieldList() const override
void writeString(const QCString &text)
Definition outputlist.h:413
void endDescTableRow()
Definition outputlist.h:636
void startDescTableInit()
Definition outputlist.h:642
void endDescTable()
Definition outputlist.h:632
void endDescTableTitle()
Definition outputlist.h:640
void endDoxyAnchor(const QCString &fn, const QCString &anchor)
Definition outputlist.h:543
void docify(const QCString &s)
Definition outputlist.h:439
void endDescTableData()
Definition outputlist.h:648
void addIndexItem(const QCString &s1, const QCString &s2)
Definition outputlist.h:592
void startDescTableTitle()
Definition outputlist.h:638
void startDescTable(const QCString &title, const bool hasInits)
Definition outputlist.h:630
void addLabel(const QCString &fName, const QCString &anchor)
Definition outputlist.h:545
void startDescTableData()
Definition outputlist.h:646
void disableAllBut(OutputType o)
void startDoxyAnchor(const QCString &fName, const QCString &manName, const QCString &anchor, const QCString &name, const QCString &args)
Definition outputlist.h:539
void generateDoc(const QCString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const QCString &docStr, bool indexWords, bool isExample, const QCString &exampleName, bool singleLine, bool linkFromIndex, bool markdownSupport=Config_getBool(MARKDOWN_SUPPORT), bool autolinkSupport=Config_getBool(AUTOLINK_SUPPORT))
void endDescTableInit()
Definition outputlist.h:644
void startDescTableRow()
Definition outputlist.h:634
QCString stripWhiteSpace() const
returns a copy of this string with leading and trailing whitespace removed
Definition qcstring.h:245
virtual QCString trEnumerationValues()=0

References OutputList::addIndexItem(), OutputList::addLabel(), Definition::briefDescription(), OutputList::disableAllBut(), OutputList::docify(), Definition::documentation(), OutputList::enableAll(), OutputList::endDescTable(), OutputList::endDescTableData(), OutputList::endDescTableInit(), OutputList::endDescTableRow(), OutputList::endDescTableTitle(), OutputList::endDoxyAnchor(), enumFieldList(), FALSE, OutputList::generateDoc(), DefinitionMixin< MemberDefMutable >::getOuterScope(), hasEnumValues(), isEnumerate(), Man, QCString::mid(), OutputList::startDescTable(), OutputList::startDescTableData(), OutputList::startDescTableInit(), OutputList::startDescTableRow(), OutputList::startDescTableTitle(), OutputList::startDoxyAnchor(), QCString::startsWith(), QCString::stripWhiteSpace(), theTranslator, TRUE, and OutputList::writeString().

Referenced by writeDocumentation().

◆ _writeExamples()

void MemberDefImpl::_writeExamples ( OutputList & ol) const
private

Definition at line 3176 of file memberdef.cpp.

3177{
3178 // write the list of examples that use this member
3179 if (hasExamples())
3180 {
3181 ol.startExamples();
3182 ol.startDescForItem();
3184 ol.endDescForItem();
3185 ol.endExamples();
3186 }
3187}
ExampleList m_examples
bool hasExamples() const override
void endDescForItem()
Definition outputlist.h:551
void endExamples()
Definition outputlist.h:582
void startExamples()
Definition outputlist.h:580
void startDescForItem()
Definition outputlist.h:549
void writeExamples(OutputList &ol, const ExampleList &list)
Definition util.cpp:1128

References OutputList::endDescForItem(), OutputList::endExamples(), hasExamples(), m_examples, OutputList::startDescForItem(), OutputList::startExamples(), and writeExamples().

Referenced by writeDocumentation().

◆ _writeGroupInclude()

void MemberDefImpl::_writeGroupInclude ( OutputList & ol,
bool inGroup ) const
private

Definition at line 3370 of file memberdef.cpp.

3371{
3372 // only write out the include file if this is not part of a class or file
3373 // definition
3374 bool showGroupedMembInc = Config_getBool(SHOW_GROUPED_MEMB_INC);
3375 const FileDef *fd = getFileDef();
3376 QCString nm;
3377 if (inGroup && fd && showGroupedMembInc)
3378 {
3379 nm = fd->absFilePath();
3380 nm = stripFromIncludePath(nm);
3381 }
3382 if (!nm.isEmpty())
3383 {
3384 ol.startParagraph();
3385 ol.startTypewriter();
3386 SrcLangExt lang = getLanguage();
3387 bool isIDLorJava = lang==SrcLangExt::IDL || lang==SrcLangExt::Java;
3388 if (isIDLorJava)
3389 {
3390 ol.docify("import ");
3391 }
3392 else
3393 {
3394 ol.docify("#include ");
3395 }
3396
3397 if (isIDLorJava) ol.docify("\""); else ol.docify("<");
3398
3399 if (fd->isLinkable())
3400 {
3401 ol.writeObjectLink(fd->getReference(),fd->getOutputFileBase(),fd->anchor(),nm);
3402 }
3403 else
3404 {
3405 ol.docify(nm);
3406 }
3407
3408 if (isIDLorJava) ol.docify("\""); else ol.docify(">");
3409
3410 ol.endTypewriter();
3411 ol.endParagraph();
3412 }
3413}
virtual QCString absFilePath() const =0
void startTypewriter()
Definition outputlist.h:451
void endTypewriter()
Definition outputlist.h:453
bool isEmpty() const
Returns TRUE iff the string is empty.
Definition qcstring.h:150
SrcLangExt
Definition types.h:207
QCString stripFromIncludePath(const QCString &path)
Definition util.cpp:341

References FileDef::absFilePath(), Definition::anchor(), Config_getBool, OutputList::docify(), OutputList::endParagraph(), OutputList::endTypewriter(), getFileDef(), DefinitionMixin< MemberDefMutable >::getLanguage(), Definition::getOutputFileBase(), Definition::getReference(), QCString::isEmpty(), Definition::isLinkable(), OutputList::startParagraph(), OutputList::startTypewriter(), stripFromIncludePath(), and OutputList::writeObjectLink().

Referenced by writeDocumentation().

◆ _writeMultiLineInitializer()

void MemberDefImpl::_writeMultiLineInitializer ( OutputList & ol,
const QCString & scopeName ) const
private

Definition at line 3415 of file memberdef.cpp.

3416{
3417 //printf("md=%s initLines=%d init='%s'\n",qPrint(name()),initLines,qPrint(init));
3418 ol.startBold();
3421 else
3423 ol.endBold();
3424 QCString langCorrected = getDefFileExtension();
3426 if (srcLangExt == SrcLangExt::Lex)
3427 {
3428 langCorrected = ".doxygen_lex_c";
3429 srcLangExt = SrcLangExt::Cpp;
3430 }
3431 auto intf = Doxygen::parserManager->getCodeParser(langCorrected);
3432 intf->resetCodeParserState();
3433 auto &codeOL = ol.codeGenerators();
3434 codeOL.startCodeFragment("DoxyCode");
3435 intf->parseCode(codeOL,scopeName,m_initializer,srcLangExt,Config_getBool(STRIP_CODE_COMMENTS),FALSE,QCString(),getFileDef(),
3436 -1,-1,TRUE,this,FALSE,this);
3437 codeOL.endCodeFragment("DoxyCode");
3438}
QCString getDefFileExtension() const override
static ParserManager * parserManager
Definition doxygen.h:131
QCString m_initializer
void startCodeFragment(const QCString &style)
Definition outputlist.h:278
const OutputCodeList & codeGenerators() const
Definition outputlist.h:357
void startBold()
Definition outputlist.h:563
void endBold()
Definition outputlist.h:565
std::unique_ptr< CodeParserInterface > getCodeParser(const QCString &extension)
Gets the interface to the parser associated with a given extension.
Definition parserintf.h:218
virtual QCString trDefineValue()=0
virtual QCString trInitialValue()=0
SrcLangExt getLanguageFromFileName(const QCString &fileName, SrcLangExt defLang)
Definition util.cpp:5724

References OutputList::codeGenerators(), Config_getBool, Define, OutputList::endBold(), FALSE, DefinitionMixin< MemberDefMutable >::getDefFileExtension(), getFileDef(), getLanguageFromFileName(), m_initializer, m_mtype, Doxygen::parserManager, OutputList::parseText(), OutputList::startBold(), OutputCodeList::startCodeFragment(), theTranslator, and TRUE.

Referenced by writeDocumentation().

◆ _writeReimplementedBy()

void MemberDefImpl::_writeReimplementedBy ( OutputList & ol) const
private

Definition at line 3064 of file memberdef.cpp.

3065{
3066 const MemberVector &bml=reimplementedBy();
3067 size_t count = _countReimplementedBy();
3068 if (count>0)
3069 {
3070 auto replaceFunc = [&bml,&ol](size_t entryIndex)
3071 {
3072 size_t cnt=0;
3073 auto it = bml.begin();
3074 // find the entryIndex-th documented entry in the inheritance list.
3075 const MemberDef *bmd = nullptr;
3076 const ClassDef *bcd = nullptr;
3077 while (it!=bml.end())
3078 {
3079 bmd = *it;
3080 bcd = bmd->getClassDef();
3081 if ( bmd->isLinkable() && bcd->isLinkable())
3082 {
3083 if (cnt==entryIndex) break;
3084 cnt++;
3085 }
3086 ++it;
3087 }
3088
3089 if (bcd && bmd) // write link for marker
3090 {
3091 //ol.writeObjectLink(bcd->getReference(),bcd->getOutputFileBase(),
3092 // bmd->anchor(),bcd->name());
3094 bmd->anchor(),bcd->displayName());
3095
3096 if (bmd->isLinkableInProject() )
3097 {
3098 writePageRef(ol,bmd->getOutputFileBase(),bmd->anchor());
3099 }
3100 }
3101 };
3102
3103 QCString reimplInLine;
3104 if (m_virt==Specifier::Pure || (getClassDef() && getClassDef()->compoundType()==ClassDef::Interface))
3105 {
3106 reimplInLine = theTranslator->trImplementedInList(static_cast<int>(count));
3107 }
3108 else
3109 {
3110 reimplInLine = theTranslator->trReimplementedInList(static_cast<int>(count));
3111 }
3112
3113 // write the list of classes that overwrite this member
3114 ol.startParagraph();
3115 writeMarkerList(ol,
3116 reimplInLine.str(),
3117 count,
3118 replaceFunc);
3119 ol.endParagraph();
3120 }
3121}
@ Interface
Definition classdef.h:112
size_t _countReimplementedBy() const
iterator end() noexcept
Definition memberlist.h:56
iterator begin() noexcept
Definition memberlist.h:54
const std::string & str() const
Definition qcstring.h:537
virtual QCString trReimplementedInList(int numEntries)=0
virtual QCString trImplementedInList(int numEntries)=0
void writePageRef(OutputList &ol, const QCString &cn, const QCString &mn)
Definition util.cpp:271
void writeMarkerList(OutputList &ol, const std::string &markerText, size_t numMarkers, std::function< void(size_t)> replaceFunc)
Definition util.cpp:1104

References _countReimplementedBy(), Definition::anchor(), MemberVector::begin(), Definition::displayName(), MemberVector::end(), OutputList::endParagraph(), MemberDef::getClassDef(), getClassDef(), Definition::getOutputFileBase(), Definition::getReference(), ClassDef::Interface, Definition::isLinkable(), Definition::isLinkableInProject(), m_virt, reimplementedBy(), OutputList::startParagraph(), QCString::str(), theTranslator, writeMarkerList(), OutputList::writeObjectLink(), and writePageRef().

Referenced by writeDocumentation().

◆ _writeReimplements()

void MemberDefImpl::_writeReimplements ( OutputList & ol) const
private

Definition at line 2988 of file memberdef.cpp.

2989{
2990 const MemberDef *bmd=reimplements();
2991 const ClassDef *bcd=nullptr;
2992 if (bmd && (bcd=bmd->getClassDef()))
2993 {
2994 // write class that contains a member that is reimplemented by this one
2995 if (bcd->isLinkable())
2996 {
2997 ol.startParagraph();
2998 QCString reimplFromLine;
2999 if (bmd->virtualness()!=Specifier::Pure && bcd->compoundType()!=ClassDef::Interface)
3000 {
3001 reimplFromLine = theTranslator->trReimplementedFromList(1);
3002 }
3003 else
3004 {
3005 reimplFromLine = theTranslator->trImplementedFromList(1);
3006 }
3007 int markerPos = reimplFromLine.find("@0");
3008 if (markerPos!=-1) // should always pass this.
3009 {
3010 ol.parseText(reimplFromLine.left(markerPos)); //text left from marker
3011 if (bmd->isLinkable()) // replace marker with link
3012 {
3013 //Definition *bd=bmd->group;
3014 //if (bd==0) bd=bcd;
3016 bmd->anchor(),bcd->displayName());
3017
3018 //ol.writeObjectLink(bcd->getReference(),bcd->getOutputFileBase(),
3019 // bmd->anchor(),bcd->name());
3020 if ( bmd->isLinkableInProject() )
3021 {
3022 writePageRef(ol,bmd->getOutputFileBase(),bmd->anchor());
3023 }
3024 }
3025 else
3026 {
3028 QCString(),bcd->displayName());
3029 if (bcd->isLinkableInProject()/* && !Config_getBool(PDF_HYPERLINKS)*/ )
3030 {
3031 writePageRef(ol,bcd->getOutputFileBase(),bcd->anchor());
3032 }
3033 }
3034 ol.parseText(reimplFromLine.right(
3035 reimplFromLine.length()-markerPos-2)); // text right from marker
3036
3037 }
3038 else
3039 {
3040 err("translation error: no marker in trReimplementsFromList()\n");
3041 }
3042 ol.endParagraph();
3043 }
3044 }
3045}
virtual CompoundType compoundType() const =0
Returns the type of compound this is, i.e.
virtual Specifier virtualness(int count=0) const =0
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition qcstring.h:153
QCString right(size_t len) const
Definition qcstring.h:219
virtual QCString trReimplementedFromList(int numEntries)=0
virtual QCString trImplementedFromList(int numEntries)=0
#define err(fmt,...)
Definition message.h:127

References Definition::anchor(), ClassDef::compoundType(), Definition::displayName(), OutputList::endParagraph(), err, QCString::find(), MemberDef::getClassDef(), Definition::getOutputFileBase(), Definition::getReference(), ClassDef::Interface, Definition::isLinkable(), Definition::isLinkableInProject(), QCString::left(), QCString::length(), OutputList::parseText(), reimplements(), QCString::right(), OutputList::startParagraph(), theTranslator, MemberDef::virtualness(), OutputList::writeObjectLink(), and writePageRef().

Referenced by writeDocumentation().

◆ _writeTagData()

void MemberDefImpl::_writeTagData ( const DefType ) const
private

◆ _writeTemplatePrefix()

void MemberDefImpl::_writeTemplatePrefix ( OutputList & ol,
const Definition * def,
const ArgumentList & al,
bool writeReqClause = true ) const
private

Definition at line 2162 of file memberdef.cpp.

2164{
2165 ol.docify("template<");
2166 for (auto it = al.begin(); it!=al.end();)
2167 {
2168 Argument a = *it;
2169 linkifyText(TextGeneratorOLImpl(ol), // out
2170 def, // scope
2171 getFileDef(), // fileScope
2172 this, // self
2173 a.type, // text
2174 FALSE // autoBreak
2175 );
2176 if (!a.name.isEmpty())
2177 {
2178 ol.docify(" ");
2179 ol.docify(a.name);
2180 }
2181 if (!a.defval.isEmpty())
2182 {
2183 ol.docify(" = ");
2184 ol.docify(a.defval);
2185 }
2186 ++it;
2187 if (it!=al.end()) ol.docify(", ");
2188 }
2189 ol.docify("> ");
2190 if (writeReqClause && !m_requiresClause.isEmpty())
2191 {
2192 ol.lineBreak();
2193 ol.docify("requires ");
2194 linkifyText(TextGeneratorOLImpl(ol), // out
2195 def, // scope
2196 getFileDef(), // fileScope
2197 this, // self
2198 m_requiresClause, // text
2199 FALSE // autoBreak
2200 );
2201 }
2202}
iterator end()
Definition arguments.h:94
iterator begin()
Definition arguments.h:93
QCString m_requiresClause
void lineBreak(const QCString &style=QCString())
Definition outputlist.h:561
QCString type
Definition arguments.h:42
QCString name
Definition arguments.h:44
QCString defval
Definition arguments.h:46
void linkifyText(const TextGeneratorIntf &out, const Definition *scope, const FileDef *fileScope, const Definition *self, const QCString &text, bool autoBreak, bool external, bool keepSpaces, int indentLevel)
Definition util.cpp:905

References ArgumentList::begin(), Argument::defval, OutputList::docify(), ArgumentList::end(), FALSE, getFileDef(), QCString::isEmpty(), OutputList::lineBreak(), linkifyText(), m_requiresClause, Argument::name, and Argument::type.

Referenced by writeDeclaration(), and writeDocumentation().

◆ _writeTypeConstraints()

void MemberDefImpl::_writeTypeConstraints ( OutputList & ol) const
private

Definition at line 3189 of file memberdef.cpp.

3190{
3191 if (m_typeConstraints.hasParameters())
3192 {
3194 }
3195}
ArgumentList m_typeConstraints
void writeTypeConstraints(OutputList &ol, const Definition *d, const ArgumentList &al)
Definition util.cpp:5967

References m_typeConstraints, and writeTypeConstraints().

Referenced by writeDocumentation().

◆ accessorClass()

ClassDef * MemberDefImpl::accessorClass ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4920 of file memberdef.cpp.

4921{
4922 return m_accessorClass;
4923}
ClassDef * m_accessorClass

References m_accessorClass.

◆ addExample()

bool MemberDefImpl::addExample ( const QCString & anchor,
const QCString & name,
const QCString & file )
overridevirtual

Implements MemberDefMutable.

Definition at line 1625 of file memberdef.cpp.

1626{
1627 //printf("%s::addExample(%s,%s,%s)\n",qPrint(name()),anchor,nameStr,file);
1628 return m_examples.inSort(Example(anchor,nameStr,file));
1629}
QCString anchor() const override

References anchor(), and m_examples.

◆ addListReference()

void MemberDefImpl::addListReference ( Definition * d)
overridevirtual

Implements MemberDefMutable.

Definition at line 4511 of file memberdef.cpp.

4512{
4513 bool optimizeOutputForC = Config_getBool(OPTIMIZE_OUTPUT_FOR_C);
4514 //bool hideScopeNames = Config_getBool(HIDE_SCOPE_NAMES);
4515 //bool optimizeOutputJava = Config_getBool(OPTIMIZE_OUTPUT_JAVA);
4516 //bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
4517 SrcLangExt lang = getLanguage();
4518 if (!isLinkableInProject()) return;
4519 QCString memLabel;
4520 if (optimizeOutputForC)
4521 {
4522 memLabel=theTranslator->trGlobal(TRUE,TRUE);
4523 }
4524 else if (lang==SrcLangExt::Fortran)
4525 {
4527 }
4528 else
4529 {
4530 memLabel=theTranslator->trMember(TRUE,TRUE);
4531 }
4532 QCString memName = name();
4533 Definition *pd=getOuterScope();
4534 QCString pdName = pd->definitionType()==Definition::TypeClass ?
4535 (toClassDef(pd))->displayName() : pd->name();
4536 QCString sep = getLanguageSpecificSeparator(lang,TRUE);
4537 QCString memArgs;
4538 if (!isRelated()
4539 /* && commented out as a result of bug 597016
4540 (
4541 (!hideScopeNames && // there is a scope
4542 pd && pd!=Doxygen::globalScope) // and we can show it
4543 ||
4544 (pd=getClassDef()) // it's a class so we
4545 // show the scope anyway
4546 )
4547 */
4548 )
4549 {
4550 if (isObjCMethod())
4551 {
4552 memName = "[" + pd->name() + " " + name() + "]";
4553 }
4554 else
4555 {
4556 if (pd!=Doxygen::globalScope) memName.prepend(pdName+sep);
4557 memArgs = argsString();
4558 }
4559 }
4560 const RefItemVector &xrefItems = xrefListItems();
4561 if (sep!="::")
4562 {
4563 memName = substitute(memName,"::",sep);
4564 }
4565 addRefItem(xrefItems,
4566 qualifiedName()+argsString(), // argsString is needed for overloaded functions (see bug 609624)
4567 memLabel,
4568 getOutputFileBase()+"#"+anchor(),memName,memArgs,pd);
4569}
virtual DefType definitionType() const =0
const RefItemVector & xrefListItems() const override
static NamespaceDefMutable * globalScope
Definition doxygen.h:121
bool isObjCMethod() const override
bool isLinkableInProject() const override
QCString displayName(bool=TRUE) const override
QCString argsString() const override
bool isRelated() const override
QCString getOutputFileBase() const override
QCString & prepend(const char *s)
Definition qcstring.h:407
virtual QCString trGlobal(bool first_capital, bool singular)=0
virtual QCString trSubprogram(bool first_capital, bool singular)=0
virtual QCString trMember(bool first_capital, bool singular)=0
ClassDef * toClassDef(Definition *d)
QCString substitute(const QCString &s, const QCString &src, const QCString &dst)
substitute all occurrences of src in s by dst
Definition qcstring.cpp:477
std::vector< RefItem * > RefItemVector
Definition reflist.h:133
void addRefItem(const RefItemVector &sli, const QCString &key, const QCString &prefix, const QCString &name, const QCString &title, const QCString &args, const Definition *scope)
Definition util.cpp:5321
QCString getLanguageSpecificSeparator(SrcLangExt lang, bool classScope)
Returns the scope separator to use given the programming language lang.
Definition util.cpp:6416

References addRefItem(), anchor(), argsString(), Config_getBool, Definition::definitionType(), displayName(), DefinitionMixin< MemberDefMutable >::getLanguage(), getLanguageSpecificSeparator(), DefinitionMixin< MemberDefMutable >::getOuterScope(), getOutputFileBase(), Doxygen::globalScope, isLinkableInProject(), isObjCMethod(), isRelated(), Definition::name(), DefinitionMixin< MemberDefMutable >::name(), QCString::prepend(), qualifiedName(), substitute(), theTranslator, toClassDef(), TRUE, Definition::TypeClass, and DefinitionMixin< MemberDefMutable >::xrefListItems().

◆ addQualifiers()

void MemberDefImpl::addQualifiers ( const StringVector & qualifiers)
overridevirtual

Implements MemberDefMutable.

Definition at line 5853 of file memberdef.cpp.

5854{
5855 for (const auto &sx : qualifiers)
5856 {
5857 bool alreadyAdded = std::find(m_qualifiers.begin(), m_qualifiers.end(), sx) != m_qualifiers.end();
5858 if (!alreadyAdded)
5859 {
5860 m_qualifiers.push_back(sx);
5861 }
5862 }
5863}
StringVector m_qualifiers

References m_qualifiers.

◆ anchor()

QCString MemberDefImpl::anchor ( ) const
overridevirtual

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

Implements Definition.

Definition at line 1763 of file memberdef.cpp.

1764{
1765 QCString result=m_anc;
1766 if (m_groupAlias) return m_groupAlias->anchor();
1767 if (m_templateMaster) return m_templateMaster->anchor();
1768 if (m_enumScope && m_enumScope!=this) // avoid recursion for C#'s public enum E { E, F }
1769 {
1770 result.prepend(m_enumScope->anchor());
1771 }
1772 if (getGroupDef())
1773 {
1774 if (m_groupMember)
1775 {
1776 result=m_groupMember->anchor();
1777 }
1778 else if (getReference().isEmpty())
1779 {
1780 result.prepend("g");
1781 }
1782 }
1783 return result;
1784}
QCString m_anc
const MemberDef * m_enumScope
const MemberDef * m_groupAlias
const MemberDef * m_templateMaster
QCString getReference() const override
MemberDef * m_groupMember

References getGroupDef(), getReference(), m_anc, m_enumScope, m_groupAlias, m_groupMember, m_templateMaster, and QCString::prepend().

Referenced by addExample(), addListReference(), getOutputFileBase(), writeDeclaration(), writeDocumentation(), writeLink(), writeMemberDocSimple(), and writeTagFile().

◆ argsString()

QCString MemberDefImpl::argsString ( ) const
overridevirtual

◆ argumentList()

const ArgumentList & MemberDefImpl::argumentList ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5595 of file memberdef.cpp.

5596{
5597 return m_defArgList;
5598}
ArgumentList m_defArgList

References m_defArgList.

Referenced by detectUndocumentedParams(), and warnIfUndocumentedParams().

◆ bitfieldString()

QCString MemberDefImpl::bitfieldString ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5066 of file memberdef.cpp.

5067{
5068 return m_bitfields;
5069}

References m_bitfields.

◆ briefDescription()

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

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

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 6304 of file memberdef.cpp.

6305{
6306 if (m_templateMaster)
6307 {
6308 return m_templateMaster->briefDescription(abbr);
6309 }
6310 else
6311 {
6313 }
6314}
QCString briefDescription(bool abbreviate=FALSE) const override

References DefinitionMixin< Base >::briefDescription(), and m_templateMaster.

Referenced by findSectionsInDocumentation(), hasDetailedDescription(), writeDeclaration(), writeDocumentation(), and writeMemberDocSimple().

◆ cacheTypedefVal()

void MemberDefImpl::cacheTypedefVal ( const ClassDef * val,
const QCString & templSpec,
const QCString & resolvedType )
overridevirtual

Implements MemberDefMutable.

Definition at line 6071 of file memberdef.cpp.

6072{
6075 m_cachedTypedefTemplSpec=templSpec;
6076 m_cachedResolvedType=resolvedType;
6077 //printf("MemberDefImpl::cacheTypedefVal=%s m_impl=%p\n",qPrint(m_cachedResolvedType),m_impl);
6078}
bool m_isTypedefValCached
const ClassDef * m_cachedTypedefValue
QCString m_cachedTypedefTemplSpec
QCString m_cachedResolvedType

References m_cachedResolvedType, m_cachedTypedefTemplSpec, m_cachedTypedefValue, m_isTypedefValCached, and TRUE.

◆ category()

ClassDef * MemberDefImpl::category ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6031 of file memberdef.cpp.

6032{
6033 return m_category;
6034}

References m_category.

◆ categoryRelation()

const MemberDef * MemberDefImpl::categoryRelation ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6041 of file memberdef.cpp.

6042{
6043 return m_categoryRelation;
6044}

References m_categoryRelation.

◆ codeSymbolType()

CodeSymbolType MemberDefImpl::codeSymbolType ( ) const
overridevirtual

Used for syntax highlighting symbol class

Implements Definition.

Definition at line 6384 of file memberdef.cpp.

6385{
6386 switch (memberType())
6387 {
6404 }
6406}
MemberType memberType() const override
@ Enumeration
Definition types.h:557
@ EnumValue
Definition types.h:558
@ Dictionary
Definition types.h:568
@ Interface
Definition types.h:565
@ Sequence
Definition types.h:567
@ Variable
Definition types.h:555
@ Property
Definition types.h:563
@ Typedef
Definition types.h:556
@ Function
Definition types.h:554
@ Service
Definition types.h:566

References DCOP, Default, Define, Dictionary, Enumeration, EnumValue, Event, Friend, Function, Interface, memberType(), Property, Sequence, Service, Signal, Slot, Typedef, and Variable.

◆ copyArgumentNames()

void MemberDefImpl::copyArgumentNames ( const MemberDef * bmd)
overridevirtual

Implements MemberDefMutable.

Definition at line 6080 of file memberdef.cpp.

6081{
6082 {
6083 const ArgumentList &srcAl = bmd->argumentList();
6084 ArgumentList &dstAl = m_defArgList;
6085 auto srcIt = srcAl.begin();
6086 auto dstIt = dstAl.begin();
6087 while ( srcIt!=srcAl.end() && dstIt!=dstAl.end())
6088 {
6089 Argument &argDst = *dstIt;
6090 const Argument &argSrc = *srcIt;
6091 argDst.name = argSrc.name;
6092 argDst.docs = argSrc.docs;
6093 ++srcIt;
6094 ++dstIt;
6095 }
6096 }
6097
6098 {
6099 const ArgumentList &srcAl = bmd->declArgumentList();
6100 ArgumentList &dstAl = m_declArgList;
6101 auto srcIt = srcAl.begin();
6102 auto dstIt = dstAl.begin();
6103
6104 while ( srcIt!=srcAl.end() && dstIt!=dstAl.end())
6105 {
6106 Argument &argDst = *dstIt;
6107 const Argument &argSrc = *srcIt;
6108 argDst.name = argSrc.name;
6109 argDst.docs = argSrc.docs;
6110 ++srcIt;
6111 ++dstIt;
6112 }
6113 }
6114}
virtual const ArgumentList & argumentList() const =0
virtual const ArgumentList & declArgumentList() const =0
ArgumentList m_declArgList
QCString docs
Definition arguments.h:47

References MemberDef::argumentList(), ArgumentList::begin(), MemberDef::declArgumentList(), Argument::docs, ArgumentList::end(), m_declArgList, m_defArgList, and Argument::name.

◆ createTemplateInstanceMember()

std::unique_ptr< MemberDef > MemberDefImpl::createTemplateInstanceMember ( const ArgumentList & formalArgs,
const std::unique_ptr< ArgumentList > & actualArgs ) const
overridevirtual

Implements MemberDef.

Definition at line 4435 of file memberdef.cpp.

4437{
4438 //printf(" Member %s %s %s\n",qPrint(typeString()),qPrint(name()),qPrint(argsString()));
4439 std::unique_ptr<ArgumentList> actualArgList = std::make_unique<ArgumentList>(m_defArgList);
4440 if (!m_defArgList.empty())
4441 {
4442 // replace formal arguments with actuals
4443 for (Argument &arg : *actualArgList)
4444 {
4445 arg.type = substituteTemplateArgumentsInString(arg.type,formalArgs,actualArgs.get());
4446 }
4447 actualArgList->setTrailingReturnType(
4448 substituteTemplateArgumentsInString(actualArgList->trailingReturnType(),formalArgs,actualArgs.get()));
4449 }
4450
4451 QCString methodName=name();
4452 if (methodName.startsWith("operator ")) // conversion operator
4453 {
4454 methodName=substituteTemplateArgumentsInString(methodName,formalArgs,actualArgs.get());
4455 }
4456
4457 auto imd = createMemberDef(
4459 substituteTemplateArgumentsInString(m_type,formalArgs,actualArgs.get()),
4460 methodName,
4461 substituteTemplateArgumentsInString(m_args,formalArgs,actualArgs.get()),
4464 ArgumentList(), ArgumentList(), ""
4465 );
4466 auto mmd = toMemberDefMutable(imd.get());
4467 mmd->moveArgumentList(std::move(actualArgList));
4468 mmd->setDefinition(substituteTemplateArgumentsInString(m_def,formalArgs,actualArgs.get()));
4469 mmd->setBodyDef(getBodyDef());
4470 mmd->setBodySegment(getDefLine(),getStartBodyLine(),getEndBodyLine());
4471 mmd->setFormalTemplateArguments(formalArgs);
4472
4473 // TODO: init other member variables (if needed).
4474 // TODO: reimplemented info
4475 return imd;
4476}
QCString getDefFileName() const override
const FileDef * getBodyDef() const override
QCString m_type
Relationship m_related
QCString m_def
QCString m_exception
MemberDefMutable * toMemberDefMutable(Definition *d)
std::unique_ptr< MemberDef > createMemberDef(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)
Factory method to create a new instance of a MemberDef.
QCString substituteTemplateArgumentsInString(const QCString &nm, const ArgumentList &formalArgs, const ArgumentList *actualArgs)
Definition util.cpp:4870

References createMemberDef(), DefinitionMixin< MemberDefMutable >::getBodyDef(), DefinitionMixin< MemberDefMutable >::getDefColumn(), DefinitionMixin< MemberDefMutable >::getDefFileName(), DefinitionMixin< MemberDefMutable >::getDefLine(), DefinitionMixin< MemberDefMutable >::getEndBodyLine(), DefinitionMixin< MemberDefMutable >::getStartBodyLine(), m_args, m_def, m_defArgList, m_exception, m_mtype, m_prot, m_related, m_stat, m_type, m_virt, DefinitionMixin< MemberDefMutable >::name(), QCString::startsWith(), substituteTemplateArgumentsInString(), and toMemberDefMutable().

◆ declaration()

QCString MemberDefImpl::declaration ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5036 of file memberdef.cpp.

5037{
5038 return m_decl;
5039}
QCString m_decl

References m_decl.

◆ declArgumentList()

const ArgumentList & MemberDefImpl::declArgumentList ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5600 of file memberdef.cpp.

5601{
5602 return m_declArgList;
5603}

References m_declArgList.

Referenced by detectUndocumentedParams(), and warnIfUndocumentedParams().

◆ deepCopy()

std::unique_ptr< MemberDef > MemberDefImpl::deepCopy ( ) const
overridevirtual

Implements MemberDef.

Definition at line 1446 of file memberdef.cpp.

1447{
1448 std::unique_ptr<MemberDefImpl> result(new MemberDefImpl(
1451 // first copy base members
1452 result->DefinitionMixin<MemberDefMutable>::operator=(*this);
1453 // then copy other members
1454 result->m_typeConstraints = m_typeConstraints ;
1455 result->m_declArgList = m_declArgList ;
1456 result->m_classDef = m_classDef ;
1457 result->m_fileDef = m_fileDef ;
1458 result->m_moduleDef = m_moduleDef ;
1459 result->m_nspace = m_nspace ;
1460 result->m_enumScope = m_enumScope ;
1461 result->m_livesInsideEnum = m_livesInsideEnum ;
1462 result->m_annEnumType = m_annEnumType ;
1463 result->m_enumFields = m_enumFields ;
1464 result->m_redefines = m_redefines ;
1465 result->m_redefinedBy = m_redefinedBy ;
1466 result->m_memDef = m_memDef ;
1467 result->m_memDec = m_memDec ;
1468 result->m_relatedAlso = m_relatedAlso ;
1469 result->m_examples = m_examples ;
1470 result->m_accessorType = m_accessorType ;
1471 result->m_accessorClass = m_accessorClass ;
1472 result->m_def = m_def ;
1473 result->m_anc = m_anc ;
1474 result->m_decl = m_decl ;
1475 result->m_bitfields = m_bitfields ;
1476 result->m_read = m_read ;
1477 result->m_write = m_write ;
1478 result->m_exception = m_exception ;
1479 result->m_initializer = m_initializer ;
1480 result->m_extraTypeChars = m_extraTypeChars ;
1481 result->m_enumBaseType = m_enumBaseType ;
1482 result->m_requiresClause = m_requiresClause ;
1483 result->m_initLines = m_initLines ;
1484 result->m_memSpec = m_memSpec ;
1485 result->m_vhdlSpec = m_vhdlSpec ;
1486 result->m_maxInitLines = m_maxInitLines ;
1487 result->m_userInitLines = m_userInitLines ;
1488 result->m_annMemb = m_annMemb ;
1489 result->m_defArgList = m_defArgList ;
1490 result->m_declArgList = m_declArgList ;
1491 result->m_tArgList = m_tArgList ;
1492 result->m_typeConstraints = m_typeConstraints ;
1493 result->m_templateMaster = m_templateMaster ;
1494 result->m_formalTemplateArguments = m_formalTemplateArguments ;
1495 result->m_defTmpArgLists = m_defTmpArgLists ;
1496 result->m_cachedAnonymousType = m_cachedAnonymousType ;
1497 result->m_sectionMap = m_sectionMap ;
1498 result->m_groupAlias = m_groupAlias ;
1499 result->m_grpId = m_grpId ;
1500 result->m_memberGroup = m_memberGroup ;
1501 result->m_group = m_group ;
1502 result->m_grouppri = m_grouppri ;
1503 result->m_groupFileName = m_groupFileName ;
1504 result->m_groupStartLine = m_groupStartLine ;
1505 result->m_groupMember = m_groupMember ;
1506 result->m_isTypedefValCached = m_isTypedefValCached ;
1507 result->m_cachedTypedefValue = m_cachedTypedefValue ;
1508 result->m_cachedTypedefTemplSpec = m_cachedTypedefTemplSpec ;
1509 result->m_cachedResolvedType = m_cachedResolvedType ;
1510 result->m_docProvider = m_docProvider ;
1511 result->m_explicitOutputFileBase = m_explicitOutputFileBase ;
1512 result->m_qualifiers = m_qualifiers ;
1513 result->m_implOnly = m_implOnly ;
1514 result->m_hasDocumentedParams = m_hasDocumentedParams ;
1515 result->m_hasDocumentedReturnType = m_hasDocumentedReturnType ;
1516 result->m_isDMember = m_isDMember ;
1517 result->m_proto = m_proto ;
1518 result->m_docEnumValues = m_docEnumValues ;
1519 result->m_annScope = m_annScope ;
1520 result->m_hasDetailedDescriptionCached = m_hasDetailedDescriptionCached ;
1521 result->m_detailedDescriptionCachedValue = m_detailedDescriptionCachedValue ;
1522 result->m_hasCallGraph = m_hasCallGraph ;
1523 result->m_hasCallerGraph = m_hasCallerGraph ;
1524 result->m_hasReferencedByRelation = m_hasReferencedByRelation ;
1525 result->m_hasReferencesRelation = m_hasReferencesRelation ;
1526 result->m_hasEnumValues = m_hasEnumValues ;
1527 result->m_hasInlineSource = m_hasInlineSource ;
1528 result->m_explExt = m_explExt ;
1529 result->m_tspec = m_tspec ;
1530 result->m_groupHasDocs = m_groupHasDocs ;
1531 result->m_docsForDefinition = m_docsForDefinition ;
1532 result->m_category = m_category ;
1533 result->m_categoryRelation = m_categoryRelation ;
1534 result->m_declFileName = m_declFileName ;
1535 result->m_declLine = m_declLine ;
1536 result->m_declColumn = m_declColumn ;
1537 result->m_numberOfFlowKW = m_numberOfFlowKW ;
1538 result->setDefinitionTemplateParameterLists(m_defTmpArgLists);
1539
1540 result->m_isLinkableCached = 0;
1541 result->m_isConstructorCached = 0;
1542 result->m_isDestructorCached = 0;
1543 return result;
1544}
const QCString & localName() const override
VhdlSpecifier m_vhdlSpec
bool m_detailedDescriptionCachedValue
ArgumentLists m_defTmpArgLists
bool m_hasReferencedByRelation
MemberDef * m_memDec
MemberDef * m_annMemb
std::map< const Definition *, const MemberList * > m_sectionMap
bool m_hasDocumentedReturnType
QCString m_extraTypeChars
bool m_hasDocumentedParams
ModuleDef * m_moduleDef
bool m_hasReferencesRelation
bool m_hasInlineSource
QCString m_groupFileName
NamespaceDef * m_nspace
bool m_docsForDefinition
std::optional< ArgumentList > m_formalTemplateArguments
QCString m_read
MemberDef * m_redefines
QCString m_accessorType
ClassDef * m_classDef
MemberGroup * m_memberGroup
MemberVector m_redefinedBy
GroupDef * m_group
QCString m_metaData
TypeSpecifier m_memSpec
bool m_hasDetailedDescriptionCached
ClassDef * m_relatedAlso
const MemberDef * m_annEnumType
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)
QCString m_enumBaseType
Grouping::GroupPri_t m_grouppri
MemberDef * m_memDef
bool m_livesInsideEnum
MemberVector m_enumFields
ClassDef * m_cachedAnonymousType
QCString m_write
FileDef * m_fileDef
QCString m_declFileName
ArgumentList m_tArgList
QCString m_explicitOutputFileBase
const MemberDef * m_docProvider

References DefinitionMixin< MemberDefMutable >::getDefColumn(), DefinitionMixin< MemberDefMutable >::getDefFileName(), DefinitionMixin< MemberDefMutable >::getDefLine(), DefinitionMixin< MemberDefMutable >::localName(), m_accessorClass, m_accessorType, m_anc, m_annEnumType, m_annMemb, m_annScope, m_args, m_bitfields, m_cachedAnonymousType, m_cachedResolvedType, m_cachedTypedefTemplSpec, m_cachedTypedefValue, m_category, m_categoryRelation, m_classDef, m_decl, m_declArgList, m_declColumn, m_declFileName, m_declLine, m_def, m_defArgList, m_defTmpArgLists, m_detailedDescriptionCachedValue, m_docEnumValues, m_docProvider, m_docsForDefinition, m_enumBaseType, m_enumFields, m_enumScope, m_examples, m_exception, m_explExt, m_explicitOutputFileBase, m_extraTypeChars, m_fileDef, m_formalTemplateArguments, m_group, m_groupAlias, m_groupFileName, m_groupHasDocs, m_groupMember, m_grouppri, m_groupStartLine, m_grpId, m_hasCallerGraph, m_hasCallGraph, m_hasDetailedDescriptionCached, m_hasDocumentedParams, m_hasDocumentedReturnType, m_hasEnumValues, m_hasInlineSource, m_hasReferencedByRelation, m_hasReferencesRelation, m_implOnly, m_initializer, m_initLines, m_isDMember, m_isTypedefValCached, m_livesInsideEnum, m_maxInitLines, m_memberGroup, m_memDec, m_memDef, m_memSpec, m_metaData, m_moduleDef, m_mtype, m_nspace, m_numberOfFlowKW, m_prot, m_proto, m_qualifiers, m_read, m_redefinedBy, m_redefines, m_related, m_relatedAlso, m_requiresClause, m_sectionMap, m_stat, m_tArgList, m_templateMaster, m_tspec, m_type, m_typeConstraints, m_userInitLines, m_vhdlSpec, m_virt, m_write, and MemberDefImpl().

◆ definition()

QCString MemberDefImpl::definition ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5041 of file memberdef.cpp.

5042{
5043 return m_def;
5044}

References m_def.

Referenced by displayDefinition(), setAnchor(), and writeDocumentation().

◆ definitionTemplateParameterLists()

const ArgumentLists & MemberDefImpl::definitionTemplateParameterLists ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5658 of file memberdef.cpp.

5659{
5660 return m_defTmpArgLists;
5661}

References m_defTmpArgLists.

◆ definitionType()

DefType MemberDefImpl::definitionType ( ) const
inlineoverridevirtual

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

Implements Definition.

Definition at line 64 of file memberdef.cpp.

64{ return TypeMember; }

References definitionType(), and Definition::TypeMember.

Referenced by definitionType().

◆ detectUndocumentedParams()

void MemberDefImpl::detectUndocumentedParams ( bool hasParamCommand,
bool hasReturnCommand ) const
overridevirtual

Implements MemberDef.

Definition at line 4191 of file memberdef.cpp.

4192{
4193 //printf("%s:detectUndocumentedParams(%d,%d)\n",qPrint(name()),hasParamCommand,hasReturnCommand);
4194 bool isPython = getLanguage()==SrcLangExt::Python;
4195
4196 // this function is called while parsing the documentation. A member can have multiple
4197 // documentation blocks, which could be handled by multiple threads, hence this guard.
4198 std::lock_guard<std::mutex> lock(g_detectUndocumentedParamsMutex);
4199
4200 if (!m_hasDocumentedParams && hasParamCommand)
4201 {
4202 //printf("%s:hasDocumentedParams=TRUE;\n",qPrint(name()));
4203 m_hasDocumentedParams = true;
4204 }
4205 else if (!m_hasDocumentedParams)
4206 {
4207 const ArgumentList &al = argumentList();
4208 const ArgumentList &declAl = declArgumentList();
4209 bool allDoc=TRUE; // no parameter => all parameters are documented
4210 if ( // member has parameters
4211 al.hasParameters() // with at least one parameter (that is not void)
4212 )
4213 {
4214 // see if all parameters have documentation
4215 for (auto it = al.begin(); it!=al.end() && allDoc; ++it)
4216 {
4217 const Argument &a = *it;
4218 if (!a.name.isEmpty() && a.type!="void" && a.name!="..." &&
4219 !(isPython && (a.name=="self" || a.name=="cls"))
4220 )
4221 {
4222 allDoc = !a.docs.isEmpty();
4223 }
4224 //printf("a.type=%s a.name=%s doc=%s\n",
4225 // qPrint(a.type),qPrint(a.name),qPrint(a.docs));
4226 }
4227 if (!allDoc && declAl.empty()) // try declaration arguments as well
4228 {
4229 allDoc=true;
4230 for (auto it = al.begin(); it!=al.end() && allDoc; ++it)
4231 {
4232 const Argument &a = *it;
4233 if (!a.name.isEmpty() && a.type!="void" && a.name!="..." &&
4234 !(isPython && (a.name=="self" || a.name=="cls"))
4235 )
4236 {
4237 allDoc = !a.docs.isEmpty();
4238 }
4239 //printf("a.name=%s doc=%s\n",qPrint(a.name),qPrint(a.docs));
4240 }
4241 }
4242 }
4243 if (allDoc)
4244 {
4245 //printf("%s:hasDocumentedParams=TRUE;\n",qPrint(name()));
4246 m_hasDocumentedParams = true;
4247 }
4248 }
4249
4250 //printf("Member %s hasDocumentedReturnType=%d hasReturnCommand=%d\n",
4251 // qPrint(name()),m_hasDocumentedReturnType,hasReturnCommand);
4253}
bool hasParameters() const
Definition arguments.h:76
bool empty() const
Definition arguments.h:99
const ArgumentList & argumentList() const override
const ArgumentList & declArgumentList() const override
static std::mutex g_detectUndocumentedParamsMutex

References argumentList(), ArgumentList::begin(), declArgumentList(), Argument::docs, ArgumentList::empty(), ArgumentList::end(), g_detectUndocumentedParamsMutex, DefinitionMixin< MemberDefMutable >::getLanguage(), ArgumentList::hasParameters(), QCString::isEmpty(), m_hasDocumentedParams, m_hasDocumentedReturnType, Argument::name, TRUE, and Argument::type.

◆ displayDefinition()

QCString MemberDefImpl::displayDefinition ( ) const
overridevirtual

Implements MemberDef.

Definition at line 3295 of file memberdef.cpp.

3296{
3297 QCString ldef = definition();
3298 QCString title = name();
3299 if (isEnumerate())
3300 {
3301 if (isAnonymous())
3302 {
3303 ldef = title = "anonymous enum";
3304 if (!m_enumBaseType.isEmpty())
3305 {
3306 ldef+=" : "+m_enumBaseType;
3307 }
3308 }
3309 else
3310 {
3311 ldef.prepend("enum ");
3312 if (isSliceLocal())
3313 {
3314 ldef.prepend("local ");
3315 }
3316 }
3317 }
3318 else if (isEnumValue())
3319 {
3320 if (isAnonymous())
3321 {
3322 ldef=ldef.mid(2);
3323 }
3324 }
3325
3326 std::string sdef = ldef.str();
3327 reg::Match match;
3328 if (reg::search(sdef,match,reAnonymous))
3329 {
3330 ldef = match.prefix().str() + " { ... } " + removeAnonymousScopes(match.suffix().str());
3331 }
3332
3333 const ClassDef *cd=getClassDef();
3334 if (cd && cd->isObjectiveC())
3335 {
3336 // strip scope name
3337 int ep = ldef.find("::");
3338 if (ep!=-1)
3339 {
3340 int sp=ldef.findRev(' ',ep);
3341 if (sp!=-1)
3342 {
3343 ldef=ldef.left(sp+1)+ldef.mid(ep+2);
3344 }
3345 }
3346 // strip keywords
3347 int dp = ldef.find(':');
3348 if (dp!=-1)
3349 {
3350 ldef=ldef.left(dp+1);
3351 }
3352 int l=static_cast<int>(ldef.length());
3353 //printf("start >%s<\n",qPrint(ldef));
3354 int i=l-1;
3355 while (i>=0 && (isId(ldef.at(i)) || ldef.at(i)==':')) i--;
3356 while (i>=0 && isspace(static_cast<uint8_t>(ldef.at(i)))) i--;
3357 if (i>0)
3358 {
3359 // insert branches around the type
3360 ldef = "("+ldef.left(i+1)+")"+ldef.mid(i+1);
3361 }
3362 //printf("end >%s< i=%d\n",qPrint(ldef),i);
3363 if (isStatic()) ldef.prepend("+ "); else ldef.prepend("- ");
3364 }
3365 SrcLangExt lang = getLanguage();
3366 QCString sep = getLanguageSpecificSeparator(lang,TRUE);
3367 return substitute(ldef,"::",sep);
3368}
virtual bool isObjectiveC() const =0
Returns TRUE if this class is implemented in Objective-C.
bool isSliceLocal() const override
bool isEnumValue() const override
QCString definition() const override
bool isStatic() const override
char & at(size_t i)
Returns a reference to the character at index i.
Definition qcstring.h:578
int findRev(char c, int index=-1, bool cs=TRUE) const
Definition qcstring.cpp:91
static const reg::Ex reAnonymous(R"([\w:@]*@\d+)")
bool search(std::string_view str, Match &match, const Ex &re, size_t pos)
Search in a given string str starting at position pos for a match against regular expression re.
Definition regex.cpp:748
bool match(std::string_view str, Match &match, const Ex &re)
Matches a given string str for a match against regular expression re.
Definition regex.cpp:759
QCString removeAnonymousScopes(const QCString &str)
Definition util.cpp:173
bool isId(int c)
Definition util.h:208

References QCString::at(), definition(), QCString::find(), QCString::findRev(), getClassDef(), DefinitionMixin< MemberDefMutable >::getLanguage(), getLanguageSpecificSeparator(), DefinitionMixin< MemberDefMutable >::isAnonymous(), isEnumerate(), isEnumValue(), isId(), ClassDef::isObjectiveC(), isSliceLocal(), isStatic(), QCString::left(), QCString::length(), m_enumBaseType, QCString::mid(), DefinitionMixin< MemberDefMutable >::name(), QCString::prepend(), reAnonymous, removeAnonymousScopes(), reg::search(), QCString::str(), substitute(), and TRUE.

◆ displayName()

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

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

Implements Definition.

Definition at line 6142 of file memberdef.cpp.

6143{
6144 return DefinitionMixin::name();
6145}

References DefinitionMixin< Base >::name().

Referenced by addListReference().

◆ documentation()

QCString MemberDefImpl::documentation ( ) const
overridevirtual

Returns the detailed description of this definition

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 6316 of file memberdef.cpp.

6317{
6318 if (m_templateMaster)
6319 {
6320 return m_templateMaster->documentation();
6321 }
6322 else
6323 {
6325 }
6326}
QCString documentation() const override

References DefinitionMixin< Base >::documentation(), and m_templateMaster.

Referenced by findSectionsInDocumentation(), hasDetailedDescription(), isBriefSectionVisible(), writeDocumentation(), and writeMemberDocSimple().

◆ enumBaseType()

QCString MemberDefImpl::enumBaseType ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6056 of file memberdef.cpp.

6057{
6058 return m_enumBaseType;
6059}

References m_enumBaseType.

◆ enumFieldList()

const MemberVector & MemberDefImpl::enumFieldList ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5580 of file memberdef.cpp.

5581{
5582 return m_enumFields;
5583}

References m_enumFields.

Referenced by _writeEnumValues(), and warnIfUndocumented().

◆ excpString()

QCString MemberDefImpl::excpString ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5061 of file memberdef.cpp.

5062{
5063 return m_exception;
5064}

References m_exception.

Referenced by writeDeclaration(), and writeDocumentation().

◆ extraTypeChars()

QCString MemberDefImpl::extraTypeChars ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5046 of file memberdef.cpp.

5047{
5048 return m_extraTypeChars;
5049}

References m_extraTypeChars.

◆ fieldType()

QCString MemberDefImpl::fieldType ( ) const
overridevirtual

Implements MemberDef.

Definition at line 3945 of file memberdef.cpp.

3946{
3947 QCString type = m_accessorType;
3948 if (type.isEmpty())
3949 {
3950 type = m_type;
3951 }
3952
3953 if (isTypedef() && getLanguage() != SrcLangExt::Slice) type.prepend("typedef ");
3954 return simplifyTypeForTable(type);
3955}
bool isTypedef() const override
static QCString simplifyTypeForTable(const QCString &s)

References DefinitionMixin< MemberDefMutable >::getLanguage(), QCString::isEmpty(), isTypedef(), m_accessorType, m_type, QCString::prepend(), and simplifyTypeForTable().

Referenced by writeMemberDocSimple().

◆ findSectionsInDocumentation()

void MemberDefImpl::findSectionsInDocumentation ( )
overridevirtual

Implements MemberDefMutable.

Definition at line 4925 of file memberdef.cpp.

4926{
4930}
QCString docFile() const override
QCString inbodyDocumentation() const override
QCString briefDescription(bool abbr=FALSE) const override
QCString documentation() const override
void docFindSections(const QCString &input, const Definition *d, const QCString &fileName)

References briefDescription(), DefinitionMixin< MemberDefMutable >::docFile(), docFindSections(), documentation(), and DefinitionMixin< MemberDefMutable >::inbodyDocumentation().

◆ formalTemplateArguments()

std::optional< ArgumentList > MemberDefImpl::formalTemplateArguments ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5739 of file memberdef.cpp.

5740{
5742}

References m_formalTemplateArguments.

◆ fromAnonymousMember()

MemberDef * MemberDefImpl::fromAnonymousMember ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5990 of file memberdef.cpp.

5991{
5992 return m_annMemb;
5993}

References m_annMemb.

◆ fromAnonymousScope()

bool MemberDefImpl::fromAnonymousScope ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5673 of file memberdef.cpp.

5674{
5675 return m_annScope;
5676}

References m_annScope.

◆ getAnonymousEnumType()

const MemberDef * MemberDefImpl::getAnonymousEnumType ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5535 of file memberdef.cpp.

5536{
5537 return m_annEnumType;
5538}

References m_annEnumType.

Referenced by writeDeclaration().

◆ getCachedResolvedTypedef()

QCString MemberDefImpl::getCachedResolvedTypedef ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5759 of file memberdef.cpp.

5760{
5761 //printf("MemberDefImpl::getCachedResolvedTypedef()=%s\n",qPrint(m_cachedResolvedType));
5762 return m_cachedResolvedType;
5763}

References m_cachedResolvedType.

◆ getCachedTypedefTemplSpec()

QCString MemberDefImpl::getCachedTypedefTemplSpec ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5754 of file memberdef.cpp.

5755{
5757}

References m_cachedTypedefTemplSpec.

◆ getCachedTypedefVal()

const ClassDef * MemberDefImpl::getCachedTypedefVal ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5749 of file memberdef.cpp.

5750{
5751 return m_cachedTypedefValue;
5752}

References m_cachedTypedefValue.

◆ getClassDef() [1/2]

◆ getClassDef() [2/2]

ClassDef * MemberDefImpl::getClassDef ( )
overridevirtual

Implements MemberDef.

Definition at line 5096 of file memberdef.cpp.

5097{
5098 return m_classDef;
5099}

References m_classDef.

◆ getClassDefMutable()

ClassDefMutable * MemberDefImpl::getClassDefMutable ( )
overridevirtual

Implements MemberDefMutable.

Definition at line 5101 of file memberdef.cpp.

5102{
5104}
ClassDefMutable * toClassDefMutable(Definition *d)

References m_classDef, and toClassDefMutable().

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

Definition at line 1977 of file memberdef.cpp.

1978{
1979 std::lock_guard<std::mutex> lock(g_cachedAnonymousTypeMutex);
1980 //printf("%s:getClassDefOfAnonymousType() cache=%s\n",qPrint(name()),
1981 // m_cachedAnonymousType?qPrint(m_cachedAnonymousType->name()):"<empty>");
1983
1984 QCString cname;
1985 if (getClassDef()!=nullptr)
1986 {
1987 cname=getClassDef()->name();
1988 }
1989 else if (getNamespaceDef()!=nullptr)
1990 {
1991 cname=getNamespaceDef()->name();
1992 }
1993 QCString ltype(m_type);
1994 // strip 'friend' keyword from ltype
1995 ltype.stripPrefix("friend ");
1996
1997 // search for the last anonymous scope in the member type
1998 ClassDef *annoClassDef=nullptr;
1999
2000 // match expression if it contains at least one @1 marker, e.g.
2001 // 'struct A::@1::@2::B' matches 'A::@1::@2::B' but 'struct A::B' does not match.
2002 std::string stype = ltype.str();
2003 static const reg::Ex r(R"([\w@:]*@\d+[\w@:]*)");
2004 reg::Match match;
2005 if (reg::search(stype,match,r)) // found anonymous scope in type
2006 {
2007 QCString annName = match.str();
2008
2009 // if inside a class or namespace try to prepend the scope name
2010 if (!cname.isEmpty() && annName.left(cname.length()+2)!=cname+"::")
2011 {
2012 QCString ts=stripAnonymousNamespaceScope(cname+"::"+annName);
2013 annoClassDef=getClass(ts);
2014 }
2015 // if not found yet, try without scope name
2016 if (annoClassDef==nullptr)
2017 {
2018 QCString ts=stripAnonymousNamespaceScope(annName);
2019 annoClassDef=getClass(ts);
2020 }
2021 }
2022 m_cachedAnonymousType = annoClassDef;
2023 return annoClassDef;
2024}
ClassDef * getClass(const QCString &n)
static std::mutex g_cachedAnonymousTypeMutex
QCString stripAnonymousNamespaceScope(const QCString &s)
Definition util.cpp:242

References g_cachedAnonymousTypeMutex, getClass(), getClassDef(), getNamespaceDef(), QCString::isEmpty(), QCString::left(), QCString::length(), m_cachedAnonymousType, m_type, Definition::name(), reg::search(), QCString::str(), stripAnonymousNamespaceScope(), and QCString::stripPrefix().

Referenced by writeDeclaration(), and writeDocumentation().

◆ getDeclColumn()

int MemberDefImpl::getDeclColumn ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5795 of file memberdef.cpp.

5796{
5797 return m_declColumn;
5798}

References m_declColumn.

◆ getDeclFileName()

QCString MemberDefImpl::getDeclFileName ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5785 of file memberdef.cpp.

5786{
5787 return m_declFileName;
5788}

References m_declFileName.

◆ getDeclLine()

int MemberDefImpl::getDeclLine ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5790 of file memberdef.cpp.

5791{
5792 return m_declLine;
5793}

References m_declLine.

◆ getDeclType()

QCString MemberDefImpl::getDeclType ( ) const
overridevirtual

Implements MemberDef.

Definition at line 2122 of file memberdef.cpp.

2123{
2124 SrcLangExt lang = getLanguage();
2125 QCString ltype(m_type);
2126 if (lang==SrcLangExt::Cpp && isEnumerate() && isStrong())
2127 {
2128 if (isEnumStruct())
2129 {
2130 ltype+=" struct";
2131 }
2132 else
2133 {
2134 ltype+=" class";
2135 }
2136 }
2137 if (isTypedef() && getLanguage() != SrcLangExt::Slice)
2138 {
2139 ltype.prepend("typedef ");
2140 }
2141 if (isTypeAlias())
2142 {
2143 ltype="using";
2144 }
2145 // strip 'friend' keyword from ltype
2146 ltype.stripPrefix("friend ");
2147 if (ltype=="@") // rename type from enum values
2148 {
2149 ltype="";
2150 }
2151 else
2152 {
2153 if (isObjCMethod())
2154 {
2155 ltype.prepend("(");
2156 ltype.append(")");
2157 }
2158 }
2159 return ltype;
2160}
bool isStrong() const override
bool isTypeAlias() const override
bool isEnumStruct() const override

References QCString::append(), DefinitionMixin< MemberDefMutable >::getLanguage(), isEnumerate(), isEnumStruct(), isObjCMethod(), isStrong(), isTypeAlias(), isTypedef(), m_type, QCString::prepend(), and QCString::stripPrefix().

◆ getEnumScope()

const MemberDef * MemberDefImpl::getEnumScope ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5545 of file memberdef.cpp.

5546{
5547 return m_enumScope;
5548}

References m_enumScope.

Referenced by getOutputFileBase(), and writeLink().

◆ getExamples()

const ExampleList & MemberDefImpl::getExamples ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5585 of file memberdef.cpp.

5586{
5587 return m_examples;
5588}

References m_examples.

◆ getFileDef() [1/2]

◆ getFileDef() [2/2]

FileDef * MemberDefImpl::getFileDef ( )
overridevirtual

Implements MemberDef.

Definition at line 5111 of file memberdef.cpp.

5112{
5113 return m_fileDef;
5114}

References m_fileDef.

◆ getGroupAlias()

const MemberDef * MemberDefImpl::getGroupAlias ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5780 of file memberdef.cpp.

5781{
5782 return m_groupAlias;
5783}

References m_groupAlias.

◆ getGroupDef() [1/2]

const GroupDef * MemberDefImpl::getGroupDef ( ) const
overridevirtual

◆ getGroupDef() [2/2]

GroupDef * MemberDefImpl::getGroupDef ( )
overridevirtual

Implements MemberDef.

Definition at line 5141 of file memberdef.cpp.

5142{
5143 return m_group;
5144}

References m_group.

◆ getGroupFileName()

QCString MemberDefImpl::getGroupFileName ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5156 of file memberdef.cpp.

5157{
5158 return m_groupFileName;
5159}

References m_groupFileName.

◆ getGroupHasDocs()

bool MemberDefImpl::getGroupHasDocs ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5166 of file memberdef.cpp.

5167{
5168 return m_groupHasDocs;
5169}

References m_groupHasDocs.

◆ getGroupPri()

Grouping::GroupPri_t MemberDefImpl::getGroupPri ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5151 of file memberdef.cpp.

5152{
5153 return m_grouppri;
5154}

References m_grouppri.

◆ getGroupStartLine()

int MemberDefImpl::getGroupStartLine ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5161 of file memberdef.cpp.

5162{
5163 return m_groupStartLine;
5164}

References m_groupStartLine.

◆ getLabels()

StringVector MemberDefImpl::getLabels ( const Definition * container) const
overridevirtual

Implements MemberDef.

Definition at line 2793 of file memberdef.cpp.

2794{
2795 StringVector sl;
2796 bool inlineInfo = Config_getBool(INLINE_INFO);
2797
2798 Specifier lvirt=virtualness();
2799 if ((!isObjCMethod() || isOptional() || isRequired()) &&
2800 (protection()!=Protection::Public || lvirt!=Specifier::Normal ||
2801 isFriend() || isRelated() ||
2802 (isInline() && inlineInfo) ||
2803 isSignal() || isSlot() ||
2804 isStatic() || isExternal() ||
2805 isExported() ||
2806 (getClassDef() && getClassDef()!=container && container->definitionType()==TypeClass) ||
2807 TypeSpecifier(m_memSpec).setInline(false)!=TypeSpecifier()
2808 )
2809 )
2810 {
2811 // write the member specifier list
2812 //ol.writeLatexSpacing();
2813 //ol.startTypewriter();
2814 //ol.docify(" [");
2815 SrcLangExt lang = getLanguage();
2816 bool optVhdl = lang==SrcLangExt::VHDL;
2817 bool extractPrivate = Config_getBool(EXTRACT_PRIVATE);
2818 if (optVhdl)
2819 {
2820 sl.push_back(theTranslator->trVhdlType(getVhdlSpecifiers(),TRUE).str());
2821 }
2822 else
2823 {
2824 if (isFriend()) sl.emplace_back("friend");
2825 else if (isRelated()) sl.emplace_back("related");
2826 else
2827 {
2828 if (isExternal()) sl.emplace_back("extern");
2829 if (inlineInfo && isInline()) sl.emplace_back("inline");
2830 if (isExplicit()) sl.emplace_back("explicit");
2831 if (isMutable()) sl.emplace_back("mutable");
2832 if (isStatic()) sl.emplace_back("static");
2833 if (isGettable()) sl.emplace_back("get");
2834 if (isProtectedGettable()) sl.emplace_back("protected get");
2835 if (isSettable()) sl.emplace_back("set");
2836 if (isProtectedSettable()) sl.emplace_back("protected set");
2837 if (extractPrivate)
2838 {
2839 if (isPrivateGettable()) sl.emplace_back("private get");
2840 if (isPrivateSettable()) sl.emplace_back("private set");
2841 }
2842 if (isNoDiscard()) sl.emplace_back("nodiscard");
2843 if (isConstExpr()) sl.emplace_back("constexpr");
2844 if (isConstEval()) sl.emplace_back("consteval");
2845 if (isConstInit()) sl.emplace_back("constinit");
2846 if (isAddable()) sl.emplace_back("add");
2847 if (!isUNOProperty() && isRemovable()) sl.emplace_back("remove");
2848 if (isRaisable()) sl.emplace_back("raise");
2849 if (isReadable()) sl.emplace_back("read");
2850 if (isWritable()) sl.emplace_back("write");
2851 if (isFinal()) sl.emplace_back("final");
2852 if (isAbstract()) sl.emplace_back("abstract");
2853 if (isOverride()) sl.emplace_back("override");
2854 if (isInitonly()) sl.emplace_back("initonly");
2855 if (isSealed()) sl.emplace_back("sealed");
2856 if (isNew()) sl.emplace_back("new");
2857 if (isOptional()) sl.emplace_back("optional");
2858 if (isRequired()) sl.emplace_back("required");
2859 if (isExported()) sl.emplace_back("export");
2860
2861 if (isNonAtomic()) sl.emplace_back("nonatomic");
2862 else if (isObjCProperty()) sl.emplace_back("atomic");
2863
2864 // mutual exclusive Objective 2.0 property attributes
2865 if (isAssign()) sl.emplace_back("assign");
2866 else if (isCopy()) sl.emplace_back("copy");
2867 else if (isRetain()) sl.emplace_back("retain");
2868 else if (isWeak()) sl.emplace_back("weak");
2869 else if (lang!=SrcLangExt::CSharp && isStrong()) sl.emplace_back("strong");
2870 else if (isUnretained()) sl.emplace_back("unsafe_unretained");
2871
2872 if (!isObjCMethod())
2873 {
2874 if (protection()==Protection::Protected) sl.emplace_back("protected");
2875 else if (protection()==Protection::Private) sl.emplace_back("private");
2876 else if (protection()==Protection::Package) sl.emplace_back("package");
2877
2878 if (lvirt==Specifier::Virtual) sl.emplace_back("virtual");
2879 else if (lvirt==Specifier::Pure) sl.emplace_back("pure virtual");
2880 if (isSignal()) sl.emplace_back("signal");
2881 if (isSlot()) sl.emplace_back("slot");
2882 if (isDefault()) sl.emplace_back("default");
2883 if (isDelete()) sl.emplace_back("delete");
2884 if (isNoExcept()) sl.emplace_back("noexcept");
2885 if (isAttribute()) sl.emplace_back("attribute");
2886 if (isUNOProperty()) sl.emplace_back("property");
2887 if (isReadonly()) sl.emplace_back("readonly");
2888 if (isBound()) sl.emplace_back("bound");
2889 if (isUNOProperty() && isRemovable()) sl.emplace_back("removable");
2890 if (isConstrained()) sl.emplace_back("constrained");
2891 if (isTransient()) sl.emplace_back("transient");
2892 if (isMaybeVoid()) sl.emplace_back("maybevoid");
2893 if (isMaybeDefault()) sl.emplace_back("maybedefault");
2894 if (isMaybeAmbiguous()) sl.emplace_back("maybeambiguous");
2895 if (isPublished()) sl.emplace_back("published"); // enum
2896 }
2898 {
2899 sl.emplace_back("implementation");
2900 }
2901 }
2902 if (getClassDef() &&
2903 container->definitionType()==TypeClass &&
2904 getClassDef()!=container &&
2905 !isRelated()
2906 )
2907 {
2908 sl.emplace_back("inherited");
2909 }
2910 }
2911 }
2912 else if (isObjCMethod() && isImplementation())
2913 {
2914 sl.emplace_back("implementation");
2915 }
2916
2917 for (const auto &sx : m_qualifiers)
2918 {
2919 bool alreadyAdded = std::find(sl.begin(), sl.end(), sx) != sl.end();
2920 if (!alreadyAdded)
2921 {
2922 sl.push_back(sx);
2923 }
2924 }
2925
2926 return sl;
2927}
bool isInline() const override
bool isOptional() const override
VhdlSpecifier getVhdlSpecifiers() const override
bool isNew() const override
bool isUnretained() const override
bool isGettable() const override
Specifier virtualness(int count=0) const override
bool isRaisable() const override
bool isMutable() const override
bool isPublished() const override
bool isProtectedSettable() const override
bool isUNOProperty() const override
bool isRequired() const override
bool isMaybeDefault() const override
bool isTransient() const override
bool isInitonly() const override
bool isAddable() const override
Protection protection() const override
bool isCopy() const override
bool isReadonly() const override
bool isAttribute() const override
bool isRetain() const override
bool isConstEval() const override
bool isExplicit() const override
bool isImplementation() const override
bool isDelete() const override
bool isNoExcept() const override
bool isWeak() const override
bool isNoDiscard() const override
bool isConstInit() const override
bool isProtectedGettable() const override
bool isWritable() const override
bool isSealed() const override
bool isAbstract() const override
bool isPrivateSettable() const override
bool isMaybeVoid() const override
bool isMaybeAmbiguous() const override
bool isAssign() const override
bool isRemovable() const override
bool isFriend() const override
bool isConstExpr() const override
bool isExternal() const override
bool isNonAtomic() const override
bool isPrivateGettable() const override
bool isObjCProperty() const override
bool isConstrained() const override
bool isReadable() const override
bool isDefault() const override
bool isSettable() const override
bool isBound() const override
virtual QCString trVhdlType(VhdlSpecifier type, bool single)=0
std::vector< std::string > StringVector
Definition containers.h:33
Specifier
Definition types.h:80

References Config_getBool, Definition::definitionType(), getClassDef(), DefinitionMixin< MemberDefMutable >::getLanguage(), getVhdlSpecifiers(), isAbstract(), isAddable(), isAssign(), isAttribute(), isBound(), isConstEval(), isConstExpr(), isConstInit(), isConstrained(), isCopy(), isDefault(), isDelete(), isExplicit(), DefinitionMixin< MemberDefMutable >::isExported(), isExternal(), isFinal(), isFriend(), isGettable(), isImplementation(), isInitonly(), isInline(), isMaybeAmbiguous(), isMaybeDefault(), isMaybeVoid(), isMutable(), isNew(), isNoDiscard(), isNoExcept(), isNonAtomic(), isObjCMethod(), isObjCProperty(), isOptional(), isOverride(), isPrivateGettable(), isPrivateSettable(), isProtectedGettable(), isProtectedSettable(), isPublished(), isRaisable(), isReadable(), isReadonly(), isRelated(), isRemovable(), isRequired(), isRetain(), isSealed(), isSettable(), isSignal(), isSlot(), isStatic(), isStrong(), isTransient(), isUNOProperty(), isUnretained(), isWeak(), isWritable(), m_memSpec, m_qualifiers, protection(), theTranslator, TRUE, Definition::TypeClass, and virtualness().

Referenced by writeDocumentation().

◆ getMemberGroup()

MemberGroup * MemberDefImpl::getMemberGroup ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5668 of file memberdef.cpp.

5669{
5670 return m_memberGroup;
5671}

References m_memberGroup.

◆ getMemberGroupId()

int MemberDefImpl::getMemberGroupId ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5663 of file memberdef.cpp.

5664{
5665 return m_grpId;
5666}

References m_grpId.

◆ getMemberSpecifiers()

TypeSpecifier MemberDefImpl::getMemberSpecifiers ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5081 of file memberdef.cpp.

5082{
5083 return m_memSpec;
5084}

References m_memSpec.

◆ getModuleDef()

const ModuleDef * MemberDefImpl::getModuleDef ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5146 of file memberdef.cpp.

5147{
5148 return m_moduleDef;
5149}

References m_moduleDef.

Referenced by getOutputFileBase(), getReference(), hasDetailedDescription(), writeDocumentation(), and writeLink().

◆ getNamespaceDef() [1/2]

◆ getNamespaceDef() [2/2]

NamespaceDef * MemberDefImpl::getNamespaceDef ( )
overridevirtual

Implements MemberDef.

Definition at line 5121 of file memberdef.cpp.

5122{
5123 return m_nspace;
5124}

References m_nspace.

◆ 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 Definition.

Definition at line 1656 of file memberdef.cpp.

1657{
1658 bool separateMemberPages = Config_getBool(SEPARATE_MEMBER_PAGES);
1659 bool inlineSimpleClasses = Config_getBool(INLINE_SIMPLE_STRUCTS);
1660 QCString baseName;
1661
1662 //printf("Member: %s: templateMaster=%p group=%p classDef=%p nspace=%p fileDef=%p\n",
1663 // qPrint(name()),m_templateMaster,m_group,m_classDef,
1664 // m_nspace,m_fileDef);
1665 const NamespaceDef *nspace = getNamespaceDef();
1666 const FileDef *fileDef = getFileDef();
1667 const ClassDef *classDef = getClassDef();
1668 const ModuleDef *moduleDef = getModuleDef();
1669 const GroupDef *groupDef = getGroupDef();
1670 if (!m_explicitOutputFileBase.isEmpty())
1671 {
1673 }
1674 else if (templateMaster())
1675 {
1677 }
1678 else if (groupDef)
1679 {
1680 baseName=groupDef->getOutputFileBase();
1681 }
1682 else if (classDef)
1683 {
1684 baseName=classDef->getOutputFileBase();
1685 if (inlineSimpleClasses && classDef->isSimple())
1686 {
1687 return baseName;
1688 }
1689 }
1690 else if (nspace && (nspace->isLinkable() || nspace->isAnonymous()))
1691 {
1692 baseName=nspace->getOutputFileBase();
1693 }
1694 else if (fileDef)
1695 {
1696 baseName=fileDef->getOutputFileBase();
1697 }
1698 else if (moduleDef)
1699 {
1700 baseName=moduleDef->getOutputFileBase();
1701 }
1702
1703 if (baseName.isEmpty())
1704 {
1706 "Internal inconsistency: member {} does not belong to any container!",name()
1707 );
1708 return "dummy";
1709 }
1710 else if (separateMemberPages && hasDetailedDescription())
1711 {
1712 if (getEnumScope()) // enum value, which is part of enum's documentation
1713 {
1714 baseName+="_"+getEnumScope()->anchor();
1715 }
1716 else
1717 {
1718 baseName+="_"+anchor();
1719 }
1720 }
1721 return baseName;
1722}
virtual bool isSimple() const =0
virtual bool isAnonymous() const =0
bool hasDetailedDescription() const override
const MemberDef * getEnumScope() const override
const ModuleDef * getModuleDef() const override
#define warn(file, line, fmt,...)
Definition message.h:97

References Definition::anchor(), anchor(), Config_getBool, getClassDef(), DefinitionMixin< MemberDefMutable >::getDefFileName(), DefinitionMixin< MemberDefMutable >::getDefLine(), getEnumScope(), getFileDef(), getGroupDef(), getModuleDef(), getNamespaceDef(), Definition::getOutputFileBase(), hasDetailedDescription(), Definition::isAnonymous(), QCString::isEmpty(), Definition::isLinkable(), ClassDef::isSimple(), m_explicitOutputFileBase, DefinitionMixin< MemberDefMutable >::name(), templateMaster(), and warn.

Referenced by addListReference(), writeDeclaration(), writeDocumentation(), writeLink(), writeMemberDocSimple(), and writeTagFile().

◆ getQualifiers()

StringVector MemberDefImpl::getQualifiers ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5848 of file memberdef.cpp.

5849{
5850 return m_qualifiers;
5851}

References m_qualifiers.

◆ getReadAccessor()

QCString MemberDefImpl::getReadAccessor ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5126 of file memberdef.cpp.

5127{
5128 return m_read;
5129}

References m_read.

◆ 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

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 1724 of file memberdef.cpp.

1725{
1726 QCString ref = DefinitionMixin::getReference();
1727 if (!ref.isEmpty())
1728 {
1729 return ref;
1730 }
1731 const NamespaceDef *nspace = getNamespaceDef();
1732 const FileDef *fileDef = getFileDef();
1733 const ClassDef *classDef = getClassDef();
1734 const ModuleDef *moduleDef = getModuleDef();
1735 const GroupDef *groupDef = getGroupDef();
1736 if (templateMaster())
1737 {
1738 return templateMaster()->getReference();
1739 }
1740 else if (groupDef)
1741 {
1742 return groupDef->getReference();
1743 }
1744 else if (classDef)
1745 {
1746 return classDef->getReference();
1747 }
1748 else if (nspace)
1749 {
1750 return nspace->getReference();
1751 }
1752 else if (moduleDef)
1753 {
1754 return moduleDef->getReference();
1755 }
1756 else if (fileDef)
1757 {
1758 return fileDef->getReference();
1759 }
1760 return "";
1761}
QCString getReference() const override

References getClassDef(), getFileDef(), getGroupDef(), getModuleDef(), getNamespaceDef(), Definition::getReference(), DefinitionMixin< Base >::getReference(), QCString::isEmpty(), and templateMaster().

Referenced by anchor(), and writeLink().

◆ getScopeString()

QCString MemberDefImpl::getScopeString ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4340 of file memberdef.cpp.

4341{
4342 QCString result;
4343 if (isStrong()) result=name();
4344 else if (getClassDef()) result=getClassDef()->displayName();
4345 else if (getNamespaceDef()) result=getNamespaceDef()->displayName();
4346 return result;
4347}

References Definition::displayName(), getClassDef(), getNamespaceDef(), isStrong(), and DefinitionMixin< MemberDefMutable >::name().

Referenced by sourceRefName(), and writeDocumentation().

◆ getSectionList()

const MemberList * MemberDefImpl::getSectionList ( const Definition * container) const
overridevirtual

Implements MemberDef.

Definition at line 4571 of file memberdef.cpp.

4572{
4573 auto it = m_sectionMap.find(container);
4574 return it!=m_sectionMap.end() ? it->second : nullptr;
4575}

References m_sectionMap.

◆ getVhdlSpecifiers()

VhdlSpecifier MemberDefImpl::getVhdlSpecifiers ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5086 of file memberdef.cpp.

5087{
5088 return m_vhdlSpec;
5089}

References m_vhdlSpec.

Referenced by getLabels().

◆ getWriteAccessor()

QCString MemberDefImpl::getWriteAccessor ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5131 of file memberdef.cpp.

5132{
5133 return m_write;
5134}

References m_write.

◆ hasCallerGraph()

bool MemberDefImpl::hasCallerGraph ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5696 of file memberdef.cpp.

5697{
5698 return m_hasCallerGraph;
5699}

References m_hasCallerGraph.

◆ hasCallGraph()

bool MemberDefImpl::hasCallGraph ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5678 of file memberdef.cpp.

5679{
5680 return m_hasCallGraph;
5681}

References m_hasCallGraph.

◆ hasDetailedDescription()

bool MemberDefImpl::hasDetailedDescription ( ) const
overridevirtual

Implements MemberDef.

Definition at line 2661 of file memberdef.cpp.

2662{
2663 std::lock_guard<std::mutex> lock(g_hasDetailedDescriptionMutex);
2664 //printf(">hasDetailedDescription(cached=%d)\n",m_hasDetailedDescriptionCached);
2666 {
2667 bool extractAll = Config_getBool(EXTRACT_ALL);
2668 bool alwaysDetailedSec = Config_getBool(ALWAYS_DETAILED_SEC);
2669 bool repeatBrief = Config_getBool(REPEAT_BRIEF);
2670 bool briefMemberDesc = Config_getBool(BRIEF_MEMBER_DESC);
2671 bool hideUndocMembers = Config_getBool(HIDE_UNDOC_MEMBERS);
2672 bool extractStatic = Config_getBool(EXTRACT_STATIC);
2673 bool extractPrivateVirtual = Config_getBool(EXTRACT_PRIV_VIRTUAL);
2674 bool inlineSources = hasInlineSource();
2675
2676 // the member has detailed documentation because the user added some comments
2677 bool docFilter =
2678 // extract all is enabled
2679 extractAll ||
2680 // has detailed docs
2681 !documentation().isEmpty() ||
2682 // has inbody docs
2684 // is an enum with values that are documented
2686 // is documented enum value
2687 (m_mtype==MemberType::EnumValue && !briefDescription().isEmpty()) ||
2688 // has brief description that is part of the detailed description
2689 (!briefDescription().isEmpty() && // has brief docs
2690 (alwaysDetailedSec && // they are visible in
2691 (repeatBrief || // detailed section or
2692 !briefMemberDesc // they are explicitly not
2693 ) // shown in brief section
2694 )
2695 ) ||
2696 // has one or more documented arguments
2698 m_templateMaster->argumentList().hasDocumentation() :
2699 m_defArgList.hasDocumentation()) ||
2701 m_templateMaster->templateArguments().hasTemplateDocumentation() :
2702 m_tArgList.hasTemplateDocumentation()) ||
2703 // user-specified qualifiers
2704 !m_qualifiers.empty();
2705
2706 // generate function guard
2707 // ================== =======
2708 // _writeGroupInclude -> ignored in calculation
2709 // multiLineInitializer() -> hasMultiLineInitializer()
2710 // _writeReimplements -> _isReimplements()
2711 // _writeReimplementedBy -> _countReimplementedBy()>0
2712 // _writeExamples -> hasExamples()
2713 // _writeTypeConstraints -> m_typeConstraints.hasParameters()
2714 // writeSourceDef -> !getSourceFileBase().isEmpty();
2715 // writeInlineCode -> hasInlineSource() && hasSources()
2716 // writeSourceRefs -> hasReferencesRelation() && hasSourceRefs()
2717 // writeSourceReffedBy -> hasReferencedByRelation() && hasSourceReffedBy()
2718 // _writeCallGraph -> _hasVisibleCallGraph()
2719 // _writeCallerGraph -> _hasVisibleCallerGraph()
2720
2721 // the member has detailed documentation because there is some generated info
2722 bool docInfo =
2723 // has a multi-line initialization block
2725 // reimplements / reimplemented by
2727 // examples
2728 hasExamples() ||
2729 // type constraints
2730 m_typeConstraints.hasParameters() ||
2731 // has source definition
2733 // has inline sources
2734 (inlineSources && hasSources()) ||
2735 // has references
2738 // call graph
2740 // caller graph
2742
2743 if (!hideUndocMembers) // if HIDE_UNDOC_MEMBERS is NO we also show the detailed section
2744 // if there is only some generated info
2745 {
2746 docFilter = docFilter || docInfo;
2747 }
2748
2749 // this is not a global static or global statics should be extracted
2750 bool staticFilter = getClassDef()!=nullptr || !isStatic() || extractStatic;
2751
2752 // a module does not contain details for members, so either the namespace or file should be linkable
2753 bool moduleFilter = getModuleDef()==nullptr || (getFileDef() && getFileDef()->isLinkable()) ||
2755
2756 // only include members that are non-private unless EXTRACT_PRIVATE is
2757 // set to YES or the member is part of a group
2758 bool privateFilter = protectionLevelVisible(protection()) || m_mtype==MemberType::Friend ||
2759 (m_prot==Protection::Private && (m_virt!=Specifier::Normal || isOverride() || isFinal()) && extractPrivateVirtual);
2760
2761 // hide friend (class|struct|union) member if HIDE_FRIEND_COMPOUNDS
2762 // is true
2763 bool friendCompoundFilter = !(Config_getBool(HIDE_FRIEND_COMPOUNDS) && isFriend());
2764
2766 (docFilter && staticFilter && moduleFilter && privateFilter && friendCompoundFilter && !isHidden());
2767 //printf("docFilter=%d docInfo=%d staticFilter=%d privateFilter=%d friendCompoundFilter=%d !isHidden()=%d",
2768 // docFilter,docInfo,staticFilter,privateFilter,friendCompoundFilter,!isHidden());
2770 }
2771 //printf("<hasDetailedDescription(cached=%d)\n",m_hasDetailedDescriptionCached);
2773}
QCString getSourceFileBase() const override
bool hasSourceReffedBy() const override
bool _isReimplements() const
bool hasMultiLineInitializer() const override
bool hasInlineSource() const override
bool hasReferencesRelation() const override
bool hasReferencedByRelation() const override
bool isLinkable() const override
bool hasDocumentedEnumValues() const override
static std::mutex g_hasDetailedDescriptionMutex

References _countReimplementedBy(), _hasVisibleCallerGraph(), _hasVisibleCallGraph(), _isReimplements(), briefDescription(), Config_getBool, documentation(), EnumValue, Friend, g_hasDetailedDescriptionMutex, getClassDef(), getFileDef(), getModuleDef(), getNamespaceDef(), DefinitionMixin< MemberDefMutable >::getSourceFileBase(), hasDocumentation(), hasDocumentedEnumValues(), hasExamples(), hasInlineSource(), hasMultiLineInitializer(), hasReferencedByRelation(), hasReferencesRelation(), DefinitionMixin< MemberDefMutable >::hasSourceReffedBy(), DefinitionMixin< MemberDefMutable >::hasSourceRefs(), DefinitionMixin< MemberDefMutable >::hasSources(), DefinitionMixin< MemberDefMutable >::inbodyDocumentation(), QCString::isEmpty(), isEnumerate(), isFinal(), isFriend(), DefinitionMixin< MemberDefMutable >::isHidden(), Definition::isLinkable(), isLinkable(), isOverride(), isStatic(), m_defArgList, m_detailedDescriptionCachedValue, m_hasDetailedDescriptionCached, m_mtype, m_prot, m_qualifiers, m_tArgList, m_templateMaster, m_typeConstraints, m_virt, protection(), and protectionLevelVisible().

Referenced by getOutputFileBase(), isDetailedSectionVisible(), warnIfUndocumented(), writeDeclaration(), and writeLink().

◆ hasDocumentation()

bool MemberDefImpl::hasDocumentation ( ) const
overridevirtual

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

See also
hasUserDocumentation()

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 4327 of file memberdef.cpp.

4328{
4330 (m_mtype==MemberType::Enumeration && m_docEnumValues) || // has enum values
4331 (m_defArgList.hasDocumentation()|| m_tArgList.hasTemplateDocumentation()); // has doc (template) arguments
4332}
bool hasDocumentation() const override

References Enumeration, DefinitionMixin< Base >::hasDocumentation(), m_defArgList, m_docEnumValues, m_mtype, and m_tArgList.

Referenced by _computeLinkableInProject(), hasDetailedDescription(), isBriefSectionVisible(), visibleInIndex(), warnIfUndocumentedParams(), and writeDeclaration().

◆ hasDocumentedEnumValues()

bool MemberDefImpl::hasDocumentedEnumValues ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5530 of file memberdef.cpp.

5531{
5532 return m_docEnumValues;
5533}

References m_docEnumValues.

Referenced by hasDetailedDescription(), and writeEnumDeclaration().

◆ hasEnumValues()

bool MemberDefImpl::hasEnumValues ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5729 of file memberdef.cpp.

5730{
5731 return m_hasEnumValues;
5732}

References m_hasEnumValues.

Referenced by _writeEnumValues().

◆ hasExamples()

bool MemberDefImpl::hasExamples ( ) const
overridevirtual

Implements MemberDef.

Definition at line 1631 of file memberdef.cpp.

1632{
1633 return !m_examples.empty();
1634}

References m_examples.

Referenced by _writeExamples(), and hasDetailedDescription().

◆ hasInlineSource()

bool MemberDefImpl::hasInlineSource ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5724 of file memberdef.cpp.

5725{
5726 return m_hasInlineSource;
5727}

References m_hasInlineSource.

Referenced by hasDetailedDescription().

◆ hasMultiLineInitializer()

bool MemberDefImpl::hasMultiLineInitializer ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4489 of file memberdef.cpp.

4490{
4491 //printf("initLines=%d userInitLines=%d maxInitLines=%d\n",
4492 // initLines,userInitLines,maxInitLines);
4493 bool isFuncLikeMacro = m_mtype==MemberType::Define && m_defArgList.hasParameters();
4494 return (m_initLines>0 || (!m_initializer.isEmpty() && isFuncLikeMacro)) &&
4495 ((m_initLines<m_maxInitLines && m_userInitLines==-1) // implicitly enabled
4496 || m_initLines<m_userInitLines // explicitly enabled
4497 );
4498}

References Define, m_defArgList, m_initializer, m_initLines, m_maxInitLines, m_mtype, and m_userInitLines.

Referenced by hasDetailedDescription(), and writeDocumentation().

◆ hasOneLineInitializer()

bool MemberDefImpl::hasOneLineInitializer ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4478 of file memberdef.cpp.

4479{
4480 //printf("%s: init=%s, initLines=%d maxInitLines=%d userInitLines=%d\n",
4481 // qPrint(name()),qPrint(m_initializer),m_initLines,
4482 // m_maxInitLines,m_userInitLines);
4483 bool isFuncLikeMacro = m_mtype==MemberType::Define && m_defArgList.hasParameters();
4484 return !m_initializer.isEmpty() && m_initLines==0 && // one line initializer
4485 !isFuncLikeMacro &&
4486 ((m_maxInitLines>0 && m_userInitLines==-1) || m_userInitLines>0); // enabled by default or explicitly
4487}

References Define, m_defArgList, m_initializer, m_initLines, m_maxInitLines, m_mtype, and m_userInitLines.

Referenced by writeDeclaration(), writeDocumentation(), and writeMemberDocSimple().

◆ hasReferencedByRelation()

bool MemberDefImpl::hasReferencedByRelation ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5714 of file memberdef.cpp.

5715{
5717}

References m_hasReferencedByRelation.

Referenced by hasDetailedDescription(), and writeDocumentation().

◆ hasReferencesRelation()

bool MemberDefImpl::hasReferencesRelation ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5719 of file memberdef.cpp.

5720{
5722}

References m_hasReferencesRelation.

Referenced by hasDetailedDescription(), and writeDocumentation().

◆ hasUserDocumentation()

bool MemberDefImpl::hasUserDocumentation ( ) const
overridevirtual

Returns TRUE iff the definition is documented by the user.

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 6328 of file memberdef.cpp.

6329{
6330 if (m_templateMaster)
6331 {
6332 return m_templateMaster->hasUserDocumentation();
6333 }
6334 else
6335 {
6337 }
6338}
bool hasUserDocumentation() const override

References DefinitionMixin< Base >::hasUserDocumentation(), and m_templateMaster.

Referenced by warnIfUndocumented().

◆ incrementFlowKeyWordCount()

void MemberDefImpl::incrementFlowKeyWordCount ( )
overridevirtual

Implements MemberDefMutable.

Definition at line 6130 of file memberdef.cpp.

6131{
6133}

References m_numberOfFlowKW.

◆ inheritsDocsFrom()

const MemberDef * MemberDefImpl::inheritsDocsFrom ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5775 of file memberdef.cpp.

5776{
5777 return m_docProvider;
5778}

References m_docProvider.

◆ init()

void MemberDefImpl::init ( Definition * def,
const QCString & t,
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 )
private

Definition at line 1323 of file memberdef.cpp.

1329{
1330 m_classDef=nullptr;
1331 m_fileDef=nullptr;
1332 m_moduleDef=nullptr;
1333 m_redefines=nullptr;
1334 m_relatedAlso=nullptr;
1335 m_accessorClass=nullptr;
1336 m_nspace=nullptr;
1337 m_memDef=nullptr;
1338 m_memDec=nullptr;
1339 m_group=nullptr;
1340 m_grpId=-1;
1341 m_enumScope=nullptr;
1343 m_hasCallGraph = Config_getBool(CALL_GRAPH);
1344 m_hasCallerGraph = Config_getBool(CALLER_GRAPH);
1345 m_hasReferencedByRelation = Config_getBool(REFERENCED_BY_RELATION);
1346 m_hasReferencesRelation = Config_getBool(REFERENCES_RELATION);
1347 m_hasEnumValues = Config_getBool(SHOW_ENUM_VALUES);
1348 m_hasInlineSource = Config_getBool(INLINE_SOURCES);
1349 m_initLines=0;
1350 m_type=t;
1351 if (mt==MemberType::Typedef) m_type.stripPrefix("typedef ");
1352 // type.stripPrefix("struct ");
1353 // type.stripPrefix("class " );
1354 // type.stripPrefix("union " );
1356 m_args=a;
1358 if (m_type.isEmpty()) m_decl=d->name()+m_args; else m_decl=m_type+" "+d->name()+m_args;
1359
1360 m_memberGroup=nullptr;
1361 m_virt=v;
1362 m_prot=p;
1363 m_related=r;
1364 m_stat=s;
1365 m_mtype=mt;
1366 m_exception=e;
1367 m_proto=FALSE;
1369 m_memSpec=TypeSpecifier();
1371 m_annMemb=nullptr;
1372 m_annEnumType=nullptr;
1373 m_groupAlias=nullptr;
1375 m_tspec=FALSE;
1376 m_cachedAnonymousType=nullptr;
1377 m_maxInitLines=Config_getInt(MAX_INITIALIZER_LINES);
1378 m_userInitLines=-1;
1380 // copy function template arguments (if any)
1381 m_tArgList = tal;
1382 //printf("new member al=%p\n",al);
1383 // copy function definition arguments (if any)
1384 m_defArgList = al;
1385 // convert function declaration arguments (if any)
1386 if (!m_args.isEmpty())
1387 {
1389 //printf("setDeclArgList %s to %s const=%d\n",qPrint(args),
1390 // qPrint(argListToString(declArgList)),declArgList->constSpecifier);
1391 }
1392 m_metaData = meta;
1393 m_templateMaster = nullptr;
1396 m_cachedTypedefValue = nullptr;
1398 m_groupMember = nullptr;
1401 m_docProvider = nullptr;
1402 m_isDMember = d->getDefFileName().lower().endsWith(".d");
1403}
std::unique_ptr< ArgumentList > stringToArgumentList(SrcLangExt lang, const QCString &argsString, QCString *extraTypeChars=nullptr)
Definition defargs.l:809

References Config_getBool, Config_getInt, QCString::endsWith(), FALSE, Definition::getDefFileName(), Definition::getLanguage(), QCString::lower(), m_accessorClass, m_annEnumType, m_annMemb, m_annScope, m_args, m_cachedAnonymousType, m_cachedTypedefValue, m_classDef, m_decl, m_declArgList, m_defArgList, m_docEnumValues, m_docProvider, m_docsForDefinition, m_enumScope, m_exception, m_explExt, m_extraTypeChars, m_fileDef, m_group, m_groupAlias, m_groupMember, m_grpId, m_hasCallerGraph, m_hasCallGraph, m_hasDocumentedParams, m_hasDocumentedReturnType, m_hasEnumValues, m_hasInlineSource, m_hasReferencedByRelation, m_hasReferencesRelation, m_implOnly, m_initLines, m_isDMember, m_isTypedefValCached, m_livesInsideEnum, m_maxInitLines, m_memberGroup, m_memDec, m_memDef, m_memSpec, m_metaData, m_moduleDef, m_mtype, m_nspace, m_prot, m_proto, m_redefines, m_related, m_relatedAlso, m_stat, m_tArgList, m_templateMaster, m_tspec, m_type, m_userInitLines, m_vhdlSpec, m_virt, Definition::name(), removeRedundantWhiteSpace(), stringToArgumentList(), TRUE, Typedef, and UNKNOWN.

Referenced by MemberDefImpl(), and writeDocumentation().

◆ initializer()

const QCString & MemberDefImpl::initializer ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5071 of file memberdef.cpp.

5072{
5073 return m_initializer;
5074}

References m_initializer.

Referenced by setInitializer().

◆ initializerLines()

int MemberDefImpl::initializerLines ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5076 of file memberdef.cpp.

5077{
5078 return m_initLines;
5079}

References m_initLines.

◆ insertEnumField()

void MemberDefImpl::insertEnumField ( MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 1620 of file memberdef.cpp.

1621{
1622 m_enumFields.push_back(md);
1623}

References m_enumFields.

◆ insertReimplementedBy()

void MemberDefImpl::insertReimplementedBy ( MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 1575 of file memberdef.cpp.

1576{
1577 if (m_templateMaster)
1578 {
1579 MemberDefMutable *mdm = toMemberDefMutable(const_cast<MemberDef *>(m_templateMaster));
1580 if (mdm)
1581 {
1582 mdm->insertReimplementedBy(md);
1583 }
1584 }
1585 if (!m_redefinedBy.contains(md))
1586 {
1587 m_redefinedBy.inSort(md);
1588 }
1589}
virtual void insertReimplementedBy(MemberDef *md)=0

References MemberDefMutable::insertReimplementedBy(), m_redefinedBy, m_templateMaster, and toMemberDefMutable().

◆ invalidateCachedArgumentTypes()

void MemberDefImpl::invalidateCachedArgumentTypes ( )
overridevirtual

Implements MemberDefMutable.

Definition at line 6124 of file memberdef.cpp.

6125{
6128}
static void invalidateCachedTypesInArgumentList(ArgumentList &al)

References invalidateCachedTypesInArgumentList(), m_declArgList, and m_defArgList.

◆ invalidateTypedefValCache()

void MemberDefImpl::invalidateTypedefValCache ( )
overridevirtual

Implements MemberDefMutable.

Definition at line 6016 of file memberdef.cpp.

6017{
6019}

References FALSE, and m_isTypedefValCached.

◆ isAbstract()

bool MemberDefImpl::isAbstract ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5366 of file memberdef.cpp.

5367{
5368 return m_memSpec.isAbstract();
5369}

References m_memSpec.

Referenced by getLabels().

◆ isAddable()

bool MemberDefImpl::isAddable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5316 of file memberdef.cpp.

5317{
5318 return m_memSpec.isAddable();
5319}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isAssign()

bool MemberDefImpl::isAssign ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5391 of file memberdef.cpp.

5392{
5393 return m_memSpec.isAssign();
5394}

References m_memSpec.

Referenced by getLabels().

◆ isAttribute()

bool MemberDefImpl::isAttribute ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5448 of file memberdef.cpp.

5449{
5450 return m_memSpec.isAttribute();
5451}

References m_memSpec.

Referenced by getLabels().

◆ isBound()

bool MemberDefImpl::isBound ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5463 of file memberdef.cpp.

5464{
5465 return m_memSpec.isBound();
5466}

References m_memSpec.

Referenced by getLabels().

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

Definition at line 2029 of file memberdef.cpp.

2030{
2031 bool extractStatic = Config_getBool(EXTRACT_STATIC);
2032 bool extractPrivateVirtual = Config_getBool(EXTRACT_PRIV_VIRTUAL);
2033 bool hideUndocMembers = Config_getBool(HIDE_UNDOC_MEMBERS);
2034 bool briefMemberDesc = Config_getBool(BRIEF_MEMBER_DESC);
2035 bool repeatBrief = Config_getBool(REPEAT_BRIEF);
2036 bool hideFriendCompounds = Config_getBool(HIDE_FRIEND_COMPOUNDS);
2037
2038 //printf("Member %s grpId=%d docs=%s file=%s args=%s\n",
2039 // qPrint(name()),
2040 // 0,"", //grpId,grpId==-1?"<none>":Doxygen::memberDocDict[grpId]->data(),
2041 // "", //qPrint(getFileDef()->name()),
2042 // argsString());
2043
2044 bool hasDocs = hasDocumentation();
2045
2046 // only include static members with file/namespace scope if
2047 // explicitly enabled in the config file
2048 bool visibleIfStatic = !(getClassDef()==nullptr &&
2049 isStatic() &&
2050 !extractStatic
2051 );
2052
2053 // only include members is the are documented or
2054 // HIDE_UNDOC_MEMBERS is NO in the config file
2055 bool visibleIfDocumented = (!hideUndocMembers ||
2056 hasDocs ||
2058 );
2059
2060 // hide members with no detailed description and brief descriptions
2061 // explicitly disabled.
2062 bool visibleIfEnabled = !(hideUndocMembers &&
2063 documentation().isEmpty() &&
2064 !briefMemberDesc &&
2065 !repeatBrief
2066 );
2067
2068 // Hide friend (class|struct|union) declarations if HIDE_FRIEND_COMPOUNDS is true
2069 bool visibleIfFriendCompound = !(hideFriendCompounds &&
2070 isFriend() /*&&
2071 (m_type=="friend class" ||
2072 m_type=="friend struct" ||
2073 m_type=="friend union"
2074 )*/
2075 );
2076
2077 // only include members that are non-private unless EXTRACT_PRIVATE is
2078 // set to YES or the member is part of a group. And as a special case,
2079 // private *documented* virtual members are shown if EXTRACT_PRIV_VIRTUAL
2080 // is set to YES
2081 bool visibleIfPrivate = (protectionLevelVisible(protection()) ||
2083 (m_prot==Protection::Private &&
2084 (m_virt!=Specifier::Normal || isOverride() || isFinal()) && extractPrivateVirtual && hasDocs)
2085 );
2086
2087 // hide member if it overrides a member in a superclass and has no
2088 // documentation of its own
2089 //bool visibleIfDocVirtual = !reimplements() ||
2090 // !Config_getBool(INHERIT_DOCS) ||
2091 // hasDocs;
2092
2093 // true if this member is a constructor or destructor
2094 bool cOrDTor = isConstructor() || isDestructor();
2095
2096 // hide default constructors or destructors (no args) without
2097 // documentation
2098 bool visibleIfNotDefaultCDTor = !(cOrDTor &&
2099 (m_defArgList.empty() ||
2100 m_defArgList.front().type == "void"
2101 ) &&
2102 !hasDocs
2103 );
2104
2105
2106 //printf("visibleIfStatic=%d visibleIfDocumented=%d visibleIfEnabled=%d "
2107 // "visibleIfPrivate=%d visibleIfNotDefaultCDTor=%d "
2108 // "visibleIfFriendCompound=%d !annScope=%d\n",
2109 // visibleIfStatic,visibleIfDocumented,
2110 // visibleIfEnabled,visibleIfPrivate,visibleIfNotDefaultCDTor,
2111 // visibleIfFriendCompound,!m_annScope);
2112
2113 bool visible = visibleIfStatic && visibleIfDocumented &&
2114 visibleIfEnabled && visibleIfPrivate &&
2115 /*visibleIfDocVirtual &&*/ visibleIfNotDefaultCDTor &&
2116 visibleIfFriendCompound &&
2117 !m_annScope && !isHidden();
2118 //printf("MemberDefImpl::isBriefSectionVisible() %d\n",visible);
2119 return visible;
2120}
bool isConstructor() const override
bool isDocumentedFriendClass() const override

References Config_getBool, documentation(), Friend, getClassDef(), hasDocumentation(), isConstructor(), isDestructor(), isDocumentedFriendClass(), QCString::isEmpty(), isFinal(), isFriend(), DefinitionMixin< MemberDefMutable >::isHidden(), isOverride(), isStatic(), m_annScope, m_defArgList, m_mtype, m_prot, m_virt, protection(), and protectionLevelVisible().

Referenced by writeEnumDeclaration().

◆ isCallable()

bool MemberDefImpl::isCallable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5514 of file memberdef.cpp.

5515{
5516 return isFunction() ||
5517 isSlot() ||
5518 isSignal() ||
5519 isConstructor() ||
5520 isDestructor() ||
5521 isObjCMethod() ||
5522 isFriend();
5523}

References isConstructor(), isDestructor(), isFriend(), isFunction(), isObjCMethod(), isSignal(), and isSlot().

Referenced by sourceRefName().

◆ isConstEval()

bool MemberDefImpl::isConstEval ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5570 of file memberdef.cpp.

5571{
5572 return m_memSpec.isConstEval();
5573}

References m_memSpec.

Referenced by getLabels().

◆ isConstExpr()

bool MemberDefImpl::isConstExpr ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5565 of file memberdef.cpp.

5566{
5567 return m_memSpec.isConstExpr();
5568}

References m_memSpec.

Referenced by getLabels().

◆ isConstInit()

bool MemberDefImpl::isConstInit ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5575 of file memberdef.cpp.

5576{
5577 return m_memSpec.isConstInit();
5578}

References m_memSpec.

Referenced by getLabels().

◆ isConstrained()

bool MemberDefImpl::isConstrained ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5468 of file memberdef.cpp.

5469{
5470 return m_memSpec.isConstrained();
5471}

References m_memSpec.

Referenced by getLabels().

◆ isConstructor()

bool MemberDefImpl::isConstructor ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4717 of file memberdef.cpp.

4718{
4719 if (m_isConstructorCached==0)
4720 {
4721 MemberDefImpl *that = const_cast<MemberDefImpl*>(this);
4722 that->_computeIsConstructor();
4723 }
4725 return m_isConstructorCached==2;
4726
4727}
void _computeIsConstructor()
#define ASSERT(x)
Definition qcstring.h:39

References _computeIsConstructor(), ASSERT, m_isConstructorCached, and MemberDefImpl().

Referenced by isBriefSectionVisible(), isCallable(), and warnIfUndocumentedParams().

◆ isCopy()

bool MemberDefImpl::isCopy ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5386 of file memberdef.cpp.

5387{
5388 return m_memSpec.isCopy();
5389}

References m_memSpec.

Referenced by getLabels().

◆ isCSharpProperty()

bool MemberDefImpl::isCSharpProperty ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4978 of file memberdef.cpp.

4979{
4980 if (getClassDef() && getClassDef()->isCSharp() && isProperty()) return TRUE;
4981 return FALSE;
4982}
bool isProperty() const override

References FALSE, getClassDef(), isProperty(), and TRUE.

◆ isDCOP()

bool MemberDefImpl::isDCOP ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5241 of file memberdef.cpp.

5242{
5243 return m_mtype==MemberType::DCOP;
5244}

References DCOP, and m_mtype.

◆ isDefault()

bool MemberDefImpl::isDefault ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5433 of file memberdef.cpp.

5434{
5435 return m_memSpec.isDefault();
5436}

References m_memSpec.

Referenced by getLabels().

◆ isDefine()

bool MemberDefImpl::isDefine ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5231 of file memberdef.cpp.

5232{
5234}

References Define, and m_mtype.

Referenced by writeDeclaration(), writeDocumentation(), and writeMemberDocSimple().

◆ isDelete()

bool MemberDefImpl::isDelete ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5438 of file memberdef.cpp.

5439{
5440 return m_memSpec.isDelete();
5441}

References m_memSpec.

Referenced by getLabels().

◆ isDeleted()

bool MemberDefImpl::isDeleted ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4322 of file memberdef.cpp.

4323{
4324 return m_defArgList.isDeleted();
4325}

References m_defArgList.

Referenced by warnIfUndocumented(), and warnIfUndocumentedParams().

◆ isDestructor()

bool MemberDefImpl::isDestructor ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4758 of file memberdef.cpp.

4759{
4760 if (m_isDestructorCached==0)
4761 {
4762 MemberDefImpl *that=const_cast<MemberDefImpl*>(this);
4763 that->_computeIsDestructor();
4764 }
4766 return m_isDestructorCached==2;
4767}
void _computeIsDestructor()

References _computeIsDestructor(), ASSERT, m_isDestructorCached, and MemberDefImpl().

Referenced by _computeIsDestructor(), isBriefSectionVisible(), isCallable(), and warnIfUndocumentedParams().

◆ isDetailedSectionVisible()

bool MemberDefImpl::isDetailedSectionVisible ( MemberListContainer container) const
overridevirtual

Implements MemberDef.

Definition at line 2775 of file memberdef.cpp.

2776{
2777 bool separateMemPages = Config_getBool(SEPARATE_MEMBER_PAGES);
2778 bool inlineSimpleStructs = Config_getBool(INLINE_SIMPLE_STRUCTS);
2779 bool hideUndocMembers = Config_getBool(HIDE_UNDOC_MEMBERS);
2780 bool groupFilter = getGroupDef()==nullptr || container==MemberListContainer::Group || separateMemPages;
2781 bool fileFilter = getNamespaceDef()==nullptr || !getNamespaceDef()->isLinkable() || container!=MemberListContainer::File;
2782 bool simpleFilter = (hasBriefDescription() || !hideUndocMembers) && inlineSimpleStructs &&
2783 getClassDef()!=nullptr && getClassDef()->isSimple();
2784
2785 bool visible = hasDetailedDescription() && groupFilter && fileFilter &&
2786 !isReference();
2787 bool result = visible || simpleFilter;
2788 //printf("%s::isDetailedSectionVisible: %d groupFilter=%d fileFilter=%d\n",
2789 // qPrint(name()),result,groupFilter,fileFilter);
2790 return result;
2791}
bool hasBriefDescription() const override

References Config_getBool, File, getClassDef(), getGroupDef(), getNamespaceDef(), Group, DefinitionMixin< MemberDefMutable >::hasBriefDescription(), hasDetailedDescription(), Definition::isLinkable(), isReference(), and ClassDef::isSimple().

◆ isDictionary()

bool MemberDefImpl::isDictionary ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5216 of file memberdef.cpp.

5217{
5219}

References Dictionary, and m_mtype.

◆ isDocsForDefinition()

bool MemberDefImpl::isDocsForDefinition ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5540 of file memberdef.cpp.

5541{
5542 return m_docsForDefinition;
5543}

References m_docsForDefinition.

Referenced by warnIfUndocumentedParams().

◆ isDocumentedFriendClass()

bool MemberDefImpl::isDocumentedFriendClass ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4312 of file memberdef.cpp.

4313{
4314 ClassDef *fcd=nullptr;
4315 QCString baseName=name();
4316 int i=baseName.find('<');
4317 if (i!=-1) baseName=baseName.left(i);
4318 return (isFriendClass() &&
4319 (fcd=getClass(baseName)) && fcd->isLinkable());
4320}
bool isFriendClass() const override

References QCString::find(), getClass(), isFriendClass(), Definition::isLinkable(), QCString::left(), and DefinitionMixin< MemberDefMutable >::name().

Referenced by isBriefSectionVisible(), and writeDeclaration().

◆ isEnumerate()

bool MemberDefImpl::isEnumerate ( ) const
overridevirtual

◆ isEnumStruct()

bool MemberDefImpl::isEnumStruct ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5411 of file memberdef.cpp.

5412{
5413 return m_memSpec.isEnumStruct();
5414}

References m_memSpec.

Referenced by getDeclType(), and writeDocumentation().

◆ isEnumValue()

bool MemberDefImpl::isEnumValue ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5201 of file memberdef.cpp.

5202{
5204}

References EnumValue, and m_mtype.

Referenced by displayDefinition(), and writeDocumentation().

◆ isEvent()

bool MemberDefImpl::isEvent ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5251 of file memberdef.cpp.

5252{
5253 return m_mtype==MemberType::Event;
5254}

References Event, and m_mtype.

Referenced by writeDeclaration().

◆ isExplicit()

bool MemberDefImpl::isExplicit ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5276 of file memberdef.cpp.

5277{
5278 return m_memSpec.isExplicit();
5279}

References m_memSpec.

Referenced by getLabels().

◆ isExternal()

bool MemberDefImpl::isExternal ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5504 of file memberdef.cpp.

5505{
5506 return m_explExt;
5507}

References m_explExt.

Referenced by getLabels().

◆ isFinal()

bool MemberDefImpl::isFinal ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5341 of file memberdef.cpp.

5342{
5343 return m_memSpec.isFinal();
5344}

References m_memSpec.

Referenced by _computeLinkableInProject(), getLabels(), hasDetailedDescription(), isBriefSectionVisible(), and writeDeclaration().

◆ isForeign()

bool MemberDefImpl::isForeign ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5261 of file memberdef.cpp.

5262{
5263 return m_related == Relationship::Foreign;
5264}

References m_related.

Referenced by isRelatedOrFriend().

◆ isFriend()

bool MemberDefImpl::isFriend ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5236 of file memberdef.cpp.

5237{
5239}

References Friend, and m_mtype.

Referenced by getLabels(), hasDetailedDescription(), isBriefSectionVisible(), isCallable(), isFriendClass(), isNotFriend(), and isRelatedOrFriend().

◆ isFriendClass()

bool MemberDefImpl::isFriendClass ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6355 of file memberdef.cpp.

6356{
6357 return (isFriend() &&
6358 (m_type=="friend class" || m_type=="friend struct" ||
6359 m_type=="friend union"));
6360}

References isFriend(), and m_type.

Referenced by isDocumentedFriendClass(), and warnIfUndocumented().

◆ isFriendToHide()

bool MemberDefImpl::isFriendToHide ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6345 of file memberdef.cpp.

6346{
6347 bool hideFriendCompounds = Config_getBool(HIDE_FRIEND_COMPOUNDS);
6348 bool isFriendToHide = hideFriendCompounds &&
6349 (m_type=="friend class" ||
6350 m_type=="friend struct" ||
6351 m_type=="friend union");
6352 return isFriendToHide;
6353}
bool isFriendToHide() const override

References Config_getBool, isFriendToHide(), and m_type.

Referenced by isFriendToHide(), isNotFriend(), and isRelatedOrFriend().

◆ isFunction()

bool MemberDefImpl::isFunction ( ) const
overridevirtual

◆ isFunctionOrSignalSlot()

bool MemberDefImpl::isFunctionOrSignalSlot ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6368 of file memberdef.cpp.

6369{
6370 return isFunction() || isSlot() || isSignal();
6371}

References isFunction(), isSignal(), and isSlot().

◆ isFunctionPtr()

bool MemberDefImpl::isFunctionPtr ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5226 of file memberdef.cpp.

5227{
5228 return m_mtype==MemberType::Variable && QCString(argsString()).find(")(")!=-1;
5229}

References argsString(), QCString::find(), m_mtype, and Variable.

Referenced by writeMemberDocSimple().

◆ isGettable()

bool MemberDefImpl::isGettable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5286 of file memberdef.cpp.

5287{
5288 return m_memSpec.isGettable();
5289}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isImplementation()

bool MemberDefImpl::isImplementation ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5499 of file memberdef.cpp.

5500{
5501 return m_implOnly;
5502}

References m_implOnly.

Referenced by getLabels(), and writeDeclaration().

◆ isInitonly()

bool MemberDefImpl::isInitonly ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5361 of file memberdef.cpp.

5362{
5363 return m_memSpec.isInitonly();
5364}

References m_memSpec.

Referenced by getLabels().

◆ isInline()

bool MemberDefImpl::isInline ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5271 of file memberdef.cpp.

5272{
5273 return m_memSpec.isInline();
5274}

References m_memSpec.

Referenced by getLabels().

◆ 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 Definition.

Definition at line 1900 of file memberdef.cpp.

1901{
1902 if (m_templateMaster)
1903 {
1904 return m_templateMaster->isLinkable();
1905 }
1906 else
1907 {
1908 return isLinkableInProject() || isReference();
1909 }
1910}

References isLinkableInProject(), isReference(), and m_templateMaster.

Referenced by hasDetailedDescription(), visibleInIndex(), writeDocumentation(), and writeLink().

◆ isLinkableInProject()

bool MemberDefImpl::isLinkableInProject ( ) const
overridevirtual

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

Implements Definition.

Definition at line 1889 of file memberdef.cpp.

1890{
1891 if (m_isLinkableCached==0)
1892 {
1893 MemberDefImpl *that = const_cast<MemberDefImpl*>(this);
1895 }
1897 return m_isLinkableCached==2;
1898}
void _computeLinkableInProject()

References _computeLinkableInProject(), ASSERT, m_isLinkableCached, and MemberDefImpl().

Referenced by addListReference(), isLinkable(), writeEnumDeclaration(), and writeTagFile().

◆ isMaybeAmbiguous()

bool MemberDefImpl::isMaybeAmbiguous ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5488 of file memberdef.cpp.

5489{
5490 return m_memSpec.isMaybeAmbiguous();
5491}

References m_memSpec.

Referenced by getLabels().

◆ isMaybeDefault()

bool MemberDefImpl::isMaybeDefault ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5483 of file memberdef.cpp.

5484{
5485 return m_memSpec.isMaybeDefault();
5486}

References m_memSpec.

Referenced by getLabels().

◆ isMaybeVoid()

bool MemberDefImpl::isMaybeVoid ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5478 of file memberdef.cpp.

5479{
5480 return m_memSpec.isMaybeVoid();
5481}

References m_memSpec.

Referenced by getLabels().

◆ isMutable()

bool MemberDefImpl::isMutable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5281 of file memberdef.cpp.

5282{
5283 return m_memSpec.isMutable();
5284}

References m_memSpec.

Referenced by getLabels().

◆ isNew()

bool MemberDefImpl::isNew ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5346 of file memberdef.cpp.

5347{
5348 return m_memSpec.isNew();
5349}

References m_memSpec.

Referenced by getLabels().

◆ isNoDiscard()

bool MemberDefImpl::isNoDiscard ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5560 of file memberdef.cpp.

5561{
5562 return m_memSpec.isNoDiscard();
5563}

References m_memSpec.

Referenced by getLabels().

◆ isNoExcept()

bool MemberDefImpl::isNoExcept ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5443 of file memberdef.cpp.

5444{
5445 return m_memSpec.isNoExcept();
5446}

References m_memSpec.

Referenced by getLabels().

◆ isNonAtomic()

bool MemberDefImpl::isNonAtomic ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5381 of file memberdef.cpp.

5382{
5383 return m_memSpec.isNonAtomic();
5384}

References m_memSpec.

Referenced by getLabels().

◆ isNotFriend()

bool MemberDefImpl::isNotFriend ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6363 of file memberdef.cpp.

6364{
6365 return !(isFriend() && isFriendToHide());
6366}

References isFriend(), and isFriendToHide().

◆ isObjCMethod()

bool MemberDefImpl::isObjCMethod ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4966 of file memberdef.cpp.

4967{
4968 if (getClassDef() && getClassDef()->isObjectiveC() && isFunction()) return TRUE;
4969 return FALSE;
4970}

References FALSE, getClassDef(), isFunction(), and TRUE.

Referenced by addListReference(), getDeclType(), getLabels(), isCallable(), qualifiedName(), writeDeclaration(), writeDocumentation(), writeLink(), and writeMemberDocSimple().

◆ isObjCProperty()

bool MemberDefImpl::isObjCProperty ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4972 of file memberdef.cpp.

4973{
4974 if (getClassDef() && getClassDef()->isObjectiveC() && isProperty()) return TRUE;
4975 return FALSE;
4976}

References FALSE, getClassDef(), isProperty(), and TRUE.

Referenced by getLabels(), and writeDeclaration().

◆ isOptional()

bool MemberDefImpl::isOptional ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5371 of file memberdef.cpp.

5372{
5373 return m_memSpec.isOptional();
5374}

References m_memSpec.

Referenced by getLabels().

◆ isOverride()

bool MemberDefImpl::isOverride ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5356 of file memberdef.cpp.

5357{
5358 return m_memSpec.isOverride();
5359}

References m_memSpec.

Referenced by _computeLinkableInProject(), getLabels(), hasDetailedDescription(), isBriefSectionVisible(), and writeDeclaration().

◆ isPrivateGettable()

bool MemberDefImpl::isPrivateGettable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5291 of file memberdef.cpp.

5292{
5293 return m_memSpec.isPrivateGettable();
5294}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isPrivateSettable()

bool MemberDefImpl::isPrivateSettable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5306 of file memberdef.cpp.

5307{
5308 return m_memSpec.isPrivateSettable();
5309}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isProperty()

bool MemberDefImpl::isProperty ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5246 of file memberdef.cpp.

5247{
5249}

References m_mtype, and Property.

Referenced by isCSharpProperty(), isObjCProperty(), and writeDeclaration().

◆ isProtectedGettable()

bool MemberDefImpl::isProtectedGettable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5296 of file memberdef.cpp.

5297{
5298 return m_memSpec.isProtectedGettable();
5299}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isProtectedSettable()

bool MemberDefImpl::isProtectedSettable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5311 of file memberdef.cpp.

5312{
5313 return m_memSpec.isProtectedSettable();
5314}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isPrototype()

bool MemberDefImpl::isPrototype ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5590 of file memberdef.cpp.

5591{
5592 return m_proto;
5593}

References m_proto.

◆ isPublished()

bool MemberDefImpl::isPublished ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5493 of file memberdef.cpp.

5494{
5495 return m_memSpec.isPublished();
5496}

References m_memSpec.

Referenced by getLabels().

◆ isRaisable()

bool MemberDefImpl::isRaisable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5326 of file memberdef.cpp.

5327{
5328 return m_memSpec.isRaisable();
5329}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isReadable()

bool MemberDefImpl::isReadable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5331 of file memberdef.cpp.

5332{
5333 return m_memSpec.isReadable();
5334}

References m_memSpec.

Referenced by getLabels().

◆ isReadonly()

bool MemberDefImpl::isReadonly ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5458 of file memberdef.cpp.

5459{
5460 return m_memSpec.isReadonly();
5461}

References m_memSpec.

Referenced by getLabels().

◆ isReference()

bool MemberDefImpl::isReference ( ) const
overridevirtual

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

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 6378 of file memberdef.cpp.

6379{
6381 (m_templateMaster && m_templateMaster->isReference());
6382}
bool isReference() const override

References DefinitionMixin< Base >::isReference(), and m_templateMaster.

Referenced by _computeLinkableInProject(), isDetailedSectionVisible(), isLinkable(), warnIfUndocumented(), warnIfUndocumentedParams(), and writeDeclaration().

◆ isReimplementedBy()

bool MemberDefImpl::isReimplementedBy ( const ClassDef * cd) const
overridevirtual

Implements MemberDef.

Definition at line 1601 of file memberdef.cpp.

1602{
1603 if (cd)
1604 {
1605 for (const auto &md : m_redefinedBy)
1606 {
1607 const ClassDef *mcd = md->getClassDef();
1608 if (mcd)
1609 {
1610 if (cd==mcd || cd->isBaseClass(mcd,TRUE))
1611 {
1612 return TRUE;
1613 }
1614 }
1615 }
1616 }
1617 return FALSE;
1618}
virtual int isBaseClass(const ClassDef *bcd, bool followInstances, const QCString &templSpec=QCString()) const =0
Returns TRUE iff bcd is a direct or indirect base class of this class.

References FALSE, ClassDef::isBaseClass(), m_redefinedBy, and TRUE.

◆ isRelated()

bool MemberDefImpl::isRelated ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5256 of file memberdef.cpp.

5257{
5258 return m_related == Relationship::Related;
5259}

References m_related.

Referenced by addListReference(), getLabels(), isRelatedOrFriend(), and writeLink().

◆ isRelatedOrFriend()

bool MemberDefImpl::isRelatedOrFriend ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6373 of file memberdef.cpp.

6374{
6375 return isRelated() || isForeign() || (isFriend() && !isFriendToHide());
6376}
bool isForeign() const override

References isForeign(), isFriend(), isFriendToHide(), and isRelated().

◆ isRemovable()

bool MemberDefImpl::isRemovable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5321 of file memberdef.cpp.

5322{
5323 return m_memSpec.isRemovable();
5324}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isRequired()

bool MemberDefImpl::isRequired ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5376 of file memberdef.cpp.

5377{
5378 return m_memSpec.isRequired();
5379}

References m_memSpec.

Referenced by getLabels().

◆ isRetain()

bool MemberDefImpl::isRetain ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5396 of file memberdef.cpp.

5397{
5398 return m_memSpec.isRetain();
5399}

References m_memSpec.

Referenced by getLabels().

◆ isSealed()

bool MemberDefImpl::isSealed ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5351 of file memberdef.cpp.

5352{
5353 return m_memSpec.isSealed();
5354}

References m_memSpec.

Referenced by getLabels().

◆ isSequence()

bool MemberDefImpl::isSequence ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5211 of file memberdef.cpp.

5212{
5214}

References m_mtype, and Sequence.

◆ isSettable()

bool MemberDefImpl::isSettable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5301 of file memberdef.cpp.

5302{
5303 return m_memSpec.isSettable();
5304}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isSignal()

bool MemberDefImpl::isSignal ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5181 of file memberdef.cpp.

5182{
5184}

References m_mtype, and Signal.

Referenced by _hasVisibleCallerGraph(), _hasVisibleCallGraph(), getLabels(), isCallable(), and isFunctionOrSignalSlot().

◆ isSliceLocal()

bool MemberDefImpl::isSliceLocal ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5555 of file memberdef.cpp.

5556{
5557 return m_memSpec.isLocal();
5558}

References m_memSpec.

Referenced by displayDefinition(), and writeDocumentation().

◆ isSlot()

bool MemberDefImpl::isSlot ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5186 of file memberdef.cpp.

5187{
5188 return m_mtype==MemberType::Slot;
5189}

References m_mtype, and Slot.

Referenced by _hasVisibleCallerGraph(), _hasVisibleCallGraph(), getLabels(), isCallable(), and isFunctionOrSignalSlot().

◆ isStatic()

bool MemberDefImpl::isStatic ( ) const
overridevirtual

◆ isStrong()

bool MemberDefImpl::isStrong ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5406 of file memberdef.cpp.

5407{
5408 return m_memSpec.isStrong();
5409}

References m_memSpec.

Referenced by getDeclType(), getLabels(), getScopeString(), writeDocumentation(), and writeTagFile().

◆ isStrongEnumValue()

bool MemberDefImpl::isStrongEnumValue ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5416 of file memberdef.cpp.

5417{
5419 m_enumScope &&
5420 m_enumScope->isStrong();
5421}

References EnumValue, m_enumScope, and m_mtype.

◆ isTemplateSpecialization()

bool MemberDefImpl::isTemplateSpecialization ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5509 of file memberdef.cpp.

5510{
5511 return m_tspec;
5512}

References m_tspec.

Referenced by writeDocumentation().

◆ isTransient()

bool MemberDefImpl::isTransient ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5473 of file memberdef.cpp.

5474{
5475 return m_memSpec.isTransient();
5476}

References m_memSpec.

Referenced by getLabels().

◆ isTypeAlias()

bool MemberDefImpl::isTypeAlias ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5428 of file memberdef.cpp.

5429{
5430 return m_memSpec.isAlias();
5431}

References m_memSpec.

Referenced by getDeclType(), writeDeclaration(), and writeDocumentation().

◆ isTypedef()

bool MemberDefImpl::isTypedef ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5206 of file memberdef.cpp.

5207{
5209}

References m_mtype, and Typedef.

Referenced by fieldType(), getDeclType(), writeDeclaration(), and writeDocumentation().

◆ isTypedefValCached()

bool MemberDefImpl::isTypedefValCached ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5744 of file memberdef.cpp.

5745{
5746 return m_isTypedefValCached;
5747}

References m_isTypedefValCached.

◆ isUNOProperty()

bool MemberDefImpl::isUNOProperty ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5453 of file memberdef.cpp.

5454{
5455 return m_memSpec.isProperty();
5456}

References m_memSpec.

Referenced by getLabels().

◆ isUnretained()

bool MemberDefImpl::isUnretained ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5423 of file memberdef.cpp.

5424{
5425 return m_memSpec.isUnretained();
5426}

References m_memSpec.

Referenced by getLabels().

◆ isVariable()

bool MemberDefImpl::isVariable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5191 of file memberdef.cpp.

5192{
5194}

References m_mtype, and Variable.

Referenced by writeDocumentation(), and writeMemberDocSimple().

◆ isWeak()

bool MemberDefImpl::isWeak ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5401 of file memberdef.cpp.

5402{
5403 return m_memSpec.isWeak();
5404}

References m_memSpec.

Referenced by getLabels().

◆ isWritable()

bool MemberDefImpl::isWritable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5336 of file memberdef.cpp.

5337{
5338 return m_memSpec.isWritable();
5339}

References m_memSpec.

Referenced by getLabels().

◆ livesInsideEnum()

bool MemberDefImpl::livesInsideEnum ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5550 of file memberdef.cpp.

5551{
5552 return m_livesInsideEnum;
5553}

References m_livesInsideEnum.

Referenced by setEnumScope().

◆ makeForeign()

void MemberDefImpl::makeForeign ( )
overridevirtual

Implements MemberDefMutable.

Definition at line 5899 of file memberdef.cpp.

5900{
5901 m_related = Relationship::Foreign;
5903}

References m_isLinkableCached, and m_related.

◆ makeImplementationDetail()

void MemberDefImpl::makeImplementationDetail ( )
overridevirtual

Implements MemberDefMutable.

Definition at line 5975 of file memberdef.cpp.

5976{
5978}

References m_implOnly, and TRUE.

◆ makeRelated()

void MemberDefImpl::makeRelated ( )
overridevirtual

Implements MemberDefMutable.

Definition at line 5893 of file memberdef.cpp.

5894{
5895 m_related = Relationship::Related;
5897}

References m_isLinkableCached, and m_related.

◆ memberDeclaration()

MemberDef * MemberDefImpl::memberDeclaration ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5770 of file memberdef.cpp.

5771{
5772 return m_memDec;
5773}

References m_memDec.

◆ memberDefinition()

MemberDef * MemberDefImpl::memberDefinition ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5765 of file memberdef.cpp.

5766{
5767 return m_memDef;
5768}

References m_memDef.

◆ memberType()

MemberType MemberDefImpl::memberType ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5176 of file memberdef.cpp.

5177{
5178 return m_mtype;
5179}

References m_mtype.

Referenced by codeSymbolType().

◆ memberTypeName()

QCString MemberDefImpl::memberTypeName ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4069 of file memberdef.cpp.

4070{
4071 switch (m_mtype)
4072 {
4073 case MemberType::Define: return "macro definition";
4074 case MemberType::Function: return "function";
4075 case MemberType::Variable: return "variable";
4076 case MemberType::Typedef: return "typedef";
4077 case MemberType::Enumeration: return "enumeration";
4078 case MemberType::EnumValue: return "enumvalue";
4079 case MemberType::Signal: return "signal";
4080 case MemberType::Slot: return "slot";
4081 case MemberType::Friend: return "friend";
4082 case MemberType::DCOP: return "dcop";
4083 case MemberType::Property: return "property";
4084 case MemberType::Event: return "event";
4085 case MemberType::Interface: return "interface";
4086 case MemberType::Service: return "service";
4087 case MemberType::Sequence: return "sequence";
4088 case MemberType::Dictionary: return "dictionary";
4089 default: return "unknown";
4090 }
4091}

References DCOP, Define, Dictionary, Enumeration, EnumValue, Event, Friend, Function, Interface, m_mtype, Property, Sequence, Service, Signal, Slot, Typedef, and Variable.

Referenced by warnIfUndocumented().

◆ mergeMemberSpecifiers()

void MemberDefImpl::mergeMemberSpecifiers ( TypeSpecifier s)
overridevirtual

Implements MemberDefMutable.

Definition at line 5843 of file memberdef.cpp.

5844{
5845 m_memSpec.merge(s);
5846}

References m_memSpec.

◆ moveArgumentList()

void MemberDefImpl::moveArgumentList ( std::unique_ptr< ArgumentList > al)
overridevirtual

Implements MemberDefMutable.

Definition at line 4894 of file memberdef.cpp.

4895{
4896 m_defArgList = *al;
4897}

References m_defArgList.

◆ moveDeclArgumentList()

void MemberDefImpl::moveDeclArgumentList ( std::unique_ptr< ArgumentList > al)
overridevirtual

Implements MemberDefMutable.

Definition at line 4899 of file memberdef.cpp.

4900{
4901 m_declArgList = *al;
4902}

References m_declArgList.

◆ moveTo()

void MemberDefImpl::moveTo ( Definition * scope)
overridevirtual

Implements MemberDef.

Definition at line 1546 of file memberdef.cpp.

1547{
1548 setOuterScope(scope);
1550 {
1551 m_classDef = toClassDef(scope);
1552 }
1553 else if (scope->definitionType()==Definition::TypeFile)
1554 {
1555 m_fileDef = toFileDef(scope);
1556 }
1557 else if (scope->definitionType()==Definition::TypeModule)
1558 {
1559 m_moduleDef = toModuleDef(scope);
1560 }
1561 else if (scope->definitionType()==Definition::TypeNamespace)
1562 {
1563 m_nspace = toNamespaceDef(scope);
1564 }
1567}
void setOuterScope(Definition *def) override
FileDef * toFileDef(Definition *d)
Definition filedef.cpp:1939
ModuleDef * toModuleDef(Definition *d)
NamespaceDef * toNamespaceDef(Definition *d)

References Definition::definitionType(), m_classDef, m_fileDef, m_isConstructorCached, m_isLinkableCached, m_moduleDef, m_nspace, DefinitionMixin< MemberDefMutable >::setOuterScope(), toClassDef(), toFileDef(), toModuleDef(), toNamespaceDef(), Definition::TypeClass, Definition::TypeFile, Definition::TypeModule, and Definition::TypeNamespace.

◆ numberOfFlowKeyWords()

int MemberDefImpl::numberOfFlowKeyWords ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6135 of file memberdef.cpp.

6136{
6137 return m_numberOfFlowKW;
6138}

References m_numberOfFlowKW.

◆ objCMethodName()

QCString MemberDefImpl::objCMethodName ( bool localLink,
bool showStatic ) const
overridevirtual

Implements MemberDef.

Definition at line 5019 of file memberdef.cpp.

5020{
5021 QCString qm;
5022 if (showStatic)
5023 {
5024 if (isStatic()) qm="+ "; else qm="- ";
5025 }
5026 qm+=name();
5027 if (!localLink) // link to method of same class
5028 {
5029 qm+=" (";
5030 qm+=getClassDef()->name();
5031 qm+=")";
5032 }
5033 return qm;
5034}

References getClassDef(), isStatic(), Definition::name(), and DefinitionMixin< MemberDefMutable >::name().

◆ overrideCallerGraph()

void MemberDefImpl::overrideCallerGraph ( bool e)
overridevirtual

Implements MemberDefMutable.

Definition at line 4938 of file memberdef.cpp.

4939{
4942}
static bool parseSourcesNeeded
Definition doxygen.h:123

References m_hasCallerGraph, Doxygen::parseSourcesNeeded, and TRUE.

◆ overrideCallGraph()

void MemberDefImpl::overrideCallGraph ( bool e)
overridevirtual

Implements MemberDefMutable.

Definition at line 4932 of file memberdef.cpp.

4933{
4936}

References m_hasCallGraph, Doxygen::parseSourcesNeeded, and TRUE.

◆ overrideEnumValues()

void MemberDefImpl::overrideEnumValues ( bool e)
overridevirtual

Implements MemberDefMutable.

Definition at line 4956 of file memberdef.cpp.

4957{
4959}

References m_hasEnumValues.

◆ overrideInlineSource()

void MemberDefImpl::overrideInlineSource ( bool e)
overridevirtual

Implements MemberDefMutable.

Definition at line 4961 of file memberdef.cpp.

4962{
4964}

References m_hasInlineSource.

◆ overrideReferencedByRelation()

void MemberDefImpl::overrideReferencedByRelation ( bool e)
overridevirtual

Implements MemberDefMutable.

Definition at line 4944 of file memberdef.cpp.

4945{
4948}

References m_hasReferencedByRelation, Doxygen::parseSourcesNeeded, and TRUE.

◆ overrideReferencesRelation()

void MemberDefImpl::overrideReferencesRelation ( bool e)
overridevirtual

Implements MemberDefMutable.

Definition at line 4950 of file memberdef.cpp.

4951{
4954}

References m_hasReferencesRelation, Doxygen::parseSourcesNeeded, and TRUE.

◆ protection()

Protection MemberDefImpl::protection ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5171 of file memberdef.cpp.

5172{
5173 return m_prot;
5174}

References m_prot.

Referenced by getLabels(), hasDetailedDescription(), isBriefSectionVisible(), and writeDeclaration().

◆ qualifiedName()

QCString MemberDefImpl::qualifiedName ( ) const
overridevirtual

Returns the fully qualified name of this definition

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 4984 of file memberdef.cpp.

4985{
4986 if (isObjCMethod())
4987 {
4988 QCString qm;
4989 if (isStatic()) qm="+"; else qm="-";
4990 qm+="[";
4991 qm+=getClassDef()->name()+" ";
4992 qm+=name();
4993 qm+="]";
4994 return qm;
4995 }
4996 else if (m_enumScope && m_enumScope->isStrong())
4997 {
4998 return m_enumScope->qualifiedName()+
5000 localName();
5001 }
5002 else
5003 {
5005 }
5006}
QCString qualifiedName() const override

References getClassDef(), DefinitionMixin< MemberDefMutable >::getLanguage(), getLanguageSpecificSeparator(), isObjCMethod(), isStatic(), DefinitionMixin< MemberDefMutable >::localName(), m_enumScope, Definition::name(), DefinitionMixin< MemberDefMutable >::name(), and DefinitionMixin< Base >::qualifiedName().

Referenced by _computeLinkableInProject(), _writeCallerGraph(), _writeCallGraph(), addListReference(), warnIfUndocumented(), warnIfUndocumentedParams(), and writeTagFile().

◆ redefineCount()

int MemberDefImpl::redefineCount ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6408 of file memberdef.cpp.

6409{
6410 return m_redefineCount;
6411}

References m_redefineCount.

◆ reimplementedBy()

const MemberVector & MemberDefImpl::reimplementedBy ( ) const
overridevirtual

Implements MemberDef.

Definition at line 1596 of file memberdef.cpp.

1597{
1598 return m_redefinedBy;
1599}

References m_redefinedBy.

Referenced by _countReimplementedBy(), and _writeReimplementedBy().

◆ reimplements()

const MemberDef * MemberDefImpl::reimplements ( ) const
overridevirtual

Implements MemberDef.

Definition at line 1591 of file memberdef.cpp.

1592{
1593 return m_redefines;
1594}

References m_redefines.

Referenced by _isReimplements(), _writeReimplements(), and virtualness().

◆ relatedAlso()

ClassDef * MemberDefImpl::relatedAlso ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5525 of file memberdef.cpp.

5526{
5527 return m_relatedAlso;
5528}

References m_relatedAlso.

◆ requiresClause()

QCString MemberDefImpl::requiresClause ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6066 of file memberdef.cpp.

6067{
6068 return m_requiresClause;
6069}

References m_requiresClause.

◆ resolveAlias() [1/2]

const MemberDef * MemberDefImpl::resolveAlias ( ) const
inlineoverridevirtual

Implements MemberDef.

Definition at line 66 of file memberdef.cpp.

66{ return this; }

◆ resolveAlias() [2/2]

MemberDef * MemberDefImpl::resolveAlias ( )
inlineoverridevirtual

Implements MemberDef.

Definition at line 65 of file memberdef.cpp.

65{ return this; }

◆ resolveUnnamedParameters()

void MemberDefImpl::resolveUnnamedParameters ( const MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 5605 of file memberdef.cpp.

5606{
5607 ArgumentList &decAl = m_declArgList;
5608 ArgumentList &defAl = m_defArgList;
5609 const ArgumentList &decAlSrc = md->declArgumentList();
5610 const ArgumentList &defAlSrc = md->argumentList();
5611 auto decSrc = decAlSrc.begin(), defSrc = defAlSrc.begin();
5612 for (auto decIt = decAl.begin(), defIt = defAl.begin();
5613 decIt != decAl.end() && defIt != defAl.end() && decSrc != decAlSrc.end() && defSrc != defAlSrc.end();
5614 ++decIt, ++defIt, ++decSrc, ++defSrc++)
5615 {
5616 Argument &decA = *decIt;
5617 Argument &defA = *defIt;
5618 const Argument &decAS = *decSrc;
5619 const Argument &defAS = *defSrc;
5620 if (decA.name.isEmpty())
5621 {
5622 if (!defA.name.isEmpty())
5623 {
5624 decA.name = defA.name;
5625 }
5626 else if (!decAS.name.isEmpty())
5627 {
5628 decA.name = decAS.name;
5629 }
5630 else if (!defAS.name.isEmpty())
5631 {
5632 decA.name = defAS.name;
5633 }
5634 }
5635 if (defA.name.isEmpty())
5636 {
5637 if (!decA.name.isEmpty())
5638 {
5639 defA.name = decA.name;
5640 }
5641 else if (!decAS.name.isEmpty())
5642 {
5643 defA.name = decAS.name;
5644 }
5645 else if (!defAS.name.isEmpty())
5646 {
5647 defA.name = defAS.name;
5648 }
5649 }
5650 }
5651}

References MemberDef::argumentList(), ArgumentList::begin(), MemberDef::declArgumentList(), ArgumentList::end(), QCString::isEmpty(), m_declArgList, m_defArgList, and Argument::name.

◆ setAccessorType()

void MemberDefImpl::setAccessorType ( ClassDef * cd,
const QCString & t )
overridevirtual

Implements MemberDefMutable.

Definition at line 4914 of file memberdef.cpp.

4915{
4916 m_accessorClass = cd;
4917 m_accessorType = t;
4918}

References m_accessorClass, and m_accessorType.

◆ setAnchor()

void MemberDefImpl::setAnchor ( )
overridevirtual

Implements MemberDefMutable.

Definition at line 4349 of file memberdef.cpp.

4350{
4351 QCString memAnchor = name();
4352 if (!m_args.isEmpty()) memAnchor+=m_args;
4353 if (m_memSpec.isAlias()) // this is for backward compatibility
4354 {
4355 memAnchor.prepend(" = "+m_initializer);
4356 }
4357 memAnchor.prepend(definition()); // actually the method name is now included
4358 // twice, which is silly, but we keep it this way for backward
4359 // compatibility.
4360
4361
4362 // include number of template arguments as well,
4363 // to distinguish between two template
4364 // specializations that only differ in the template parameters.
4365 if (m_tArgList.hasParameters())
4366 {
4367 char buf[20];
4368 qsnprintf(buf,20,"%d:",static_cast<int>(m_tArgList.size()));
4369 buf[19]='\0';
4370 memAnchor.prepend(buf);
4371 }
4372 if (!m_requiresClause.isEmpty())
4373 {
4374 memAnchor+=" "+m_requiresClause;
4375 }
4376 if (m_redefineCount>0)
4377 {
4378 char buf[20];
4379 qsnprintf(buf,20,":%d",m_redefineCount);
4380 buf[19]='\0';
4381 memAnchor.append(buf);
4382 }
4383
4384 // convert to md5 hash
4385 uint8_t md5_sig[16];
4386 char sigStr[33];
4387 MD5Buffer(memAnchor.data(),static_cast<unsigned int>(memAnchor.length()),md5_sig);
4388 MD5SigToString(md5_sig,sigStr);
4389 m_anc = QCString("a")+sigStr;
4390}
QCString & append(char c)
Definition qcstring.h:381
const char * data() const
Returns a pointer to the contents of the string in the form of a 0-terminated C string.
Definition qcstring.h:159
#define qsnprintf
Definition qcstring.h:49

References QCString::append(), QCString::data(), definition(), QCString::length(), m_anc, m_args, m_initializer, m_memSpec, m_redefineCount, m_requiresClause, m_tArgList, DefinitionMixin< MemberDefMutable >::name(), QCString::prepend(), and qsnprintf.

◆ setAnonymousEnumType()

void MemberDefImpl::setAnonymousEnumType ( const MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 5932 of file memberdef.cpp.

5933{
5934 m_annEnumType = md;
5935}

References m_annEnumType.

◆ setArgsString()

void MemberDefImpl::setArgsString ( const QCString & as)
overridevirtual

Implements MemberDefMutable.

Definition at line 5910 of file memberdef.cpp.

5911{
5912 m_args = as;
5913}

References m_args.

◆ setBitfields()

void MemberDefImpl::setBitfields ( const QCString & s)
overridevirtual

Implements MemberDefMutable.

Definition at line 5865 of file memberdef.cpp.

5866{
5867 m_bitfields = QCString(s).simplifyWhiteSpace();
5868}

References m_bitfields, and QCString::simplifyWhiteSpace().

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

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 1871 of file memberdef.cpp.

1872{
1875}
virtual int briefLine() const =0
virtual QCString briefFile() const =0
void setBriefDescription(const QCString &brief, const QCString &briefFile, int briefLine) override

References DefinitionMixin< MemberDefMutable >::briefFile(), DefinitionMixin< MemberDefMutable >::briefLine(), m_isLinkableCached, and DefinitionMixin< Base >::setBriefDescription().

◆ setCategory()

void MemberDefImpl::setCategory ( ClassDef * def)
overridevirtual

Implements MemberDefMutable.

Definition at line 6036 of file memberdef.cpp.

6037{
6038 m_category = def;
6039}

References m_category.

◆ setCategoryRelation()

void MemberDefImpl::setCategoryRelation ( const MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 6046 of file memberdef.cpp.

6047{
6048 m_categoryRelation = md;
6049}

References m_categoryRelation.

◆ setDeclFile()

void MemberDefImpl::setDeclFile ( const QCString & df,
int line,
int column )
overridevirtual

Implements MemberDefMutable.

Definition at line 5963 of file memberdef.cpp.

5964{
5965 m_declFileName = df;
5966 m_declLine = line;
5967 m_declColumn = column;
5968}

References m_declColumn, m_declFileName, and m_declLine.

Referenced by setExplicitExternal(), and setPrototype().

◆ setDefinition()

void MemberDefImpl::setDefinition ( const QCString & d)
overridevirtual

Implements MemberDefMutable.

Definition at line 5809 of file memberdef.cpp.

5810{
5811 m_def=d;
5812}

References m_def.

◆ setDefinitionTemplateParameterLists()

void MemberDefImpl::setDefinitionTemplateParameterLists ( const ArgumentLists & lists)
overridevirtual

Implements MemberDefMutable.

Definition at line 1913 of file memberdef.cpp.

1914{
1915 m_defTmpArgLists = lists;
1916}

References m_defTmpArgLists.

◆ setDocsForDefinition()

void MemberDefImpl::setDocsForDefinition ( bool b)
overridevirtual

Implements MemberDefMutable.

Definition at line 6006 of file memberdef.cpp.

6007{
6009}

References m_docsForDefinition.

◆ setDocumentation()

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

Sets the documentation of this definition to d.

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 1865 of file memberdef.cpp.

1866{
1869}
virtual QCString docFile() const =0
virtual int docLine() const =0
void setDocumentation(const QCString &doc, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE) override
std::string_view stripWhiteSpace(std::string_view s)
Given a string view s, returns a new, narrower view on that string, skipping over any leading or trai...
Definition stringutil.h:72

References DefinitionMixin< MemberDefMutable >::docFile(), DefinitionMixin< MemberDefMutable >::docLine(), m_isLinkableCached, DefinitionMixin< Base >::setDocumentation(), and stripWhiteSpace().

◆ setDocumentedEnumValues()

void MemberDefImpl::setDocumentedEnumValues ( bool value)
overridevirtual

Implements MemberDefMutable.

Definition at line 5927 of file memberdef.cpp.

5928{
5929 m_docEnumValues=value;
5930}

References m_docEnumValues.

◆ setEnumBaseType()

void MemberDefImpl::setEnumBaseType ( const QCString & type)
overridevirtual

Implements MemberDefMutable.

Definition at line 6051 of file memberdef.cpp.

6052{
6053 m_enumBaseType = type;
6054}

References m_enumBaseType.

◆ setEnumClassScope()

void MemberDefImpl::setEnumClassScope ( ClassDef * cd)
overridevirtual

Implements MemberDefMutable.

Definition at line 5920 of file memberdef.cpp.

5921{
5922 m_classDef = cd;
5925}

References m_classDef, m_isConstructorCached, and m_isLinkableCached.

◆ setEnumScope()

void MemberDefImpl::setEnumScope ( MemberDef * md,
bool livesInsideEnum = FALSE )
overridevirtual

Implements MemberDefMutable.

Definition at line 4406 of file memberdef.cpp.

4407{
4408 m_enumScope=md;
4410 if (md->getGroupDef())
4411 {
4412 m_group = md->getGroupDef();
4413 m_grouppri = md->getGroupPri();
4418 }
4419}
virtual bool getGroupHasDocs() const =0
virtual GroupDef * getGroupDef()=0
virtual int getGroupStartLine() const =0
virtual Grouping::GroupPri_t getGroupPri() const =0
virtual QCString getGroupFileName() const =0
bool livesInsideEnum() const override

References MemberDef::getGroupDef(), MemberDef::getGroupFileName(), MemberDef::getGroupHasDocs(), MemberDef::getGroupPri(), MemberDef::getGroupStartLine(), livesInsideEnum(), m_enumScope, m_group, m_groupFileName, m_groupHasDocs, m_grouppri, m_groupStartLine, m_isLinkableCached, and m_livesInsideEnum.

◆ setExplicitExternal()

void MemberDefImpl::setExplicitExternal ( bool b,
const QCString & df,
int line,
int column )
overridevirtual

Implements MemberDefMutable.

Definition at line 5950 of file memberdef.cpp.

5951{
5952 m_explExt=b;
5953 if (b)
5954 {
5955 setDeclFile(df,line,column);
5956 }
5957 else
5958 {
5959 setDefFile(df,line,column);
5960 }
5961}
void setDefFile(const QCString &df, int defLine, int defColumn) override
void setDeclFile(const QCString &df, int line, int column) override

References m_explExt, setDeclFile(), and DefinitionMixin< MemberDefMutable >::setDefFile().

◆ setFileDef()

void MemberDefImpl::setFileDef ( FileDef * fd)
overridevirtual

Implements MemberDefMutable.

Definition at line 5814 of file memberdef.cpp.

5815{
5816 m_fileDef=fd;
5820}

References m_fileDef, m_isConstructorCached, m_isDestructorCached, and m_isLinkableCached.

◆ setFormalTemplateArguments()

void MemberDefImpl::setFormalTemplateArguments ( const ArgumentList & al)
overridevirtual

Implements MemberDefMutable.

Definition at line 6001 of file memberdef.cpp.

6002{
6004}

References m_formalTemplateArguments.

◆ setFromAnonymousMember()

void MemberDefImpl::setFromAnonymousMember ( MemberDef * m)
overridevirtual

Implements MemberDefMutable.

Definition at line 5985 of file memberdef.cpp.

5986{
5987 m_annMemb=m;
5988}

References m_annMemb.

◆ setFromAnonymousScope()

void MemberDefImpl::setFromAnonymousScope ( bool b)
overridevirtual

Implements MemberDefMutable.

Definition at line 5980 of file memberdef.cpp.

5981{
5982 m_annScope=b;
5983}

References m_annScope.

◆ setGroupAlias()

void MemberDefImpl::setGroupAlias ( const MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 6011 of file memberdef.cpp.

6012{
6013 m_groupAlias = md;
6014}

References m_groupAlias.

◆ setGroupDef()

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

Implements MemberDefMutable.

Definition at line 4392 of file memberdef.cpp.

4395{
4396 //printf("%s MemberDefImpl::setGroupDef(%s)\n",qPrint(name()),qPrint(gd->name()));
4397 m_group=gd;
4398 m_grouppri=pri;
4399 m_groupFileName=fileName;
4400 m_groupStartLine=startLine;
4401 m_groupHasDocs=hasDocs;
4402 m_groupMember=member;
4404}

References m_group, m_groupFileName, m_groupHasDocs, m_groupMember, m_grouppri, m_groupStartLine, and m_isLinkableCached.

◆ setHidden()

void MemberDefImpl::setHidden ( bool b)
overridevirtual

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 1883 of file memberdef.cpp.

1884{
1887}
void setHidden(bool b) override

References m_isLinkableCached, and DefinitionMixin< Base >::setHidden().

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

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 1877 of file memberdef.cpp.

1878{
1881}
virtual int inbodyLine() const =0
virtual QCString inbodyFile() const =0
void setInbodyDocumentation(const QCString &doc, const QCString &docFile, int docLine) override

References DefinitionMixin< MemberDefMutable >::inbodyFile(), DefinitionMixin< MemberDefMutable >::inbodyLine(), m_isLinkableCached, and DefinitionMixin< Base >::setInbodyDocumentation().

◆ setInheritsDocsFrom()

void MemberDefImpl::setInheritsDocsFrom ( const MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 5905 of file memberdef.cpp.

5906{
5907 m_docProvider = md;
5908}

References m_docProvider.

◆ setInitializer()

void MemberDefImpl::setInitializer ( const QCString & i)
overridevirtual

Implements MemberDefMutable.

Definition at line 4500 of file memberdef.cpp.

4501{
4503 int l=static_cast<int>(m_initializer.length());
4504 int p=l-1;
4505 while (p>=0 && isspace(static_cast<uint8_t>(m_initializer.at(p)))) p--;
4506 m_initializer=m_initializer.left(p+1);
4507 m_initLines=m_initializer.contains('\n');
4508 //printf("%s::setInitializer(%s)\n",qPrint(name()),qPrint(m_initializer));
4509}
const QCString & initializer() const override

References initializer(), m_initializer, and m_initLines.

◆ setMaxInitLines()

void MemberDefImpl::setMaxInitLines ( int lines)
overridevirtual

Implements MemberDefMutable.

Definition at line 5870 of file memberdef.cpp.

5871{
5872 if (lines!=-1)
5873 {
5874 m_userInitLines=lines;
5875 }
5876}

References m_userInitLines.

◆ setMemberClass()

void MemberDefImpl::setMemberClass ( ClassDef * cd)
overridevirtual

◆ setMemberDeclaration()

void MemberDefImpl::setMemberDeclaration ( MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 6026 of file memberdef.cpp.

6027{
6028 m_memDec=md;
6029}

References m_memDec.

◆ setMemberDefinition()

void MemberDefImpl::setMemberDefinition ( MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 6021 of file memberdef.cpp.

6022{
6023 m_memDef=md;
6024}

References m_memDef.

◆ setMemberGroup()

void MemberDefImpl::setMemberGroup ( MemberGroup * grp)
overridevirtual

Implements MemberDef.

Definition at line 4335 of file memberdef.cpp.

4336{
4337 m_memberGroup = grp;
4338}

References m_memberGroup.

◆ setMemberGroupId()

void MemberDefImpl::setMemberGroupId ( int id)
overridevirtual

Implements MemberDefMutable.

Definition at line 5970 of file memberdef.cpp.

5971{
5972 m_grpId=id;
5973}
virtual QCString id() const =0

References DefinitionMixin< MemberDefMutable >::id(), and m_grpId.

◆ setMemberSpecifiers()

void MemberDefImpl::setMemberSpecifiers ( TypeSpecifier s)
overridevirtual

Implements MemberDefMutable.

Definition at line 5833 of file memberdef.cpp.

5834{
5835 m_memSpec=s;
5836}

References m_memSpec.

◆ setMemberType()

void MemberDefImpl::setMemberType ( MemberType t)
overridevirtual

Implements MemberDefMutable.

Definition at line 5803 of file memberdef.cpp.

5804{
5805 m_mtype=t;
5807}

References m_isLinkableCached, and m_mtype.

◆ setModuleDef()

void MemberDefImpl::setModuleDef ( ModuleDef * mod)
overridevirtual

Implements MemberDefMutable.

Definition at line 5822 of file memberdef.cpp.

5823{
5824 m_moduleDef=mod;
5825}

References m_moduleDef.

◆ setNamespace()

void MemberDefImpl::setNamespace ( NamespaceDef * nd)
overridevirtual

Implements MemberDefMutable.

Definition at line 4429 of file memberdef.cpp.

4430{
4431 m_nspace=nd;
4432 setOuterScope(nd);
4433}

References m_nspace, and DefinitionMixin< MemberDefMutable >::setOuterScope().

◆ setProtection()

void MemberDefImpl::setProtection ( Protection p)
overridevirtual

Implements MemberDefMutable.

Definition at line 5827 of file memberdef.cpp.

5828{
5829 m_prot=p;
5831}

References m_isLinkableCached, and m_prot.

◆ setPrototype()

void MemberDefImpl::setPrototype ( bool p,
const QCString & df,
int line,
int column )
overridevirtual

Implements MemberDefMutable.

Definition at line 5937 of file memberdef.cpp.

5938{
5939 m_proto=p;
5940 if (p)
5941 {
5942 setDeclFile(df,line,column);
5943 }
5944 else
5945 {
5946 setDefFile(df,line,column);
5947 }
5948}

References m_proto, setDeclFile(), and DefinitionMixin< MemberDefMutable >::setDefFile().

◆ setReadAccessor()

void MemberDefImpl::setReadAccessor ( const QCString & r)
overridevirtual

Implements MemberDefMutable.

Definition at line 5878 of file memberdef.cpp.

5879{
5880 m_read=r;
5881}

References m_read.

◆ setRedefineCount()

void MemberDefImpl::setRedefineCount ( int count)
overridevirtual

Implements MemberDefMutable.

Definition at line 6413 of file memberdef.cpp.

6414{
6415 m_redefineCount=count;
6416}

References m_redefineCount.

◆ setReimplements()

void MemberDefImpl::setReimplements ( MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 1570 of file memberdef.cpp.

1571{
1572 m_redefines = md;
1573}

References m_redefines.

◆ setRelatedAlso()

void MemberDefImpl::setRelatedAlso ( ClassDef * cd)
overridevirtual

Implements MemberDefMutable.

Definition at line 5915 of file memberdef.cpp.

5916{
5917 m_relatedAlso=cd;
5918}

References m_relatedAlso.

◆ setRequiresClause()

void MemberDefImpl::setRequiresClause ( const QCString & req)
overridevirtual

Implements MemberDefMutable.

Definition at line 6061 of file memberdef.cpp.

6062{
6063 m_requiresClause = req;
6064}

References m_requiresClause.

◆ setSectionList()

void MemberDefImpl::setSectionList ( const Definition * container,
const MemberList * sl )
overridevirtual

Implements MemberDefMutable.

Definition at line 4577 of file memberdef.cpp.

4578{
4579 //printf("MemberDefImpl::setSectionList(%s,%p) name=%s\n",qPrint(d->name()),sl,qPrint(name()));
4580 m_sectionMap.emplace(container,sl);
4581}

References m_sectionMap.

◆ setTagInfo()

void MemberDefImpl::setTagInfo ( const TagInfo * i)
overridevirtual

Implements MemberDefMutable.

Definition at line 5008 of file memberdef.cpp.

5009{
5010 if (ti)
5011 {
5012 //printf("%s: Setting tag name=%s anchor=%s\n",qPrint(name()),qPrint(ti->tagName),qPrint(ti->anchor));
5013 m_anc=ti->anchor;
5014 setReference(ti->tagName);
5016 }
5017}
void setReference(const QCString &r) override
QCString stripExtension(const QCString &fName)
Definition util.cpp:5440

References TagInfo::anchor, TagInfo::fileName, m_anc, m_explicitOutputFileBase, DefinitionMixin< MemberDefMutable >::setReference(), stripExtension(), and TagInfo::tagName.

◆ setTemplateMaster()

void MemberDefImpl::setTemplateMaster ( const MemberDef * mt)
overridevirtual

Implements MemberDefMutable.

Definition at line 5995 of file memberdef.cpp.

5996{
5999}

References m_isLinkableCached, and m_templateMaster.

◆ setTemplateSpecialization()

void MemberDefImpl::setTemplateSpecialization ( bool b)
overridevirtual

Implements MemberDefMutable.

Definition at line 5888 of file memberdef.cpp.

5889{
5890 m_tspec=b;
5891}

References m_tspec.

◆ setType()

void MemberDefImpl::setType ( const QCString & t)
overridevirtual

Implements MemberDefMutable.

Definition at line 4909 of file memberdef.cpp.

4910{
4911 m_type = t;
4912}

References m_type.

◆ setTypeConstraints()

void MemberDefImpl::setTypeConstraints ( const ArgumentList & al)
overridevirtual

Implements MemberDefMutable.

Definition at line 4904 of file memberdef.cpp.

4905{
4906 m_typeConstraints = al;
4907}

References m_typeConstraints.

◆ setVhdlSpecifiers()

void MemberDefImpl::setVhdlSpecifiers ( VhdlSpecifier s)
overridevirtual

Implements MemberDefMutable.

Definition at line 5838 of file memberdef.cpp.

5839{
5840 m_vhdlSpec=s;
5841}

References m_vhdlSpec.

◆ setWriteAccessor()

void MemberDefImpl::setWriteAccessor ( const QCString & w)
overridevirtual

Implements MemberDefMutable.

Definition at line 5883 of file memberdef.cpp.

5884{
5885 m_write=w;
5886}

References m_write.

◆ sourceRefName()

QCString MemberDefImpl::sourceRefName ( ) const
overridevirtual

Implements MemberDef.

Definition at line 1636 of file memberdef.cpp.

1637{
1638 QCString n = name();
1639 QCString s = getScopeString();
1640
1641 if (!s.isEmpty())
1642 {
1643 n.prepend(s+"::");
1644 }
1645 else if (isStatic() && getFileDef())
1646 {
1647 n.prepend(getFileDef()->name()+":");
1648 }
1649 if (isCallable())
1650 {
1651 n.append(argsString());
1652 }
1653 return n;
1654}
bool isCallable() const override
QCString getScopeString() const override

References QCString::append(), argsString(), getFileDef(), getScopeString(), isCallable(), QCString::isEmpty(), isStatic(), DefinitionMixin< MemberDefMutable >::name(), and QCString::prepend().

◆ templateArguments()

const ArgumentList & MemberDefImpl::templateArguments ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5653 of file memberdef.cpp.

5654{
5655 return m_tArgList;
5656}

References m_tArgList.

◆ templateMaster()

const MemberDef * MemberDefImpl::templateMaster ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5734 of file memberdef.cpp.

5735{
5736 return m_templateMaster;
5737}

References m_templateMaster.

Referenced by _computeLinkableInProject(), getOutputFileBase(), and getReference().

◆ typeConstraints()

const ArgumentList & MemberDefImpl::typeConstraints ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6340 of file memberdef.cpp.

6341{
6342 return m_typeConstraints;
6343}

References m_typeConstraints.

◆ typeString()

QCString MemberDefImpl::typeString ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5051 of file memberdef.cpp.

5052{
5053 return m_type;
5054}

References m_type.

Referenced by _computeIsDestructor(), warnIfUndocumentedParams(), and writeTagFile().

◆ virtualness()

Specifier MemberDefImpl::virtualness ( int count = 0) const
overridevirtual

Implements MemberDef.

Definition at line 4583 of file memberdef.cpp.

4584{
4585 if (count>25)
4586 {
4588 "Internal inconsistency: recursion detected in overload relation for member {}!",name());
4589 return Specifier::Normal;
4590 }
4591 Specifier v = m_virt;
4592 const MemberDef *rmd = reimplements();
4593 while (rmd && v==Specifier::Normal)
4594 {
4595 v = rmd->virtualness(count+1)==Specifier::Normal ? Specifier::Normal : Specifier::Virtual;
4596 rmd = rmd->reimplements();
4597 }
4598 return v;
4599}
virtual const MemberDef * reimplements() const =0

References DefinitionMixin< MemberDefMutable >::getDefFileName(), DefinitionMixin< MemberDefMutable >::getDefLine(), m_virt, DefinitionMixin< MemberDefMutable >::name(), MemberDef::reimplements(), reimplements(), MemberDef::virtualness(), and warn.

Referenced by getLabels().

◆ visibleInIndex()

bool MemberDefImpl::visibleInIndex ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4165 of file memberdef.cpp.

4166{
4167 bool hideUndocMembers = Config_getBool(HIDE_UNDOC_MEMBERS);
4168 bool extractStatic = Config_getBool(EXTRACT_STATIC);
4169 return (!isAnonymous() &&
4170 (!hideUndocMembers || hasDocumentation()) &&
4171 (!isStatic() || extractStatic) &&
4172 isLinkable()
4173 );
4174}

References Config_getBool, hasDocumentation(), DefinitionMixin< MemberDefMutable >::isAnonymous(), isLinkable(), and isStatic().

◆ warnIfUndocumented()

void MemberDefImpl::warnIfUndocumented ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4093 of file memberdef.cpp.

4094{
4095 /*
4096 * Removed bug_303020:
4097 * if (m_memberGroup) return;
4098 */
4099 const ClassDef *cd = getClassDef();
4100 const NamespaceDef *nd = getNamespaceDef();
4101 const FileDef *fd = getFileDef();
4102 const GroupDef *gd = getGroupDef();
4103 const Definition *d=nullptr;
4104 QCString t;
4105 if (cd)
4106 {
4107 t=cd->compoundTypeString();
4108 d=cd;
4109 }
4110 else if (nd)
4111 {
4112 t=nd->compoundTypeString();
4113 d=nd;
4114 }
4115 else if (gd)
4116 {
4117 t="group";
4118 d=gd;
4119 }
4120 else
4121 {
4122 t="file";
4123 d=fd;
4124 }
4125 bool extractAll = Config_getBool(EXTRACT_ALL);
4126
4127 //printf("%s:warnIfUndoc: hasUserDocs=%d isFriendClass=%d protection=%d isRef=%d isDel=%d\n",
4128 // qPrint(name()),
4129 // hasUserDocumentation(),isFriendClass(),protectionLevelVisible(m_prot),isReference(),isDeleted());
4130 if ((!hasUserDocumentation() && !extractAll) &&
4131 !isFriendClass() &&
4132 name().find('@')==-1 && d && d->name().find('@')==-1 &&
4135 !isReference() && !isDeleted()
4136 )
4137 {
4138 SrcLangExt lang = getLanguage();
4139 QCString sep = getLanguageSpecificSeparator(lang,TRUE);
4140 warn_undoc(getDefFileName(),getDefLine(),"Member {}{} ({}) of {} {} is not documented.",
4142 substitute(d->name(),"::",sep));
4143 }
4144 else if (!hasDetailedDescription())
4145 {
4147 }
4148
4149 // if it is an enum, we check that its members are documented
4150 if (!extractAll && isEnumerate() && Config_getBool(WARN_IF_UNDOC_ENUM_VAL))
4151 {
4152 for (const auto &fmd : enumFieldList())
4153 {
4154 if (!fmd->isLinkableInProject())
4155 {
4156 SrcLangExt lang = getLanguage();
4157 QCString sep = getLanguageSpecificSeparator(lang,TRUE);
4158 warn(fmd->getDefFileName(),fmd->getDefLine(), "Documentation for enum member '{}{}{}' is missing.",
4159 qualifiedName(),sep,fmd->name());
4160 }
4161 }
4162 }
4163}
virtual QCString compoundTypeString() const =0
Returns the type of compound as a string.
void warnIfUndocumentedParams() const override
QCString memberTypeName() const override
bool hasUserDocumentation() const override
bool _isAnonymousBitField() const
bool isDeleted() const override
virtual QCString compoundTypeString() const =0
#define warn_undoc(file, line, fmt,...)
Definition message.h:102

References _isAnonymousBitField(), argsString(), ClassDef::compoundTypeString(), NamespaceDef::compoundTypeString(), Config_getBool, enumFieldList(), QCString::find(), getClassDef(), DefinitionMixin< MemberDefMutable >::getDefFileName(), DefinitionMixin< MemberDefMutable >::getDefLine(), getFileDef(), getGroupDef(), DefinitionMixin< MemberDefMutable >::getLanguage(), getLanguageSpecificSeparator(), getNamespaceDef(), hasDetailedDescription(), hasUserDocumentation(), isDeleted(), isEnumerate(), isFriendClass(), isReference(), m_prot, memberTypeName(), Definition::name(), DefinitionMixin< MemberDefMutable >::name(), protectionLevelVisible(), qualifiedName(), substitute(), TRUE, warn, warn_undoc, and warnIfUndocumentedParams().

Referenced by writeDeclaration().

◆ warnIfUndocumentedParams()

void MemberDefImpl::warnIfUndocumentedParams ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4255 of file memberdef.cpp.

4256{
4257 QCString returnType = typeString();
4258 bool isFortran = getLanguage()==SrcLangExt::Fortran;
4259 bool isFortranSubroutine = isFortran && returnType.find("subroutine")!=-1;
4260
4261 bool isVoidReturn = returnType=="void" || returnType.endsWith(" void");
4262 if (!isVoidReturn && (returnType=="auto" || returnType.endsWith(" auto")))
4263 {
4264 const ArgumentList &defArgList=isDocsForDefinition() ? argumentList() : declArgumentList();
4265 if (!defArgList.trailingReturnType().isEmpty())
4266 {
4267 QCString strippedTrailingReturn = stripTrailingReturn(defArgList.trailingReturnType());
4268 isVoidReturn = (strippedTrailingReturn=="void") || (strippedTrailingReturn.endsWith(" void"));
4269 }
4270 }
4271 if (!Config_getBool(EXTRACT_ALL) &&
4272 Config_getBool(WARN_IF_UNDOCUMENTED) &&
4273 Config_getBool(WARN_NO_PARAMDOC) &&
4274 isFunction() &&
4275 !isDeleted() &&
4276 !isReference() &&
4278 {
4280 {
4282 "parameters of member {} are not documented",
4283 qualifiedName());
4284 }
4286 hasDocumentation() && !returnType.isEmpty() &&
4287 !( // not one of the cases where nothing is returned
4288 isVoidReturn || // void return type
4289 isFortranSubroutine || // fortran subroutine
4290 isConstructor() || // a constructor
4291 isDestructor() // or destructor
4292 )
4293 )
4294 {
4296 "return type of member {} is not documented",
4297 qualifiedName());
4298 }
4299 }
4300 if (Config_getBool(WARN_IF_DOC_ERROR) &&
4302 (isVoidReturn || // void return type
4303 isFortranSubroutine || // fortran subroutine
4304 isConstructor() || // a constructor
4305 isDestructor())) // or destructor
4306 {
4307 warn_doc_error(docFile(),docLine(),"found documented return type for {} that does not return anything",
4308 qualifiedName());
4309 }
4310}
QCString trailingReturnType() const
Definition arguments.h:114
static bool suppressDocWarnings
Definition doxygen.h:132
bool isDocsForDefinition() const override
bool endsWith(const char *s) const
Definition qcstring.h:509
#define warn_doc_error(file, line, fmt,...)
Definition message.h:112

References argumentList(), Config_getBool, declArgumentList(), DefinitionMixin< MemberDefMutable >::docFile(), DefinitionMixin< MemberDefMutable >::docLine(), QCString::endsWith(), QCString::find(), DefinitionMixin< MemberDefMutable >::getLanguage(), hasDocumentation(), isConstructor(), isDeleted(), isDestructor(), isDocsForDefinition(), QCString::isEmpty(), isFunction(), isReference(), m_hasDocumentedParams, m_hasDocumentedReturnType, qualifiedName(), stripTrailingReturn(), Doxygen::suppressDocWarnings, ArgumentList::trailingReturnType(), typeString(), and warn_doc_error.

Referenced by warnIfUndocumented(), and writeDocumentation().

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

Definition at line 2218 of file memberdef.cpp.

2221{
2222 //printf("> %s MemberDefImpl::writeDeclaration() inGroup=%d inheritId=%s\n",qPrint(qualifiedName()),inGroup,qPrint(inheritId));
2223
2224 // hide enum value, since they appear already as part of the enum, unless they
2225 // are explicitly grouped.
2226 if (!inGroup && m_mtype==MemberType::EnumValue) return;
2227
2228 const Definition *d=nullptr;
2229 ASSERT (cd!=nullptr || nd!=nullptr || fd!=nullptr || gd!=nullptr || mod!=nullptr); // member should belong to something
2230 if (cd) d=cd;
2231 else if (nd) d=nd;
2232 else if (fd) d=fd;
2233 else d=gd;
2234 if (d==gd || d==mod) // see bug 753608
2235 {
2236 if (getClassDef()) d = getClassDef();
2237 else if (getNamespaceDef()) d = getNamespaceDef();
2238 else if (getFileDef()) d = getFileDef();
2239 }
2240 else if (d==fd) // see issue #9850, namespace member can be shown in file scope as well
2241 {
2242 if (getNamespaceDef()) d = getNamespaceDef();
2243 }
2244 if (d==nullptr)
2245 {
2246 err("No context could be derived for member '{}'\n",name());
2247 return; // should not happen
2248 }
2249
2250 QCString cname = d->name();
2251 QCString cdname = d->displayName();
2252 QCString cfname = getOutputFileBase();
2253
2254 // search for the last anonymous scope in the member type
2255 ClassDef *annoClassDef=getClassDefOfAnonymousType();
2256
2258
2259 // start a new member declaration
2260 bool isAnonType = annoClassDef || m_annMemb || m_annEnumType;
2264 ol.startMemberItem(annoClassDef ? QCString() : anchor(), anonType, inheritId);
2265
2266
2267 // If there is no detailed description we need to write the anchor here.
2268 bool detailsVisible = hasDetailedDescription();
2269 bool writeAnchor = (inGroup || getGroupDef()==nullptr) && // only write anchors for member that have no details and are
2270 !detailsVisible && !m_annMemb && // rendered inside the group page or are not grouped at all
2271 inheritId.isEmpty();
2272
2273 if (writeAnchor)
2274 {
2275 QCString doxyArgs=argsString();
2276 QCString doxyName=name();
2277 if (!cname.isEmpty())
2278 {
2280 }
2281 ol.startDoxyAnchor(cfname,cname,anchor(),doxyName,doxyArgs);
2282 ol.addLabel(cfname,anchor());
2283 }
2284
2285 if (!detailsVisible)
2286 {
2287 ol.pushGeneratorState();
2291 ol.docify("\n");
2292 ol.popGeneratorState();
2293 }
2294
2295 if (annoClassDef || m_annMemb)
2296 {
2297 for (int j=0;j<indentLevel;j++)
2298 {
2300 }
2301 }
2302
2303 // *** write template lists
2304 if (m_tArgList.hasParameters() && getLanguage()==SrcLangExt::Cpp)
2305 {
2306 if (!isAnonType) ol.startMemberTemplateParams();
2308 if (!isAnonType) ol.endMemberTemplateParams(anchor(),inheritId);
2309 }
2310
2311
2312 // *** write type
2313 QCString ltype(m_type);
2314 if (isTypedef() && getLanguage() != SrcLangExt::Slice)
2315 {
2316 ltype.prepend("typedef ");
2317 }
2318 if (isTypeAlias())
2319 {
2320 ltype="using";
2321 }
2322 // strip 'friend' keyword from ltype
2323 ltype.stripPrefix("friend ");
2324 static const reg::Ex r(R"(@\d+)");
2325 reg::Match match;
2326 std::string stype = ltype.str();
2327 bool endAnonScopeNeeded=FALSE;
2328 if (reg::search(stype,match,r)) // member has an anonymous type
2329 {
2330 int i = static_cast<int>(match.position());
2331 int l = static_cast<int>(match.length());
2332 //printf("annoClassDef=%p annMemb=%p scopeName='%s' anonymous='%s'\n",
2333 // annoClassDef,annMemb,qPrint(cname),qPrint(ltype.mid(i,l)));
2334
2335 if (annoClassDef) // type is an anonymous compound
2336 {
2337 int ir=i+l;
2338 //printf("<<<<<<<<<<<<<<\n");
2339 ol.startAnonTypeScope(indentLevel);
2340 annoClassDef->writeDeclaration(ol,m_annMemb,inGroup,indentLevel+1,inheritedFrom,inheritId);
2341 //printf(">>>>>>>>>>>>>> startMemberItem(2)\n");
2343 ol.startMemberItem(anchor(),anonType,inheritId);
2344 for (int j=0;j< indentLevel;j++)
2345 {
2347 }
2348 QCString varName=ltype.right(ltype.length()-ir).stripWhiteSpace();
2349 //printf(">>>>>> ltype='%s' varName='%s'\n",qPrint(ltype),qPrint(varName));
2350 ol.docify("}");
2351 if (varName.isEmpty() && isAnonymous())
2352 {
2353 ol.docify(";");
2354 }
2355 else if (!varName.isEmpty() && (varName.at(0)=='*' || varName.at(0)=='&'))
2356 {
2357 ol.docify(" ");
2358 ol.docify(varName);
2359 }
2360 endAnonScopeNeeded=TRUE;
2361 }
2362 else
2363 {
2364 if (getAnonymousEnumType()) // type is an anonymous enum
2365 {
2366 linkifyText(TextGeneratorOLImpl(ol), // out
2367 d, // scope
2368 getBodyDef(), // fileScope
2369 this, // self
2370 ltype.left(i), // text
2371 FALSE // autoBreak
2372 );
2373 getAnonymousEnumType()->writeEnumDeclaration(ol,cd,nd,fd,gd,mod);
2374 //ol+=*getAnonymousEnumType()->enumDecl();
2375 linkifyText(TextGeneratorOLImpl(ol),d,getFileDef(),this,ltype.right(ltype.length()-i-l),TRUE);
2376 }
2377 else
2378 {
2379 ltype = ltype.left(i) + " { ... } " + removeAnonymousScopes(ltype.right(ltype.length()-i-l));
2380 linkifyText(TextGeneratorOLImpl(ol), // out
2381 d, // scope
2382 getBodyDef(), // fileScope
2383 this, // self
2384 ltype, // text
2385 FALSE // autoBreak
2386 );
2387 }
2388 }
2389 }
2390 else if (ltype=="@") // rename type from enum values
2391 {
2392 ltype="";
2393 }
2394 else
2395 {
2396 if (isObjCMethod())
2397 {
2398 ltype.prepend("(");
2399 ltype.append(")");
2400 }
2401 linkifyText(TextGeneratorOLImpl(ol), // out
2402 d, // scope
2403 getBodyDef(), // fileScope
2404 this, // self
2405 ltype, // text
2406 FALSE // autoBreak
2407 );
2408 }
2409 bool htmlOn = ol.isEnabled(OutputType::Html);
2410 if (htmlOn && !ltype.isEmpty())
2411 {
2413 }
2414 if (!ltype.isEmpty()) ol.docify(" ");
2415 if (htmlOn)
2416 {
2418 }
2419
2420 if (m_annMemb)
2421 {
2422 ol.pushGeneratorState();
2425 ol.popGeneratorState();
2426 }
2427 else
2428 {
2429 ol.insertMemberAlign(m_tArgList.hasParameters());
2430 }
2431
2432 // *** write name
2433 if (!isAnonymous() && !_isAnonymousBitField()) // hide anonymous stuff
2434 {
2435 bool extractPrivateVirtual = Config_getBool(EXTRACT_PRIV_VIRTUAL);
2436 bool extractStatic = Config_getBool(EXTRACT_STATIC);
2437 MemberDefMutable *annMemb = toMemberDefMutable(m_annMemb);
2438 bool visibleIfPrivate = (protectionLevelVisible(protection()) ||
2440 (m_prot==Protection::Private &&
2441 (m_virt!=Specifier::Normal || isOverride() || isFinal()) &&
2442 extractPrivateVirtual && hasDocumentation()
2443 ));
2444 //printf("Member name=`%s gd=%p md->groupDef=%p inGroup=%d isLinkable()=%d hasDocumentation=%d\n",qPrint(name()),gd,getGroupDef(),inGroup,isLinkable(),hasDocumentation());
2445 if (!name().isEmpty() && // name valid
2446 (hasDetailedDescription() || isReference()) && // has docs
2447 visibleIfPrivate &&
2448 !(isStatic() && getClassDef()==nullptr && !extractStatic) // hidden due to static-ness
2449 )
2450 {
2451 if (annMemb)
2452 {
2453 //printf("anchor=%s ann_anchor=%s\n",anchor(),annMemb->anchor());
2454 annMemb->writeLink(ol,
2455 annMemb->getClassDef(),
2456 annMemb->getNamespaceDef(),
2457 annMemb->getFileDef(),
2458 annMemb->getGroupDef(),
2459 annMemb->getModuleDef());
2460 }
2461 else
2462 {
2463 //printf("writeLink %s->%d\n",qPrint(name),hasDocumentation());
2464 const ClassDef *rcd = cd;
2465 if (isReference() && getClassDef()) rcd = getClassDef();
2466 writeLink(ol,rcd,nd,fd,gd,mod);
2467 }
2468 }
2469 else if (isDocumentedFriendClass())
2470 // if the member is an undocumented friend declaration for some class,
2471 // then maybe we can link to the class
2472 {
2473 writeLink(ol,getClass(name()),nullptr,nullptr,nullptr,nullptr);
2474 }
2475 else
2476 // there is a brief member description and brief member
2477 // descriptions are enabled or there is no detailed description.
2478 {
2479 const ClassDef *rcd = cd;
2480 if (isReference() && getClassDef()) rcd = getClassDef();
2481 writeLink(ol,rcd,nd,fd,gd,mod,TRUE);
2482 }
2483 }
2484
2485 // *** write arguments
2486 if (!argsString().isEmpty() && !isObjCMethod())
2487 {
2488 if (!isDefine() && !isTypedef()) ol.writeString(" ");
2489 linkifyText(TextGeneratorOLImpl(ol), // out
2490 d, // scope
2491 getBodyDef(), // fileScope
2492 this, // self
2493 isDefine() ?
2494 substitute(argsString(),",",", ") :
2495 isTypedef() ?
2496 substitute(argsString(),")(",") (") :
2498 m_annMemb!=nullptr, // autoBreak
2499 TRUE, // external
2500 FALSE, // keepSpaces
2501 indentLevel
2502 );
2503 }
2504
2505 // *** write bitfields
2506 if (!m_bitfields.isEmpty()) // add bitfields
2507 {
2508 linkifyText(TextGeneratorOLImpl(ol),d,getBodyDef(),this,m_bitfields);
2509 }
2510 else if (hasOneLineInitializer()
2511 //!init.isEmpty() && initLines==0 && // one line initializer
2512 //((maxInitLines>0 && userInitLines==-1) || userInitLines>0) // enabled by default or explicitly
2513 ) // add initializer
2514 {
2515 if (isTypeAlias()) // using statement
2516 {
2517 ol.writeString(" = ");
2518 linkifyText(TextGeneratorOLImpl(ol),d,getBodyDef(),this,m_initializer.simplifyWhiteSpace());
2519 }
2520 else if (!isDefine())
2521 {
2522 //ol.writeString(" = ");
2523 ol.writeString(" ");
2524 linkifyText(TextGeneratorOLImpl(ol),d,getBodyDef(),this,m_initializer.simplifyWhiteSpace());
2525 }
2526 else
2527 {
2529 linkifyText(TextGeneratorOLImpl(ol),d,getBodyDef(),this,m_initializer);
2530 }
2531 }
2532
2533
2535 {
2536 ol.startTypewriter();
2537 ol.docify(" [implementation]");
2538 ol.endTypewriter();
2539 }
2540
2541 bool extractPrivate = Config_getBool(EXTRACT_PRIVATE);
2542
2543 if (isProperty() && (isSettable() || isGettable() ||
2546 {
2547 ol.writeLatexSpacing();
2548 ol.startTypewriter();
2549 ol.docify(" [");
2550 StringVector sl;
2551
2552 if (isGettable()) sl.emplace_back("get");
2553 if (isProtectedGettable()) sl.emplace_back("protected get");
2554 if (isSettable()) sl.emplace_back("set");
2555 if (isProtectedSettable()) sl.emplace_back("protected set");
2556 if (extractPrivate)
2557 {
2558 if (isPrivateGettable()) sl.emplace_back("private get");
2559 if (isPrivateSettable()) sl.emplace_back("private set");
2560 }
2561 bool first=true;
2562 for (const auto &s : sl)
2563 {
2564 if (!first)
2565 {
2566 ol.docify(", ");
2567 }
2568 first=false;
2569 ol.docify(s.c_str());
2570 }
2571 ol.docify("]");
2572 ol.endTypewriter();
2573 }
2574
2575 if (isEvent() && (isAddable() || isRemovable() || isRaisable()))
2576 {
2577 ol.writeLatexSpacing();
2578 ol.startTypewriter();
2579 ol.docify(" [");
2580 StringVector sl;
2581 if (isAddable()) sl.emplace_back("add");
2582 if (isRemovable()) sl.emplace_back("remove");
2583 if (isRaisable()) sl.emplace_back("raise");
2584 bool first=true;
2585 for (const auto &s : sl)
2586 {
2587 if (!first)
2588 {
2589 ol.docify(", ");
2590 }
2591 first=false;
2592 ol.docify(s.c_str());
2593 }
2594 ol.docify("]");
2595 ol.endTypewriter();
2596 }
2597
2598 if (writeAnchor)
2599 {
2600 ol.endDoxyAnchor(cfname,anchor());
2601 }
2602
2603 //printf("endMember %s annoClassDef=%p annEnumType=%p\n",
2604 // qPrint(name()),annoClassDef,annEnumType);
2605 ol.endMemberItem(anonType);
2606 if (endAnonScopeNeeded)
2607 {
2608 ol.endAnonTypeScope(indentLevel);
2609 }
2610
2611 // write brief description
2612 if (!briefDescription().isEmpty() &&
2613 Config_getBool(BRIEF_MEMBER_DESC)
2614 )
2615 {
2616 auto parser { createDocParser() };
2617 auto ast { validatingParseDoc(*parser.get(),
2618 briefFile(),briefLine(),
2621 QCString(),TRUE,FALSE) };
2622 if (!ast->isEmpty())
2623 {
2624 ol.startMemberDescription(anchor(),inheritId);
2625 ol.writeDoc(ast.get(),getOuterScope()?getOuterScope():d,this);
2626 if (detailsVisible) // add More.. link only when both brief and details are visible
2627 {
2628 if (!isAnonymous()) // hide anonymous stuff
2629 {
2630 ol.pushGeneratorState();
2632 ol.docify(" ");
2633 MemberDefMutable *annMemb = toMemberDefMutable(m_annMemb);
2634 if (annMemb)
2635 {
2636 ol.startTextLink(annMemb->getOutputFileBase(),annMemb->anchor());
2638 ol.endTextLink();
2639 }
2640 ol.popGeneratorState();
2641 }
2642 }
2643 // for RTF we need to add an extra empty paragraph
2644 ol.pushGeneratorState();
2646 ol.startParagraph();
2647 ol.endParagraph();
2648 ol.popGeneratorState();
2650 }
2651 }
2652
2653 ol.endMemberDeclaration(anchor(),inheritId);
2654
2656 //printf("< %s MemberDefImpl::writeDeclaration() inGroup=%d\n",qPrint(qualifiedName()),inGroup);
2657}
virtual void writeDeclaration(OutputList &ol, const MemberDef *md, bool inGroup, int indentLevel, const ClassDef *inheritedFrom, const QCString &inheritId) const =0
virtual SrcLangExt getLanguage() const =0
Returns the programming language this definition was written in.
virtual void writeEnumDeclaration(OutputList &typeDecl, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod) const =0
virtual const FileDef * getFileDef() const =0
virtual const ModuleDef * getModuleDef() const =0
virtual const NamespaceDef * getNamespaceDef() const =0
virtual void writeLink(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *md, bool onlyText=FALSE) const =0
void warnIfUndocumented() const override
bool isDefine() const override
ClassDef * getClassDefOfAnonymousType() const override
QCString excpString() const override
void _writeTemplatePrefix(OutputList &ol, const Definition *def, const ArgumentList &al, bool writeReqClause=true) const
const MemberDef * getAnonymousEnumType() const override
bool hasOneLineInitializer() const override
bool isEvent() const 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
bool isEnabled(OutputType o)
void startMemberDeclaration()
Definition outputlist.h:571
void endMemberTemplateParams(const QCString &anchor, const QCString &inheritId)
Definition outputlist.h:501
void writeLatexSpacing()
Definition outputlist.h:547
void enable(OutputType o)
void endMemberDescription()
Definition outputlist.h:569
void writeDoc(const IDocNodeAST *ast, const Definition *ctx, const MemberDef *md)
Definition outputlist.h:385
void startMemberDescription(const QCString &anchor, const QCString &inheritId=QCString(), bool typ=false)
Definition outputlist.h:567
void startAnonTypeScope(int i1)
Definition outputlist.h:491
void endTextLink()
Definition outputlist.h:446
void endMemberItem(OutputGenerator::MemberItemType type)
Definition outputlist.h:497
void pushGeneratorState()
void insertMemberAlign(bool templ=FALSE)
Definition outputlist.h:519
void popGeneratorState()
void endAnonTypeScope(int i1)
Definition outputlist.h:493
void endMemberDeclaration(const QCString &anchor, const QCString &inheritId)
Definition outputlist.h:573
void startMemberItem(const QCString &anchor, OutputGenerator::MemberItemType type, const QCString &id=QCString())
Definition outputlist.h:495
void writeNonBreakableSpace(int num)
Definition outputlist.h:628
void startTextLink(const QCString &file, const QCString &anchor)
Definition outputlist.h:444
void startMemberTemplateParams()
Definition outputlist.h:499
virtual QCString trMore()=0
IDocNodeASTPtr validatingParseDoc(IDocParser &parserIntf, const QCString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const QCString &input, bool indexWords, bool isExample, const QCString &exampleName, bool singleLine, bool linkFromIndex, bool markdownSupport, bool autolinkSupport)
IDocParserPtr createDocParser()
factory function to create a parser
Definition docparser.cpp:55
static QCString combineArgsAndException(QCString args, QCString exception)

References _isAnonymousBitField(), _writeTemplatePrefix(), OutputList::addLabel(), Definition::anchor(), anchor(), OutputGenerator::AnonymousEnd, OutputGenerator::AnonymousStart, QCString::append(), argsString(), ASSERT, QCString::at(), briefDescription(), DefinitionMixin< MemberDefMutable >::briefFile(), DefinitionMixin< MemberDefMutable >::briefLine(), combineArgsAndException(), Config_getBool, createDocParser(), OutputList::disable(), OutputList::disableAllBut(), Definition::displayName(), Docbook, OutputList::docify(), OutputList::enable(), OutputList::endAnonTypeScope(), OutputList::endDoxyAnchor(), OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberItem(), OutputList::endMemberTemplateParams(), OutputList::endParagraph(), OutputList::endTextLink(), OutputList::endTypewriter(), EnumValue, err, excpString(), FALSE, Friend, getAnonymousEnumType(), DefinitionMixin< MemberDefMutable >::getBodyDef(), getClass(), MemberDef::getClassDef(), getClassDef(), getClassDefOfAnonymousType(), MemberDef::getFileDef(), getFileDef(), MemberDef::getGroupDef(), getGroupDef(), DefinitionMixin< MemberDefMutable >::getLanguage(), getLanguageSpecificSeparator(), MemberDef::getModuleDef(), MemberDef::getNamespaceDef(), getNamespaceDef(), DefinitionMixin< MemberDefMutable >::getOuterScope(), Definition::getOutputFileBase(), getOutputFileBase(), hasDetailedDescription(), hasDocumentation(), hasOneLineInitializer(), Html, OutputList::insertMemberAlign(), isAddable(), DefinitionMixin< MemberDefMutable >::isAnonymous(), isDefine(), isDocumentedFriendClass(), QCString::isEmpty(), OutputList::isEnabled(), isEvent(), isFinal(), isGettable(), isImplementation(), isObjCMethod(), isObjCProperty(), isOverride(), isPrivateGettable(), isPrivateSettable(), isProperty(), isProtectedGettable(), isProtectedSettable(), isRaisable(), isReference(), isRemovable(), isSettable(), isStatic(), isTypeAlias(), isTypedef(), Latex, QCString::left(), QCString::length(), linkifyText(), m_annEnumType, m_annMemb, m_bitfields, m_initializer, m_mtype, m_prot, m_tArgList, m_type, m_virt, Man, Definition::name(), DefinitionMixin< MemberDefMutable >::name(), OutputGenerator::Normal, OutputList::parseText(), OutputList::popGeneratorState(), QCString::prepend(), protection(), protectionLevelVisible(), OutputList::pushGeneratorState(), removeAnonymousScopes(), QCString::right(), RTF, reg::search(), OutputList::startAnonTypeScope(), OutputList::startDoxyAnchor(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberItem(), OutputList::startMemberTemplateParams(), OutputList::startParagraph(), OutputList::startTextLink(), OutputList::startTypewriter(), QCString::str(), QCString::stripPrefix(), QCString::stripWhiteSpace(), substitute(), OutputGenerator::Templated, theTranslator, toMemberDefMutable(), TRUE, validatingParseDoc(), warnIfUndocumented(), ClassDef::writeDeclaration(), OutputList::writeDoc(), MemberDef::writeEnumDeclaration(), OutputList::writeLatexSpacing(), MemberDef::writeLink(), writeLink(), OutputList::writeNonBreakableSpace(), and OutputList::writeString().

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

Definition at line 3443 of file memberdef.cpp.

3452{
3453 // if this member is in a group find the real scope name.
3454 bool hasParameterList = FALSE;
3455
3456 //printf("MemberDefImpl::writeDocumentation(): name='%s' hasDocs='%d' containerType=%d inGroup=%d sectionLinkable=%d\n",
3457 // qPrint(name()),hasDocs,container->definitionType(),inGroup,hasDetailedDescription());
3458
3459 //if ( !hasDocs ) return;
3460 //if (isEnumValue() && !showEnumValues) return;
3461
3462 SrcLangExt lang = getLanguage();
3463 //printf("member=%s lang=%d\n",qPrint(name()),lang);
3464 bool optVhdl = lang==SrcLangExt::VHDL;
3465 QCString sep = getLanguageSpecificSeparator(lang,TRUE);
3466
3467 QCString scopeName = scName;
3468 QCString memAnchor = anchor();
3469 QCString ciname = container->displayName();
3470 const Definition *scopedContainer = container; // see bug 753608
3471 if (container->definitionType()==TypeGroup)
3472 {
3473 if (getClassDef()) { scopeName=getClassDef()->displayName(); scopedContainer=getClassDef(); }
3474 else if (getNamespaceDef()) { scopeName=getNamespaceDef()->displayName(); scopedContainer=getNamespaceDef(); }
3475 else if (getFileDef()) { scopeName=getFileDef()->displayName(); scopedContainer=getFileDef(); }
3476 ciname = (toGroupDef(container))->groupTitle();
3477 }
3478 else if (container->definitionType()==TypeFile && getNamespaceDef() && getNamespaceDef()->isLinkable())
3479 { // member is in a namespace, but is written as part of the file documentation
3480 // as well, so we need to make sure its anchor is unique (it is not really used).
3481 memAnchor.prepend("file_");
3482 }
3483
3484 QCString cname = container->name();
3485 QCString cfname = getOutputFileBase();
3486
3487 // get member name
3488 QCString doxyName=name();
3489 // prepend scope if there is any. TODO: make this optional for C only docs
3490 if (!scopeName.isEmpty())
3491 {
3492 doxyName.prepend(scopeName+sep);
3493 }
3494 QCString doxyArgs=argsString();
3495
3496 QCString ldef = definition();
3497 QCString title = name();
3498 //printf("member '%s' def='%s'\n",qPrint(name()),qPrint(ldef));
3499 if (isEnumerate())
3500 {
3501 if (title.at(0)=='@')
3502 {
3503 ldef = title = "anonymous enum";
3504 if (!m_enumBaseType.isEmpty())
3505 {
3506 ldef+=" : "+m_enumBaseType;
3507 }
3508 }
3509 else
3510 {
3511 if (lang==SrcLangExt::Cpp)
3512 {
3513 if (isEnumStruct()) ldef.prepend("struct ");
3514 else if (isStrong()) ldef.prepend("class ");
3515 }
3516 ldef.prepend("enum ");
3517 if (isSliceLocal())
3518 {
3519 ldef.prepend("local ");
3520 }
3521 }
3522 }
3523 else if (isEnumValue())
3524 {
3525 if (ldef.at(0)=='@')
3526 {
3527 ldef=ldef.mid(2);
3528 }
3529 }
3530 else if (isFunction() && !isObjCMethod())
3531 {
3532 title += "()";
3533 }
3534 if (lang == SrcLangExt::Slice)
3535 {
3536 // Remove the container scope from the member name.
3537 QCString prefix = scName + sep;
3538 int pos = ldef.findRev(prefix.data());
3539 if(pos != -1)
3540 {
3541 ldef.remove(pos, prefix.length());
3542 }
3543 }
3544 ldef.stripPrefix("constexpr ");
3545 ldef.stripPrefix("consteval ");
3546 ldef.stripPrefix("constinit ");
3547 ldef.stripPrefix("static ");
3548
3549 //----------------------------------------
3550
3551 ol.pushGeneratorState();
3552
3553 bool htmlEndLabelTable=FALSE;
3554 StringVector sl = getLabels(scopedContainer);
3555
3556 static const reg::Ex r(R"(@\d+)");
3557 reg::Match match;
3558 std::string sdef = ldef.str();
3559 if ((isVariable() || isTypedef()) && reg::search(sdef,match,r))
3560 {
3561 // find enum type and insert it in the definition
3562 bool found=false;
3563 for (const auto &vmd : *ml)
3564 {
3565 if (vmd->isEnumerate() && match.str()==vmd->name())
3566 {
3567 ol.startDoxyAnchor(cfname, cname, memAnchor, doxyName, doxyArgs);
3568 ol.startMemberDoc(ciname,name(),memAnchor,name(),memCount,memTotal,showInline);
3569 ol.addLabel(cfname, memAnchor);
3570 std::string prefix = match.prefix().str();
3571 std::string suffix = match.suffix().str();
3572 linkifyText(TextGeneratorOLImpl(ol),scopedContainer,getBodyDef(),this,prefix.c_str());
3573 vmd->writeEnumDeclaration(ol,getClassDef(),getNamespaceDef(),getFileDef(),getGroupDef(),getModuleDef());
3574 linkifyText(TextGeneratorOLImpl(ol),scopedContainer,getBodyDef(),this,suffix.c_str());
3575
3576 found=true;
3577 break;
3578 }
3579 }
3580 if (!found) // anonymous compound
3581 {
3582 ClassDef *annoClassDef=getClassDefOfAnonymousType();
3583 QCString typeName;
3584 if (annoClassDef) typeName=annoClassDef->compoundTypeString();
3585 ol.startDoxyAnchor(cfname, cname, memAnchor, doxyName, doxyArgs);
3586 ol.startMemberDoc(ciname,name(),memAnchor,"["+typeName+"]",memCount,memTotal,showInline);
3587 ol.addLabel(cfname, memAnchor);
3588 // search for the last anonymous compound name in the definition
3589
3591 if (reg::search(sdef,match,reAnonymous))
3592 {
3593 std::string prefix = match.prefix().str();
3594 std::string suffix = match.suffix().str();
3595 ol.docify(prefix.c_str());
3596 ol.docify(" { ... } ");
3597 linkifyText(TextGeneratorOLImpl(ol),scopedContainer,getBodyDef(),this,removeAnonymousScopes(suffix.c_str()));
3598 }
3599 else
3600 {
3601 linkifyText(TextGeneratorOLImpl(ol),scopedContainer,getBodyDef(),this,ldef);
3602 }
3603 }
3604 }
3605 else // not an enum value or anonymous compound
3606 {
3607 ol.startDoxyAnchor(cfname, cname, memAnchor, doxyName, doxyArgs);
3608 ol.startMemberDoc(ciname,name(),memAnchor,title,memCount,memTotal,showInline);
3609 ol.addLabel(cfname, memAnchor);
3610
3611 if (!m_metaData.isEmpty() && getLanguage()==SrcLangExt::Slice)
3612 {
3614 ol.docify(m_metaData);
3616 }
3617
3618 const ClassDef *cd=getClassDef();
3619 const NamespaceDef *nd=getNamespaceDef();
3620 if (!m_defTmpArgLists.empty() && lang==SrcLangExt::Cpp)
3621 // definition has explicit template parameter declarations
3622 {
3623 for (const ArgumentList &tal : m_defTmpArgLists)
3624 {
3625 if (!tal.empty())
3626 {
3628 _writeTemplatePrefix(ol,scopedContainer,tal);
3630 }
3631 }
3632 }
3633 else // definition gets it template parameters from its class
3634 // (since no definition was found)
3635 {
3636 if (cd && lang==SrcLangExt::Cpp && !isTemplateSpecialization())
3637 {
3638 for (const ArgumentList &tal : cd->getTemplateParameterLists())
3639 {
3640 if (!tal.empty())
3641 {
3643 _writeTemplatePrefix(ol,scopedContainer,tal,false);
3645 }
3646 }
3647 }
3648 if (m_tArgList.hasParameters() && lang==SrcLangExt::Cpp) // function template prefix
3649 {
3651 _writeTemplatePrefix(ol,scopedContainer,m_tArgList);
3653 }
3654 }
3655
3656 if (!sl.empty())
3657 {
3658 ol.pushGeneratorState();
3659 ol.disableAll();
3661 ol.writeString("<table class=\"mlabels\">\n");
3662 ol.writeString(" <tr>\n");
3663 ol.writeString(" <td class=\"mlabels-left\">\n");
3664 ol.popGeneratorState();
3665 htmlEndLabelTable=TRUE;
3666 }
3667
3669 if (cd && cd->isObjectiveC())
3670 {
3671 // strip scope name
3672 int ep = ldef.find("::");
3673 if (ep!=-1)
3674 {
3675 int sp=ldef.findRev(' ',ep);
3676 if (sp!=-1)
3677 {
3678 ldef=ldef.left(sp+1)+ldef.mid(ep+2);
3679 } else {
3680 ldef=ldef.mid(ep+2);
3681 }
3682 }
3683 // strip keywords
3684 int dp = ldef.find(':');
3685 if (dp!=-1)
3686 {
3687 ldef=ldef.left(dp+1);
3688 }
3689 int dl=static_cast<int>(ldef.length());
3690 //printf("start >%s<\n",qPrint(ldef));
3691 int i=dl-1;
3692 while (i>=0 && (isId(ldef.at(i)) || ldef.at(i)==':')) i--;
3693 while (i>=0 && isspace(static_cast<uint8_t>(ldef.at(i)))) i--;
3694 if (i>0)
3695 {
3696 // insert branches around the type
3697 ldef="("+ldef.left(i+1)+")"+ldef.mid(i+1);
3698 }
3699 //printf("end >%s< i=%d\n",qPrint(ldef),i);
3700 if (isStatic()) ldef.prepend("+ "); else ldef.prepend("- ");
3701 }
3702
3703 if (optVhdl)
3704 {
3705 hasParameterList=VhdlDocGen::writeVHDLTypeDocumentation(this,scopedContainer,ol);
3706 }
3707 else if (lang==SrcLangExt::Slice)
3708 {
3709 // Eliminate the self-reference.
3710 int pos = ldef.findRev(' ');
3711 if (pos<0) pos=0;
3712 if (pos>0)
3713 {
3714 linkifyText(TextGeneratorOLImpl(ol),
3715 scopedContainer,
3716 getBodyDef(),
3717 this,
3718 ldef.left(pos)
3719 );
3720 }
3721 ol.docify(ldef.mid(pos));
3722 const Definition *scope = cd;
3723 if (scope==nullptr) scope = nd;
3724 hasParameterList=writeDefArgumentList(ol,scope,this);
3725 }
3726 else
3727 {
3728 linkifyText(TextGeneratorOLImpl(ol),
3729 scopedContainer,
3730 getBodyDef(),
3731 this,
3732 substitute(ldef,"::",sep)
3733 );
3734 const Definition *scope = cd;
3735 if (scope==nullptr) scope = nd;
3736 hasParameterList=writeDefArgumentList(ol,scope,this);
3737 }
3738
3739 if (hasOneLineInitializer()) // add initializer
3740 {
3741 if (isTypeAlias())
3742 {
3743 ol.docify(" = ");
3744 QCString init = m_initializer.simplifyWhiteSpace();
3745 linkifyText(TextGeneratorOLImpl(ol),scopedContainer,getBodyDef(),this,init);
3746 }
3747 else if (!isDefine())
3748 {
3749 ol.docify(" ");
3750 QCString init = m_initializer.simplifyWhiteSpace();
3751 linkifyText(TextGeneratorOLImpl(ol),scopedContainer,getBodyDef(),this,init);
3752 }
3753 else
3754 {
3756 linkifyText(TextGeneratorOLImpl(ol),scopedContainer,getBodyDef(),this,m_initializer);
3757 }
3758 }
3759 if (!excpString().isEmpty()) // add exception list
3760 {
3761 writeExceptionList(ol,cd,this);
3762 hasParameterList=true; // call endParameterList below
3763 }
3764 }
3765
3766 ol.pushGeneratorState();
3768 if (!sl.empty())
3769 {
3770 ol.startLabels();
3771 size_t count=0;
3772 for (const auto &s : sl)
3773 {
3774 count++;
3775 ol.writeLabel(s.c_str(),count==sl.size());
3776 }
3777 ol.endLabels();
3778 }
3779 ol.popGeneratorState();
3780
3781 if (hasParameterList)
3782 {
3783 ol.endParameterList();
3784 ol.endMemberDoc(TRUE);
3785 }
3786 else
3787 {
3788 ol.endMemberDocName();
3789 ol.endMemberDoc(FALSE);
3790 }
3791
3792 // for HTML write the labels here
3793 ol.pushGeneratorState();
3794 ol.disableAll();
3796 if (htmlEndLabelTable)
3797 {
3798 ol.writeString(" </td>\n");
3799 ol.writeString(" <td class=\"mlabels-right\">\n");
3800 ol.startLabels();
3801 size_t count=0;
3802 for (const auto &s : sl)
3803 {
3804 count++;
3805 ol.writeLabel(s.c_str(),count==sl.size());
3806 }
3807 ol.endLabels();
3808 ol.writeString(" </td>\n");
3809 ol.writeString(" </tr>\n");
3810 ol.writeString("</table>\n");
3811 }
3812 ol.writeString("</div>");
3813 ol.popGeneratorState();
3814
3815
3816 ol.endDoxyAnchor(cfname,memAnchor);
3817 ol.startIndent();
3818
3819 _writeGroupInclude(ol,inGroup);
3820
3821 /* write multi-line initializer (if any) */
3823
3824 /* write brief description */
3825 QCString brief = briefDescription();
3826 if (!brief.isEmpty() &&
3827 (Config_getBool(REPEAT_BRIEF) ||
3828 !Config_getBool(BRIEF_MEMBER_DESC)
3829 )
3830 )
3831 {
3832 ol.startParagraph();
3834 scopedContainer,this,
3835 brief,FALSE,FALSE,
3836 QCString(),TRUE,FALSE);
3837 ol.endParagraph();
3838 }
3839
3840 /* write detailed description */
3841 QCString detailed = documentation();
3842 if (!detailed.isEmpty() ||
3843 !inbodyDocumentation().isEmpty())
3844 {
3845 // write vhdl inline code with or without option INLINE_SOURCE
3846 if (optVhdl && VhdlDocGen::isMisc(this))
3847 {
3848 VhdlDocGen::writeSource(this,ol,cname);
3849 return;
3850 }
3851 else
3852 {
3853 ol.generateDoc(docFile(),docLine(),scopedContainer,this,detailed+"\n",TRUE,FALSE,
3854 QCString(),FALSE,FALSE);
3855 }
3856
3857 if (!inbodyDocumentation().isEmpty())
3858 {
3860 scopedContainer,this,
3862 QCString(),FALSE,FALSE);
3863 }
3864 }
3865 else if (!brief.isEmpty() && (Config_getBool(REPEAT_BRIEF) || !Config_getBool(BRIEF_MEMBER_DESC)))
3866 {
3867 if (!inbodyDocumentation().isEmpty())
3868 {
3869 ol.generateDoc(inbodyFile(),inbodyLine(),scopedContainer,this,inbodyDocumentation()+"\n",TRUE,FALSE,
3870 QCString(),FALSE,FALSE);
3871 }
3872 }
3873
3874
3875 //printf("***** defArgList=%p name=%s docs=%s hasDocs=%d\n",
3876 // defArgList,
3877 // defArgList?defArgList->hasDocumentation():-1);
3878 const ArgumentList &docArgList = m_templateMaster ?
3879 m_templateMaster->argumentList() :
3881 ol.generateDoc(
3882 docFile(),docLine(),
3883 scopedContainer,
3884 this, // memberDef
3885 inlineArgListToDoc(docArgList), // docStr
3886 TRUE, // indexWords
3887 FALSE, // isExample
3888 QCString(),FALSE,FALSE
3889 );
3890
3891 const ArgumentList &docTemplateArgList = m_templateMaster ?
3892 m_templateMaster->templateArguments() :
3893 m_tArgList;
3894 ol.generateDoc(
3895 docFile(),docLine(),
3896 scopedContainer,
3897 this, // memberDef
3898 inlineTemplateArgListToDoc(docTemplateArgList), // docStr
3899 TRUE, // indexWords
3900 FALSE, // isExample
3901 QCString(),FALSE,FALSE
3902 );
3903
3904 _writeEnumValues(ol,scopedContainer,cfname,ciname,cname);
3908 _writeExamples(ol);
3910 QCString scopeStr = getScopeString();
3911 writeSourceDef(ol);
3912 writeInlineCode(ol,scopeStr);
3913 if (hasReferencesRelation()) writeSourceRefs(ol,scopeStr);
3914 if (hasReferencedByRelation()) writeSourceReffedBy(ol,scopeStr);
3915 _writeCallGraph(ol);
3917
3918 ol.endIndent();
3919
3920 // enable LaTeX again
3921 //if (Config_getBool(EXTRACT_ALL) && !hasDocs) ol.enable(OutputType::Latex);
3922 ol.popGeneratorState();
3923
3925}
constexpr auto prefix
Definition anchor.cpp:44
virtual ArgumentLists getTemplateParameterLists() const =0
Returns the template parameter lists that form the template declaration of this class.
virtual QCString inbodyDocumentation() const =0
void writeSourceDef(OutputList &ol) const override
QCString inbodyFile() const override
void writeSourceRefs(OutputList &ol, const QCString &scopeName) const override
QCString briefFile() const override
void writeSourceReffedBy(OutputList &ol, const QCString &scopeName) const override
void writeInlineCode(OutputList &ol, const QCString &scopeName) const override
void _writeCallerGraph(OutputList &ol) const
void _writeEnumValues(OutputList &ol, const Definition *container, const QCString &cfname, const QCString &ciname, const QCString &cname) const
void _writeTypeConstraints(OutputList &ol) const
void _writeExamples(OutputList &ol) const
void _writeReimplementedBy(OutputList &ol) const
StringVector getLabels(const Definition *container) const override
void _writeCategoryRelation(OutputList &ol) const
bool isTemplateSpecialization() const override
void _writeMultiLineInitializer(OutputList &ol, const QCString &scopeName) const
void _writeReimplements(OutputList &ol) const
void _writeGroupInclude(OutputList &ol, bool inGroup) const
bool isVariable() const override
void _writeCallGraph(OutputList &ol) const
void endIndent()
Definition outputlist.h:586
void startMemberDoc(const QCString &clName, const QCString &memName, const QCString &anchor, const QCString &title, int memCount, int memTotal, bool showInline)
Definition outputlist.h:533
void startMemberDocName(bool align)
Definition outputlist.h:682
void endMemberDocName()
Definition outputlist.h:684
void endMemberDoc(bool hasArgs)
Definition outputlist.h:537
void startIndent()
Definition outputlist.h:584
void disableAll()
void endMemberDocPrefixItem()
Definition outputlist.h:680
void endLabels()
Definition outputlist.h:744
void endParameterList()
Definition outputlist.h:704
void writeLabel(const QCString &l, bool isLast)
Definition outputlist.h:742
void startLabels()
Definition outputlist.h:740
void startMemberDocPrefixItem()
Definition outputlist.h:678
QCString & remove(size_t index, size_t len)
Definition qcstring.h:427
bool stripPrefix(const QCString &prefix)
Definition qcstring.h:198
static bool writeVHDLTypeDocumentation(const MemberDef *mdef, const Definition *d, OutputList &ol)
static void writeSource(const MemberDef *mdef, OutputList &ol, const QCString &cname)
static bool isMisc(const MemberDef *mdef)
GroupDef * toGroupDef(Definition *d)
static void writeExceptionList(OutputList &ol, const ClassDef *cd, const MemberDef *md)
static bool writeDefArgumentList(OutputList &ol, const Definition *scope, const MemberDef *md)
QCString inlineTemplateArgListToDoc(const ArgumentList &al)
Definition util.cpp:1175
QCString inlineArgListToDoc(const ArgumentList &al)
Definition util.cpp:1157

References _writeCallerGraph(), _writeCallGraph(), _writeCategoryRelation(), _writeEnumValues(), _writeExamples(), _writeGroupInclude(), _writeMultiLineInitializer(), _writeReimplementedBy(), _writeReimplements(), _writeTemplatePrefix(), _writeTypeConstraints(), OutputList::addLabel(), anchor(), argsString(), QCString::at(), briefDescription(), DefinitionMixin< MemberDefMutable >::briefFile(), DefinitionMixin< MemberDefMutable >::briefLine(), ClassDef::compoundTypeString(), Config_getBool, definition(), Definition::definitionType(), OutputList::disable(), OutputList::disableAll(), Definition::displayName(), DefinitionMixin< MemberDefMutable >::docFile(), OutputList::docify(), DefinitionMixin< MemberDefMutable >::docLine(), documentation(), ArgumentList::empty(), OutputList::enable(), OutputList::endDoxyAnchor(), OutputList::endIndent(), OutputList::endLabels(), OutputList::endMemberDoc(), OutputList::endMemberDocName(), OutputList::endMemberDocPrefixItem(), OutputList::endParagraph(), OutputList::endParameterList(), excpString(), FALSE, QCString::find(), QCString::findRev(), OutputList::generateDoc(), DefinitionMixin< MemberDefMutable >::getBodyDef(), getClassDef(), getClassDefOfAnonymousType(), getFileDef(), getGroupDef(), getLabels(), DefinitionMixin< MemberDefMutable >::getLanguage(), getLanguageSpecificSeparator(), getModuleDef(), getNamespaceDef(), getOutputFileBase(), getScopeString(), ClassDef::getTemplateParameterLists(), hasMultiLineInitializer(), hasOneLineInitializer(), hasReferencedByRelation(), hasReferencesRelation(), Html, DefinitionMixin< MemberDefMutable >::inbodyDocumentation(), DefinitionMixin< MemberDefMutable >::inbodyFile(), DefinitionMixin< MemberDefMutable >::inbodyLine(), init(), inlineArgListToDoc(), inlineTemplateArgListToDoc(), isDefine(), QCString::isEmpty(), isEnumerate(), isEnumStruct(), isEnumValue(), isFunction(), isId(), isLinkable(), VhdlDocGen::isMisc(), isObjCMethod(), ClassDef::isObjectiveC(), isSliceLocal(), isStatic(), isStrong(), isTemplateSpecialization(), isTypeAlias(), isTypedef(), isVariable(), QCString::left(), QCString::length(), linkifyText(), m_defArgList, m_defTmpArgLists, m_enumBaseType, m_initializer, m_metaData, m_tArgList, m_templateMaster, QCString::mid(), Definition::name(), DefinitionMixin< MemberDefMutable >::name(), OutputList::popGeneratorState(), prefix, QCString::prepend(), OutputList::pushGeneratorState(), reAnonymous, QCString::remove(), removeAnonymousScopes(), reg::search(), OutputList::startDoxyAnchor(), OutputList::startIndent(), OutputList::startLabels(), OutputList::startMemberDoc(), OutputList::startMemberDocName(), OutputList::startMemberDocPrefixItem(), OutputList::startParagraph(), QCString::str(), QCString::stripPrefix(), substitute(), toGroupDef(), TRUE, Definition::TypeFile, Definition::TypeGroup, warnIfUndocumentedParams(), writeDefArgumentList(), writeExceptionList(), DefinitionMixin< MemberDefMutable >::writeInlineCode(), OutputList::writeLabel(), OutputList::writeNonBreakableSpace(), VhdlDocGen::writeSource(), DefinitionMixin< MemberDefMutable >::writeSourceDef(), DefinitionMixin< MemberDefMutable >::writeSourceReffedBy(), DefinitionMixin< MemberDefMutable >::writeSourceRefs(), OutputList::writeString(), and VhdlDocGen::writeVHDLTypeDocumentation().

◆ writeEnumDeclaration()

void MemberDefImpl::writeEnumDeclaration ( OutputList & typeDecl,
const ClassDef * cd,
const NamespaceDef * nd,
const FileDef * fd,
const GroupDef * gd,
const ModuleDef * mod ) const
overridevirtual

Implements MemberDef.

Definition at line 4769 of file memberdef.cpp.

4771{
4772 int enumMemCount=0;
4773
4774 uint32_t numVisibleEnumValues=0;
4775 for (const auto &fmd : m_enumFields)
4776 {
4777 if (fmd->isBriefSectionVisible()) numVisibleEnumValues++;
4778 }
4779 if (numVisibleEnumValues==0 && !isBriefSectionVisible())
4780 {
4781 return;
4782 }
4783
4784 QCString n = name();
4785 int i=n.findRev("::");
4786 if (i!=-1) n=n.right(n.length()-i-2); // strip scope (TODO: is this needed?)
4787 if (n[0]!='@') // not an anonymous enum
4788 {
4790 {
4791 //_writeTagData(compoundType);
4792 writeLink(typeDecl,cd,nd,fd,gd,mod);
4793 }
4794 else
4795 {
4796 typeDecl.startBold();
4797 typeDecl.docify(n);
4798 typeDecl.endBold();
4799 }
4800 typeDecl.writeChar(' ');
4801 }
4802 if (!m_enumBaseType.isEmpty())
4803 {
4804 typeDecl.writeChar(':');
4805 typeDecl.writeChar(' ');
4806 typeDecl.docify(m_enumBaseType);
4807 typeDecl.writeChar(' ');
4808 }
4809
4810 uint32_t enumValuesPerLine = static_cast<uint32_t>(Config_getInt(ENUM_VALUES_PER_LINE));
4811 if (numVisibleEnumValues>0 && enumValuesPerLine>0)
4812 {
4813 typeDecl.docify("{ ");
4814
4815 auto it = m_enumFields.begin();
4816 if (it!=m_enumFields.end())
4817 {
4818 const MemberDef *fmd=*it;
4819 bool fmdVisible = fmd->isBriefSectionVisible();
4820 bool first=true;
4821 while (fmd)
4822 {
4823 if (fmdVisible)
4824 {
4825 if (!first)
4826 {
4827 typeDecl.writeString(", ");
4828 }
4829 /* in html we start a new line after a number of items */
4830 if (numVisibleEnumValues>enumValuesPerLine
4831 && (enumMemCount%enumValuesPerLine)==0
4832 )
4833 {
4834 typeDecl.pushGeneratorState();
4836 typeDecl.enable(OutputType::Latex);
4837 typeDecl.enable(OutputType::Docbook);
4838 typeDecl.lineBreak();
4839 typeDecl.disable(OutputType::Latex);
4840 typeDecl.disable(OutputType::Docbook);
4841 typeDecl.writeString("&#160;&#160;");
4842 typeDecl.popGeneratorState();
4843 }
4844
4845 if (fmd->hasDocumentation()) // enum value has docs
4846 {
4847 fmd->writeLink(typeDecl,cd,nd,fd,gd,mod);
4848 }
4849 else // no docs for this enum value
4850 {
4851 typeDecl.startBold();
4852 typeDecl.docify(fmd->name());
4853 typeDecl.endBold();
4854 }
4855 if (fmd->hasOneLineInitializer()) // enum value has initializer
4856 {
4857 //typeDecl.writeString(" = ");
4858 typeDecl.writeString(" ");
4859 typeDecl.parseText(fmd->initializer());
4860 }
4861 first=false;
4862 }
4863
4864 bool prevVisible = fmdVisible;
4865 ++it;
4866 if (it!=m_enumFields.end())
4867 {
4868 fmd=*it;
4869 }
4870 else
4871 {
4872 fmd=nullptr;
4873 }
4874 if (prevVisible)
4875 {
4876 typeDecl.disable(OutputType::Man);
4877 typeDecl.writeString("\n"); // to prevent too long lines in LaTeX
4878 typeDecl.enable(OutputType::Man);
4879 enumMemCount++;
4880 }
4881 }
4882 if (numVisibleEnumValues>enumValuesPerLine)
4883 {
4884 typeDecl.pushGeneratorState();
4886 typeDecl.lineBreak();
4887 typeDecl.popGeneratorState();
4888 }
4889 }
4890 typeDecl.docify(" }");
4891 }
4892}
virtual bool hasDocumentation() const =0
virtual bool hasOneLineInitializer() const =0
virtual bool isBriefSectionVisible() const =0
virtual const QCString & initializer() const =0
bool isBriefSectionVisible() const override
void writeChar(char c)
Definition outputlist.h:531

References Config_getInt, OutputList::disable(), OutputList::disableAllBut(), Docbook, OutputList::docify(), OutputList::enable(), OutputList::endBold(), QCString::findRev(), Definition::hasDocumentation(), hasDocumentedEnumValues(), MemberDef::hasOneLineInitializer(), Html, MemberDef::initializer(), MemberDef::isBriefSectionVisible(), isBriefSectionVisible(), isLinkableInProject(), Latex, QCString::length(), OutputList::lineBreak(), m_enumBaseType, m_enumFields, Man, Definition::name(), DefinitionMixin< MemberDefMutable >::name(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), QCString::right(), OutputList::startBold(), OutputList::writeChar(), MemberDef::writeLink(), writeLink(), and OutputList::writeString().

◆ writeLink()

void MemberDefImpl::writeLink ( OutputList & ol,
const ClassDef * cd,
const NamespaceDef * nd,
const FileDef * fd,
const GroupDef * gd,
const ModuleDef * mod,
bool onlyText = FALSE ) const
overridevirtual

Implements MemberDef.

Definition at line 1918 of file memberdef.cpp.

1921{
1922 SrcLangExt lang = getLanguage();
1923 bool hideScopeNames = Config_getBool(HIDE_SCOPE_NAMES);
1924 QCString sep = getLanguageSpecificSeparator(lang,TRUE);
1925 QCString n = name();
1926 const ClassDef *classDef = getClassDef();
1927 const ModuleDef *moduleDef = getModuleDef();
1928 const NamespaceDef *nspace = getNamespaceDef();
1929 if (!hideScopeNames)
1930 {
1931 if (m_enumScope && m_livesInsideEnum && getGroupDef()!=nullptr)
1932 {
1933 n.prepend(m_enumScope->displayName()+sep);
1934 }
1935 if (classDef && gd && !isRelated())
1936 {
1937 n.prepend(classDef->displayName()+sep);
1938 }
1939 else if (nspace && (gd || fd || moduleDef))
1940 {
1941 n.prepend(nspace->displayName()+sep);
1942 }
1943 }
1944
1945 if (isObjCMethod())
1946 {
1947 if (isStatic()) ol.docify("+ "); else ol.docify("- ");
1948 }
1949 if (!onlyText && (isLinkable() || hasDetailedDescription())) // write link
1950 {
1951 if (m_mtype==MemberType::EnumValue && getGroupDef()==nullptr && // enum value is not grouped
1952 getEnumScope() && getEnumScope()->getGroupDef()) // but its container is
1953 {
1954 const GroupDef *enumValGroup = getEnumScope()->getGroupDef();
1955 ol.writeObjectLink(enumValGroup->getReference(),
1956 enumValGroup->getOutputFileBase(),
1957 anchor(),n);
1958 }
1959 else
1960 {
1962 }
1963 }
1964 else // write only text
1965 {
1966 ol.startBold();
1967 ol.docify(n);
1968 ol.endBold();
1969 }
1970}

References anchor(), Config_getBool, Definition::displayName(), OutputList::docify(), OutputList::endBold(), EnumValue, getClassDef(), getEnumScope(), MemberDef::getGroupDef(), getGroupDef(), DefinitionMixin< MemberDefMutable >::getLanguage(), getLanguageSpecificSeparator(), getModuleDef(), getNamespaceDef(), Definition::getOutputFileBase(), getOutputFileBase(), Definition::getReference(), getReference(), hasDetailedDescription(), isLinkable(), isObjCMethod(), isRelated(), isStatic(), m_enumScope, m_livesInsideEnum, m_mtype, DefinitionMixin< MemberDefMutable >::name(), QCString::prepend(), OutputList::startBold(), TRUE, and OutputList::writeObjectLink().

Referenced by writeDeclaration(), and writeEnumDeclaration().

◆ writeMemberDocSimple()

void MemberDefImpl::writeMemberDocSimple ( OutputList & ol,
const Definition * container ) const
overridevirtual

Implements MemberDefMutable.

Definition at line 3957 of file memberdef.cpp.

3958{
3959 Definition *scope = getOuterScope();
3960 QCString doxyName = name();
3961 QCString doxyArgs = argsString();
3962 QCString memAnchor = anchor();
3963 QCString cfname = getOutputFileBase();
3964 QCString cname;
3965 if (scope) cname = scope->name();
3966 if (doxyName.at(0)=='@')
3967 {
3968 doxyName="__unnamed__";
3969 }
3970
3971 ClassDef *cd = m_accessorClass;
3972 //printf("===> %s::anonymous: %s\n",qPrint(name()),cd?qPrint(cd->name()):"<none>");
3973
3974 if (container && container->definitionType()==Definition::TypeClass &&
3975 !(toClassDef(container))->isJavaEnum())
3976 {
3978 ol.startDoxyAnchor(cfname,cname,memAnchor,doxyName,doxyArgs);
3979 ol.addLabel(cfname,memAnchor);
3980
3981 QCString ts = fieldType();
3982
3983 if (isFunctionPtr())
3984 ts = m_type + m_args;
3985
3986 if (cd) // cd points to an anonymous struct pointed to by this member
3987 // so we add a link to it from the type column.
3988 {
3989 int i=0;
3990 const char *prefixes[] = { "struct ","union ","class ", nullptr };
3991 const char **p = prefixes;
3992 while (*p)
3993 {
3994 int l=qstrlen(*p);
3995 if (ts.left(l)==*p)
3996 {
3997 ol.writeString(*p);
3998 i=l;
3999 }
4000 p++;
4001 }
4003 cd->getOutputFileBase(),
4004 cd->anchor(),ts.mid(i));
4005 }
4006 else // use standard auto linking
4007 {
4008 linkifyText(TextGeneratorOLImpl(ol), // out
4009 scope, // scope
4010 getBodyDef(), // fileScope
4011 this, // self
4012 ts // text
4013 );
4014 }
4015 ol.endDoxyAnchor(cfname,memAnchor);
4017 }
4018
4020 ol.docify(doxyName);
4021 if (isVariable() && !argsString().isEmpty() && !isObjCMethod() && !isFunctionPtr())
4022 {
4023 linkifyText(TextGeneratorOLImpl(ol),getOuterScope(),getBodyDef(),this,argsString());
4024 }
4025 if (!m_bitfields.isEmpty()) // add bitfields
4026 {
4027 linkifyText(TextGeneratorOLImpl(ol),getOuterScope(),getBodyDef(),this,m_bitfields);
4028 }
4029 if (hasOneLineInitializer() && !isDefine())
4030 {
4031 ol.writeString(" ");
4032 linkifyText(TextGeneratorOLImpl(ol),getOuterScope(),getBodyDef(),this,m_initializer.simplifyWhiteSpace());
4033 }
4035
4037
4038 QCString brief = briefDescription();
4039 QCString detailed = documentation();
4040
4041 /* write brief description */
4042 if (!brief.isEmpty())
4043 {
4045 getOuterScope()?getOuterScope():container,this,
4046 brief,FALSE,FALSE,
4047 QCString(),TRUE,FALSE);
4048 }
4049
4050 /* write detailed description */
4051 if (!detailed.isEmpty())
4052 {
4053 if (!brief.isEmpty())
4054 {
4056 ol.lineBreak();
4058 }
4060 getOuterScope()?getOuterScope():container,this,
4061 detailed+"\n",FALSE,FALSE,
4062 QCString(),FALSE,FALSE);
4063
4064 }
4065
4066 ol.endInlineMemberDoc();
4067}
QCString fieldType() const override
bool isFunctionPtr() const override
void endInlineMemberType()
Definition outputlist.h:730
void startInlineMemberType()
Definition outputlist.h:728
void startInlineMemberDoc()
Definition outputlist.h:736
void endInlineMemberDoc()
Definition outputlist.h:738
void startInlineMemberName()
Definition outputlist.h:732
void endInlineMemberName()
Definition outputlist.h:734
uint32_t qstrlen(const char *str)
Returns the length of string str, or 0 if a null pointer is passed.
Definition qcstring.h:58

References OutputList::addLabel(), Definition::anchor(), anchor(), argsString(), QCString::at(), briefDescription(), DefinitionMixin< MemberDefMutable >::briefFile(), DefinitionMixin< MemberDefMutable >::briefLine(), Definition::definitionType(), OutputList::disable(), DefinitionMixin< MemberDefMutable >::docFile(), OutputList::docify(), DefinitionMixin< MemberDefMutable >::docLine(), documentation(), OutputList::enable(), OutputList::endDoxyAnchor(), OutputList::endInlineMemberDoc(), OutputList::endInlineMemberName(), OutputList::endInlineMemberType(), FALSE, fieldType(), OutputList::generateDoc(), DefinitionMixin< MemberDefMutable >::getBodyDef(), DefinitionMixin< MemberDefMutable >::getOuterScope(), Definition::getOutputFileBase(), getOutputFileBase(), Definition::getReference(), hasOneLineInitializer(), Html, isDefine(), QCString::isEmpty(), isFunctionPtr(), isObjCMethod(), isVariable(), QCString::left(), OutputList::lineBreak(), linkifyText(), m_accessorClass, m_args, m_bitfields, m_initializer, m_type, QCString::mid(), Definition::name(), DefinitionMixin< MemberDefMutable >::name(), qstrlen(), OutputList::startDoxyAnchor(), OutputList::startInlineMemberDoc(), OutputList::startInlineMemberName(), OutputList::startInlineMemberType(), toClassDef(), TRUE, Definition::TypeClass, OutputList::writeObjectLink(), and OutputList::writeString().

◆ writeTagFile()

void MemberDefImpl::writeTagFile ( TextStream & tagFile,
bool useQualifiedName,
bool showNamespaceMembers ) const
overridevirtual

Implements MemberDefMutable.

Definition at line 4601 of file memberdef.cpp.

4602{
4603 if (!isLinkableInProject()) return;
4604 if (!showNamespaceMembers && getNamespaceDef()) return;
4605 tagFile << " <member kind=\"";
4606 switch (m_mtype)
4607 {
4608 case MemberType::Define: tagFile << "define"; break;
4609 case MemberType::EnumValue: tagFile << "enumvalue"; break;
4610 case MemberType::Property: tagFile << "property"; break;
4611 case MemberType::Event: tagFile << "event"; break;
4612 case MemberType::Variable: tagFile << "variable"; break;
4613 case MemberType::Typedef: tagFile << "typedef"; break;
4614 case MemberType::Enumeration: tagFile << "enumeration"; break;
4615 case MemberType::Function: tagFile << "function"; break;
4616 case MemberType::Signal: tagFile << "signal"; break;
4617 case MemberType::Friend: tagFile << "friend"; break;
4618 case MemberType::DCOP: tagFile << "dcop"; break;
4619 case MemberType::Slot: tagFile << "slot"; break;
4620 case MemberType::Interface: tagFile << "interface"; break;
4621 case MemberType::Service: tagFile << "service"; break;
4622 case MemberType::Sequence: tagFile << "sequence"; break;
4623 case MemberType::Dictionary: tagFile << "dictionary"; break;
4624 }
4625 if (m_prot!=Protection::Public)
4626 {
4627 tagFile << "\" protection=\"";
4628 if (m_prot==Protection::Protected) tagFile << "protected";
4629 else if (m_prot==Protection::Package) tagFile << "package";
4630 else /* Private */ tagFile << "private";
4631 }
4632 if (m_virt!=Specifier::Normal)
4633 {
4634 tagFile << "\" virtualness=\"";
4635 if (m_virt==Specifier::Virtual) tagFile << "virtual";
4636 else /* Pure */ tagFile << "pure";
4637 }
4638 if (isStatic())
4639 {
4640 tagFile << "\" static=\"yes";
4641 }
4642 tagFile << "\">\n";
4643 if (typeString()!=QCString("@"))
4644 {
4645 tagFile << " <type>" << convertToXML(typeString()) << "</type>\n";
4646 }
4647 QCString fn = getOutputFileBase();
4649 tagFile << " <name>" << convertToXML(useQualifiedName ? qualifiedName() : name()) << "</name>\n";
4650 tagFile << " <anchorfile>" << convertToXML(fn) << "</anchorfile>\n";
4651 tagFile << " <anchor>" << convertToXML(anchor()) << "</anchor>\n";
4652 QCString idStr = id();
4653 if (!idStr.isEmpty())
4654 {
4655 tagFile << " <clangid>" << convertToXML(idStr) << "</clangid>\n";
4656 }
4657 tagFile << " <arglist>" << convertToXML(argsString()) << "</arglist>\n";
4658 if (isStrong())
4659 {
4660 for (const auto &fmd : m_enumFields)
4661 {
4662 if (!fmd->isReference())
4663 {
4664 tagFile << " <enumvalue file=\"" << convertToXML(fn);
4665 tagFile << "\" anchor=\"" << convertToXML(fmd->anchor());
4666 idStr = fmd->id();
4667 if (!idStr.isEmpty())
4668 {
4669 tagFile << "\" clangid=\"" << convertToXML(idStr);
4670 }
4671 tagFile << "\">" << convertToXML(fmd->name()) << "</enumvalue>\n";
4672 }
4673 }
4674 }
4675 writeDocAnchorsToTagFile(tagFile);
4676 tagFile << " </member>\n";
4677}
void writeDocAnchorsToTagFile(TextStream &fs) const override
QCString convertToXML(const QCString &s, bool keepEntities)
Definition util.cpp:4428
void addHtmlExtensionIfMissing(QCString &fName)
Definition util.cpp:5418

References addHtmlExtensionIfMissing(), anchor(), argsString(), convertToXML(), DCOP, Define, Dictionary, Enumeration, EnumValue, Event, Friend, Function, getNamespaceDef(), getOutputFileBase(), DefinitionMixin< MemberDefMutable >::id(), Interface, QCString::isEmpty(), isLinkableInProject(), isStatic(), isStrong(), m_enumFields, m_mtype, m_prot, m_virt, DefinitionMixin< MemberDefMutable >::name(), Property, qualifiedName(), Sequence, Service, Signal, Slot, Typedef, typeString(), Variable, and DefinitionMixin< MemberDefMutable >::writeDocAnchorsToTagFile().

Member Data Documentation

◆ m_accessorClass

ClassDef* MemberDefImpl::m_accessorClass = nullptr
private

Definition at line 417 of file memberdef.cpp.

Referenced by accessorClass(), deepCopy(), init(), setAccessorType(), and writeMemberDocSimple().

◆ m_accessorType

QCString MemberDefImpl::m_accessorType
private

Definition at line 416 of file memberdef.cpp.

Referenced by deepCopy(), fieldType(), and setAccessorType().

◆ m_anc

QCString MemberDefImpl::m_anc
private

Definition at line 420 of file memberdef.cpp.

Referenced by anchor(), deepCopy(), setAnchor(), and setTagInfo().

◆ m_annEnumType

const MemberDef* MemberDefImpl::m_annEnumType = nullptr
private

◆ m_annMemb

MemberDef* MemberDefImpl::m_annMemb = nullptr
private

◆ m_annScope

bool MemberDefImpl::m_annScope = false
private

◆ m_args

QCString MemberDefImpl::m_args
private

◆ m_bitfields

QCString MemberDefImpl::m_bitfields
private

◆ m_cachedAnonymousType

ClassDef* MemberDefImpl::m_cachedAnonymousType = nullptr
mutableprivate

Definition at line 454 of file memberdef.cpp.

Referenced by deepCopy(), getClassDefOfAnonymousType(), and init().

◆ m_cachedResolvedType

QCString MemberDefImpl::m_cachedResolvedType
private

Definition at line 472 of file memberdef.cpp.

Referenced by cacheTypedefVal(), deepCopy(), and getCachedResolvedTypedef().

◆ m_cachedTypedefTemplSpec

QCString MemberDefImpl::m_cachedTypedefTemplSpec
private

Definition at line 471 of file memberdef.cpp.

Referenced by cacheTypedefVal(), deepCopy(), and getCachedTypedefTemplSpec().

◆ m_cachedTypedefValue

const ClassDef* MemberDefImpl::m_cachedTypedefValue = nullptr
private

Definition at line 470 of file memberdef.cpp.

Referenced by cacheTypedefVal(), deepCopy(), getCachedTypedefVal(), and init().

◆ m_category

ClassDef* MemberDefImpl::m_category = nullptr
private

Definition at line 510 of file memberdef.cpp.

Referenced by _writeCategoryRelation(), category(), deepCopy(), and setCategory().

◆ m_categoryRelation

const MemberDef* MemberDefImpl::m_categoryRelation = nullptr
private

◆ m_classDef

ClassDef* MemberDefImpl::m_classDef = nullptr
private

◆ m_decl

QCString MemberDefImpl::m_decl
private

Definition at line 423 of file memberdef.cpp.

Referenced by declaration(), deepCopy(), and init().

◆ m_declArgList

◆ m_declColumn

int MemberDefImpl::m_declColumn = -1
private

Definition at line 514 of file memberdef.cpp.

Referenced by deepCopy(), getDeclColumn(), and setDeclFile().

◆ m_declFileName

QCString MemberDefImpl::m_declFileName
private

Definition at line 512 of file memberdef.cpp.

Referenced by deepCopy(), getDeclFileName(), and setDeclFile().

◆ m_declLine

int MemberDefImpl::m_declLine = -1
private

Definition at line 513 of file memberdef.cpp.

Referenced by deepCopy(), getDeclLine(), and setDeclFile().

◆ m_def

QCString MemberDefImpl::m_def
private

Definition at line 419 of file memberdef.cpp.

Referenced by createTemplateInstanceMember(), deepCopy(), definition(), and setDefinition().

◆ m_defArgList

◆ m_defTmpArgLists

ArgumentLists MemberDefImpl::m_defTmpArgLists
private

◆ m_detailedDescriptionCachedValue

bool MemberDefImpl::m_detailedDescriptionCachedValue = false
mutableprivate

Definition at line 496 of file memberdef.cpp.

Referenced by deepCopy(), and hasDetailedDescription().

◆ m_docEnumValues

bool MemberDefImpl::m_docEnumValues = false
private

◆ m_docProvider

const MemberDef* MemberDefImpl::m_docProvider = nullptr
private

Definition at line 475 of file memberdef.cpp.

Referenced by deepCopy(), inheritsDocsFrom(), init(), and setInheritsDocsFrom().

◆ m_docsForDefinition

bool MemberDefImpl::m_docsForDefinition = false
private

Definition at line 507 of file memberdef.cpp.

Referenced by deepCopy(), init(), isDocsForDefinition(), and setDocsForDefinition().

◆ m_enumBaseType

QCString MemberDefImpl::m_enumBaseType
private

◆ m_enumFields

MemberVector MemberDefImpl::m_enumFields
private

◆ m_enumScope

const MemberDef* MemberDefImpl::m_enumScope = nullptr
private

◆ m_examples

ExampleList MemberDefImpl::m_examples
private

Definition at line 413 of file memberdef.cpp.

Referenced by _writeExamples(), addExample(), deepCopy(), getExamples(), and hasExamples().

◆ m_exception

QCString MemberDefImpl::m_exception
private

Definition at line 428 of file memberdef.cpp.

Referenced by createTemplateInstanceMember(), deepCopy(), excpString(), and init().

◆ m_explExt

bool MemberDefImpl::m_explExt = false
private

Definition at line 504 of file memberdef.cpp.

Referenced by deepCopy(), init(), isExternal(), and setExplicitExternal().

◆ m_explicitOutputFileBase

QCString MemberDefImpl::m_explicitOutputFileBase
private

Definition at line 478 of file memberdef.cpp.

Referenced by deepCopy(), getOutputFileBase(), and setTagInfo().

◆ m_extraTypeChars

QCString MemberDefImpl::m_extraTypeChars
private

Definition at line 430 of file memberdef.cpp.

Referenced by deepCopy(), extraTypeChars(), and init().

◆ m_fileDef

FileDef* MemberDefImpl::m_fileDef = nullptr
private

Definition at line 397 of file memberdef.cpp.

Referenced by deepCopy(), getFileDef(), getFileDef(), init(), moveTo(), and setFileDef().

◆ m_formalTemplateArguments

std::optional<ArgumentList> MemberDefImpl::m_formalTemplateArguments
private

Definition at line 448 of file memberdef.cpp.

Referenced by deepCopy(), formalTemplateArguments(), and setFormalTemplateArguments().

◆ m_group

GroupDef* MemberDefImpl::m_group = nullptr
private

Definition at line 463 of file memberdef.cpp.

Referenced by deepCopy(), getGroupDef(), getGroupDef(), init(), setEnumScope(), and setGroupDef().

◆ m_groupAlias

const MemberDef* MemberDefImpl::m_groupAlias = nullptr
private

Definition at line 460 of file memberdef.cpp.

Referenced by anchor(), deepCopy(), getGroupAlias(), init(), and setGroupAlias().

◆ m_groupFileName

QCString MemberDefImpl::m_groupFileName
private

Definition at line 465 of file memberdef.cpp.

Referenced by deepCopy(), getGroupFileName(), setEnumScope(), and setGroupDef().

◆ m_groupHasDocs

bool MemberDefImpl::m_groupHasDocs = false
private

Definition at line 506 of file memberdef.cpp.

Referenced by deepCopy(), getGroupHasDocs(), setEnumScope(), and setGroupDef().

◆ m_groupMember

MemberDef* MemberDefImpl::m_groupMember = nullptr
private

Definition at line 467 of file memberdef.cpp.

Referenced by anchor(), deepCopy(), init(), and setGroupDef().

◆ m_grouppri

Grouping::GroupPri_t MemberDefImpl::m_grouppri = Grouping::GROUPING_AUTO_DEF
private

Definition at line 464 of file memberdef.cpp.

Referenced by deepCopy(), getGroupPri(), setEnumScope(), and setGroupDef().

◆ m_groupStartLine

int MemberDefImpl::m_groupStartLine = 0
private

Definition at line 466 of file memberdef.cpp.

Referenced by deepCopy(), getGroupStartLine(), setEnumScope(), and setGroupDef().

◆ m_grpId

int MemberDefImpl::m_grpId = 0
private

Definition at line 461 of file memberdef.cpp.

Referenced by deepCopy(), getMemberGroupId(), init(), and setMemberGroupId().

◆ m_hasCallerGraph

bool MemberDefImpl::m_hasCallerGraph = false
private

◆ m_hasCallGraph

bool MemberDefImpl::m_hasCallGraph = false
private

Definition at line 498 of file memberdef.cpp.

Referenced by _hasVisibleCallGraph(), deepCopy(), hasCallGraph(), init(), and overrideCallGraph().

◆ m_hasDetailedDescriptionCached

bool MemberDefImpl::m_hasDetailedDescriptionCached = false
mutableprivate

Definition at line 495 of file memberdef.cpp.

Referenced by deepCopy(), and hasDetailedDescription().

◆ m_hasDocumentedParams

bool MemberDefImpl::m_hasDocumentedParams = false
mutableprivate

Definition at line 486 of file memberdef.cpp.

Referenced by deepCopy(), detectUndocumentedParams(), init(), and warnIfUndocumentedParams().

◆ m_hasDocumentedReturnType

bool MemberDefImpl::m_hasDocumentedReturnType = false
mutableprivate

Definition at line 487 of file memberdef.cpp.

Referenced by deepCopy(), detectUndocumentedParams(), init(), and warnIfUndocumentedParams().

◆ m_hasEnumValues

bool MemberDefImpl::m_hasEnumValues = false
private

Definition at line 503 of file memberdef.cpp.

Referenced by deepCopy(), hasEnumValues(), init(), and overrideEnumValues().

◆ m_hasInlineSource

bool MemberDefImpl::m_hasInlineSource = false
private

Definition at line 502 of file memberdef.cpp.

Referenced by deepCopy(), hasInlineSource(), init(), and overrideInlineSource().

◆ m_hasReferencedByRelation

bool MemberDefImpl::m_hasReferencedByRelation = false
private

◆ m_hasReferencesRelation

bool MemberDefImpl::m_hasReferencesRelation = false
private

Definition at line 501 of file memberdef.cpp.

Referenced by deepCopy(), hasReferencesRelation(), init(), and overrideReferencesRelation().

◆ m_implOnly

bool MemberDefImpl::m_implOnly = false
private

Definition at line 484 of file memberdef.cpp.

Referenced by deepCopy(), init(), isImplementation(), and makeImplementationDetail().

◆ m_initializer

◆ m_initLines

int MemberDefImpl::m_initLines = 0
private

◆ m_isConstructorCached

uint8_t MemberDefImpl::m_isConstructorCached
private

◆ m_isDestructorCached

uint8_t MemberDefImpl::m_isDestructorCached
private

Definition at line 394 of file memberdef.cpp.

Referenced by _computeIsDestructor(), isDestructor(), MemberDefImpl(), and setFileDef().

◆ m_isDMember

bool MemberDefImpl::m_isDMember = false
private

Definition at line 488 of file memberdef.cpp.

Referenced by _computeIsConstructor(), _computeIsDestructor(), deepCopy(), and init().

◆ m_isLinkableCached

◆ m_isTypedefValCached

bool MemberDefImpl::m_isTypedefValCached = false
private

◆ m_livesInsideEnum

bool MemberDefImpl::m_livesInsideEnum = false
private

Definition at line 402 of file memberdef.cpp.

Referenced by deepCopy(), init(), livesInsideEnum(), setEnumScope(), and writeLink().

◆ m_maxInitLines

int MemberDefImpl::m_maxInitLines = 0
private

Definition at line 438 of file memberdef.cpp.

Referenced by deepCopy(), hasMultiLineInitializer(), hasOneLineInitializer(), and init().

◆ m_memberGroup

MemberGroup* MemberDefImpl::m_memberGroup = nullptr
private

Definition at line 462 of file memberdef.cpp.

Referenced by deepCopy(), getMemberGroup(), init(), and setMemberGroup().

◆ m_memDec

MemberDef* MemberDefImpl::m_memDec = nullptr
private

Definition at line 410 of file memberdef.cpp.

Referenced by deepCopy(), init(), memberDeclaration(), and setMemberDeclaration().

◆ m_memDef

MemberDef* MemberDefImpl::m_memDef = nullptr
private

Definition at line 409 of file memberdef.cpp.

Referenced by deepCopy(), init(), memberDefinition(), and setMemberDefinition().

◆ m_memSpec

◆ m_metaData

QCString MemberDefImpl::m_metaData
private

Definition at line 452 of file memberdef.cpp.

Referenced by deepCopy(), init(), and writeDocumentation().

◆ m_moduleDef

ModuleDef* MemberDefImpl::m_moduleDef = nullptr
private

Definition at line 399 of file memberdef.cpp.

Referenced by deepCopy(), getModuleDef(), init(), moveTo(), and setModuleDef().

◆ m_mtype

◆ m_nspace

NamespaceDef* MemberDefImpl::m_nspace = nullptr
private

Definition at line 398 of file memberdef.cpp.

Referenced by deepCopy(), getNamespaceDef(), getNamespaceDef(), init(), moveTo(), and setNamespace().

◆ m_numberOfFlowKW

int MemberDefImpl::m_numberOfFlowKW = 0
private

Definition at line 515 of file memberdef.cpp.

Referenced by deepCopy(), incrementFlowKeyWordCount(), and numberOfFlowKeyWords().

◆ m_prot

◆ m_proto

bool MemberDefImpl::m_proto = false
private

Definition at line 491 of file memberdef.cpp.

Referenced by deepCopy(), init(), isPrototype(), and setPrototype().

◆ m_qualifiers

StringVector MemberDefImpl::m_qualifiers
private

◆ m_read

QCString MemberDefImpl::m_read
private

Definition at line 426 of file memberdef.cpp.

Referenced by deepCopy(), getReadAccessor(), and setReadAccessor().

◆ m_redefineCount

int MemberDefImpl::m_redefineCount = 0
private

Definition at line 516 of file memberdef.cpp.

Referenced by redefineCount(), setAnchor(), and setRedefineCount().

◆ m_redefinedBy

MemberVector MemberDefImpl::m_redefinedBy
private

Definition at line 407 of file memberdef.cpp.

Referenced by deepCopy(), insertReimplementedBy(), isReimplementedBy(), and reimplementedBy().

◆ m_redefines

MemberDef* MemberDefImpl::m_redefines = nullptr
private

Definition at line 406 of file memberdef.cpp.

Referenced by deepCopy(), init(), reimplements(), and setReimplements().

◆ m_related

Relationship MemberDefImpl::m_related = Relationship::Member
private

◆ m_relatedAlso

ClassDef* MemberDefImpl::m_relatedAlso = nullptr
private

Definition at line 411 of file memberdef.cpp.

Referenced by deepCopy(), init(), relatedAlso(), and setRelatedAlso().

◆ m_requiresClause

QCString MemberDefImpl::m_requiresClause
private

◆ m_sectionMap

std::map<const Definition *,const MemberList *> MemberDefImpl::m_sectionMap
private

Definition at line 458 of file memberdef.cpp.

Referenced by deepCopy(), getSectionList(), and setSectionList().

◆ m_stat

bool MemberDefImpl::m_stat = false
private

◆ m_tArgList

◆ m_templateMaster

◆ m_tspec

bool MemberDefImpl::m_tspec = false
private

Definition at line 505 of file memberdef.cpp.

Referenced by deepCopy(), init(), isTemplateSpecialization(), and setTemplateSpecialization().

◆ m_type

◆ m_typeConstraints

ArgumentList MemberDefImpl::m_typeConstraints
private

◆ m_userInitLines

int MemberDefImpl::m_userInitLines = 0
private

◆ m_vhdlSpec

VhdlSpecifier MemberDefImpl::m_vhdlSpec
private

Definition at line 436 of file memberdef.cpp.

Referenced by deepCopy(), getVhdlSpecifiers(), init(), and setVhdlSpecifiers().

◆ m_virt

◆ m_write

QCString MemberDefImpl::m_write
private

Definition at line 427 of file memberdef.cpp.

Referenced by deepCopy(), getWriteAccessor(), and setWriteAccessor().


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