Inheritance diagram for MemberDefImpl:

Collaboration diagram for MemberDefImpl:

Public Member Functions
	MemberDefImpl (const DString &defFileName, int defLine, size_t defColumn, const DString &type, const DString &name, const DString &args, const DString &excp, Protection prot, Specifier virt, bool stat, Relationship related, MemberType t, const ArgumentList &tal, const ArgumentList &al, const DString &metaData)
	~MemberDefImpl () override=default
DefType	definitionType () const override
MemberDef *	resolveAlias () override
const MemberDef *	resolveAlias () const override
CodeSymbolType	codeSymbolType () const override
std::unique_ptr< MemberDef >	deepCopy () const override
void	moveTo (Definition *) override
DString	getOutputFileBase () const override
DString	getReference () const override
DString	anchor () const override
DString	declaration () const override
DString	definition () const override
DString	typeString () const override
DString	argsString () const override
DString	excpString () const override
DString	bitfieldString () const override
DString	extraTypeChars () const override
const DString &	initializer () const override
int	initializerLines () const override
TypeSpecifier	getMemberSpecifiers () const override
VhdlSpecifier	getVhdlSpecifiers () const override
const MemberList *	getSectionList (const Definition *) const override
DString	displayDefinition () const override
const ClassDef *	getClassDef () const override
ClassDef *	getClassDef () override
const FileDef *	getFileDef () const override
FileDef *	getFileDef () override
const NamespaceDef *	getNamespaceDef () const override
NamespaceDef *	getNamespaceDef () override
const GroupDef *	getGroupDef () const override
GroupDef *	getGroupDef () override
const ModuleDef *	getModuleDef () const override
DString	getReadAccessor () const override
DString	getWriteAccessor () const override
Grouping::GroupPri_t	getGroupPri () const override
DString	getGroupFileName () const override
int	getGroupStartLine () const override
bool	getGroupHasDocs () const override
DString	qualifiedName () const override
DString	objCMethodName (bool localLink, bool showStatic) const override
Protection	protection () const override
Specifier	virtualness (int count=0) const override
MemberType	memberType () const override
DString	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	isThreadLocal () 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 MemberDef *	reimplements () const override
const MemberVector &	reimplementedBy () const override
bool	isReimplementedBy (const ClassDef *cd) const override
ClassDef *	relatedAlso () const override
bool	hasDocumentedEnumValues () const override
const MemberDef *	getAnonymousEnumType () const override
const MemberDef *	anonymousMemberForDeclaration () const override
const MemberDef *	anonymousMemberForDetails () const override
bool	isDocsForDefinition () const override
const MemberDef *	getEnumScope () const override
const MemberVector &	enumFieldList () const override
void	setEnumBaseType (const DString &type) override
DString	enumBaseType () const override
bool	hasExamples () const override
const ExampleList &	getExamples () const override
bool	isPrototype () const override
const ArgumentList &	argumentList () const override
const ArgumentList &	declArgumentList () const override
const ArgumentList &	templateArguments () const override
const ArgumentLists &	definitionTemplateParameterLists () const override
std::optional< ArgumentList >	formalTemplateArguments () const override
int	getMemberGroupId () const override
MemberGroup *	getMemberGroup () 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
bool	isDocTransferDone () const override
DString	sourceRefName () const override
const MemberDef *	templateMaster () const override
DString	getScopeString () const override
const ClassDef *	getClassDefOfAnonymousType () const override
bool	isTypedefValCached () const override
const ClassDef *	getCachedTypedefVal () const override
DString	getCachedTypedefTemplSpec () const override
DString	getCachedResolvedTypedef () const override
MemberDef *	memberDefinition () const override
MemberDef *	memberDeclaration () const override
const MemberDef *	inheritsDocsFrom () const override
const MemberDef *	getGroupAlias () const override
ClassDef *	category () const override
const MemberDef *	categoryRelation () const override
DString	displayName (bool=true) const override
DString	getDeclType () const override
StringVector	getLabels (const Definition *container) const override
const ArgumentList &	typeConstraints () const override
DString	requiresClause () const override
DString	documentation () const override
DString	briefDescription (bool abbr=false) const override
DString	fieldType () const override
bool	isReference () const override
DString	getDeclFileName () const override
int	getDeclLine () const override
size_t	getDeclColumn () const override
void	setMemberType (MemberType t) override
void	setDefinition (const DString &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 DString &i) override
void	setBitfields (const DString &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 DString &fileName, int startLine, bool hasDocs, MemberDef member=nullptr) override
void	setReadAccessor (const DString &r) override
void	setWriteAccessor (const DString &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 DString &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
void	setAnonymousMemberForDeclaration (const MemberDef *md) override
void	setAnonymousMemberForDetails (const MemberDef *md) override
bool	addExample (const DString &anchor, const DString &name, const DString &file) override
void	setPrototype (bool p, const DString &df, int line, size_t column) override
void	setExplicitExternal (bool b, const DString &df, int line, size_t column) override
void	setDeclFile (const DString &df, int line, size_t 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 DString &t) override
void	setNamespace (NamespaceDef *nd) override
void	setMemberGroup (MemberGroup *grp) override
void	setMemberGroupId (int id) override
void	makeImplementationDetail () 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 (const Definition *) override
void	addRequirementReferences (const Definition *) override
void	setDocsForDefinition (bool b) override
void	setGroupAlias (const MemberDef *md) override
void	cacheTypedefVal (const ClassDef *val, const DString &templSpec, const DString &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 DString &d, const DString &docFile, int docLine, bool stripWhiteSpace=true) override
void	setBriefDescription (const DString &b, const DString &briefFile, int briefLine) override
void	setInbodyDocumentation (const DString &d, const DString &inbodyFile, int inbodyLine) override
void	setHidden (bool b) override
void	setDocTransferDone () override
void	setExplicitInherited (bool b) override
void	setRequiresClause (const DString &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 DString &inheritId=DString()) const override
void	writeDocumentation (const MemberList ml, int memCount, int memTotal, OutputList &ol, const DString &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< MemberDef >	createTemplateInstanceMember (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
ClassDefMutable *	getClassDefMutable () override
void	setModuleDef (ModuleDef *mod) override
int	redefineCount () const override
void	setRedefineCount (int) override
void	setClassDefOfAnonymousType (const ClassDef *cd) override
void	setIncludeFile (FileDef *fd, const DString &incName, bool local, bool force) override
Public Member Functions inherited from DefinitionMixin< MemberDefMutable >
	DefinitionMixin (const DString &defFileName, int defLine, size_t defColumn, const DString &name, const char b=nullptr, const char d=nullptr, bool isSymbol=true)
DefinitionMixin &	operator= (const DefinitionMixin &other)
	~DefinitionMixin () override=default
bool	isAlias () const override
const DString &	name () const override
bool	isAnonymous () const override
const DString &	localName () const override
DString	symbolName () const override
DString	getSourceFileBase () const override
DString	getSourceAnchor () const override
int	docLine () const override
DString	docFile () const override
DString	briefDescriptionAsTooltip () const override
int	briefLine () const override
DString	inbodyDocumentation () const override
DString	inbodyFile () const override
int	inbodyLine () const override
DString	briefFile () const override
DString	getDefFileName () const override
DString	getDefFileExtension () const override
int	getDefLine () const override
size_t	getDefColumn () const override
bool	isVisibleInProject () const override
bool	isVisible () const override
bool	isHidden () const override
bool	isArtificial () const override
bool	isExported () const override
DString	externalReference (const DString &relPath) const override
int	getStartDefLine () const override
int	getStartBodyLine () const override
int	getEndBodyLine () const override
const FileDef *	getBodyDef () const override
SrcLangExt	getLanguage () const override
const GroupList &	partOfGroups () const override
bool	isLinkableViaGroup () const override
const RefItemVector &	xrefListItems () const override
const RequirementRefs &	requirementReferences () const override
const Definition *	findInnerCompound (const DString &name) const override
Definition *	getOuterScope () const override
const MemberVector &	getReferencesMembers () const override
const MemberVector &	getReferencedByMembers () const override
bool	hasSections () const override
bool	hasSources () const override
bool	hasBriefDescription () const override
DString	id () const override
const SectionRefs &	getSectionRefs () const override
void	setName (const DString &name) override
void	setId (const DString &name) override
void	setDefFile (const DString &df, int defLine, size_t defColumn) override
void	setReference (const DString &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 DString &sourceRefName) override
void	addSourceReferences (MemberDef *md, const DString &sourceRefName) override
void	setRefItems (const RefItemVector &sli) override
void	setRequirementReferences (const RequirementRefs &rqli) 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 DString &scopeName) const override
bool	hasSourceRefs () const override
bool	hasSourceReffedBy () const override
void	writeSourceRefs (OutputList &ol, const DString &scopeName) const override
void	writeSourceReffedBy (OutputList &ol, const DString &scopeName) const override
bool	hasRequirementRefs () const override
void	writeRequirementRefs (OutputList &ol) const override
void	makePartOfGroup (GroupDef *gd) override
void	writeNavigationPath (OutputList &ol) const override
DString	navigationPathAsString () const override
void	writeQuickMemberLinks (OutputList &ol, const MemberDef *md) const override
void	writeSummaryLinks (OutputList &ol) const override
void	writePageNavigation (OutputList &ol) const override
DString	pathFragment () const override
void	writeDocAnchorsToTagFile (TextStream &fs) const override
void	setLocalName (const DString &name) override
void	writeToc (OutputList &ol, const LocalToc &lt) const override
void	computeTooltip () override
void	_setSymbolName (const DString &name) override
DString	_symbolName () const override

Private Member Functions
void	_computeLinkableInProject ()
void	_computeIsConstructor ()
void	_computeIsDestructor ()
void	_writeGroupInclude (OutputList &ol, bool inGroup) const
void	_writeMultiLineInitializer (OutputList &ol, const DString &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 DString &cfname, const DString &ciname, const DString &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 DString &t, const DString &a, const DString &e, Protection p, Specifier v, bool s, Relationship r, MemberType mt, const ArgumentList &tal, const ArgumentList &al, const DString &meta)

Private Attributes
uint8_t	m_isLinkableCached
uint8_t	m_isConstructorCached
uint8_t	m_isDestructorCached
ClassDef *	m_classDef = nullptr
FileDef *	m_fileDef = nullptr
NamespaceDef *	m_nspace = nullptr
ModuleDef *	m_moduleDef = nullptr
const MemberDef *	m_enumScope = nullptr
bool	m_livesInsideEnum = false
const MemberDef *	m_annEnumType = nullptr
MemberVector	m_enumFields
const MemberDef *	m_annMemberForDecl = nullptr
const MemberDef *	m_annMemberForDetails = nullptr
MemberDef *	m_redefines = nullptr
MemberVector	m_redefinedBy
MemberDef *	m_memDef = nullptr
MemberDef *	m_memDec = nullptr
ClassDef *	m_relatedAlso = nullptr
std::unique_ptr< IncludeInfo >	m_incInfo
ExampleList	m_examples
DString	m_type
DString	m_args
DString	m_def
DString	m_anc
Specifier	m_virt = Specifier::Normal
Protection	m_prot = Protection::Public
DString	m_decl
DString	m_bitfields
DString	m_read
DString	m_write
DString	m_exception
DString	m_initializer
DString	m_extraTypeChars
DString	m_enumBaseType
DString	m_requiresClause
int	m_initLines = 0
bool	m_docTransferDone = false
TypeSpecifier	m_memSpec
VhdlSpecifier	m_vhdlSpec
MemberType	m_mtype = MemberType::Define
int	m_maxInitLines = 0
int	m_userInitLines = 0
ArgumentList	m_defArgList
ArgumentList	m_declArgList
ArgumentList	m_tArgList
ArgumentList	m_typeConstraints
const MemberDef *	m_templateMaster = nullptr
std::optional< ArgumentList >	m_formalTemplateArguments
ArgumentLists	m_defTmpArgLists
DString	m_metaData
const ClassDef *	m_anonymousType = nullptr
std::map< const Definition , const MemberList >	m_sectionMap
const MemberDef *	m_groupAlias = nullptr
int	m_grpId = 0
MemberGroup *	m_memberGroup = nullptr
GroupDef *	m_group = nullptr
Grouping::GroupPri_t	m_grouppri = Grouping::GROUPING_AUTO_DEF
DString	m_groupFileName
int	m_groupStartLine = 0
MemberDef *	m_groupMember = nullptr
bool	m_isTypedefValCached = false
const ClassDef *	m_cachedTypedefValue = nullptr
DString	m_cachedTypedefTemplSpec
DString	m_cachedResolvedType
const MemberDef *	m_docProvider = nullptr
DString	m_explicitOutputFileBase
bool	m_explicitInherited = false
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_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
ClassDef *	m_category = nullptr
const MemberDef *	m_categoryRelation = nullptr
DString	m_declFileName
int	m_declLine = -1
size_t	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 DString &	df,
		int	dl,
		size_t	dc,
		const DString &	t,
		const DString &	na,
		const DString &	a,
		const DString &	e,
		Protection	p,
		Specifier	v,
		bool	s,
		Relationship	r,
		MemberType	mt,
		const ArgumentList &	tal,
		const ArgumentList &	al,
		const DString &	meta )

Creates a new member definition.

Parameters

df	File containing the definition of this member.
dl	Line at which the member definition was found.
dc	Column at which the member definition was found.
t	A string representing the type of the member.
na	A string representing the name of the member.
a	A string representing the arguments of the member.
e	A string representing the throw clause of the members.
p	The protection context of the member, possible values are: `Public`, `Protected`, `Private`.
v	The degree of 'virtualness' of the member, possible values are: `Normal`, `Virtual`, `Pure`.
s	A boolean that is true iff the member is static.
r	The relationship between the class and the member.
mt	The kind of member. See MemberType for a list of all types.
tal	The template arguments of this member.
al	The arguments of this member. This is a structured form of the string past as argument a.
meta	Slice metadata.

Definition at line 1467 of file memberdef.cpp.

                      : DefinitionMixin(df,dl,dc,removeRedundantWhiteSpace(na))
{
  //printf("MemberDefImpl::MemberDef(%s)\n",qPrint(na));
  init(this,t,a,e,p,v,s,r,mt,tal,al,meta);
  m_isLinkableCached    = 0;
  m_isConstructorCached = 0;
  m_isDestructorCached  = 0;
}

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 4722 of file memberdef.cpp.

{
  m_isConstructorCached=1; // false
  if (getClassDef())
  {
    if (m_isDMember) // for D
    {
      m_isConstructorCached = name()=="this" ? 2 : 1;
      return;
    }
    else if (getLanguage()==SrcLangExt::PHP) // for PHP
    {
      m_isConstructorCached = name()=="__construct" ? 2 : 1;
      return;
    }
    else if (name()=="__init__" &&
             getLanguage()==SrcLangExt::Python) // for Python
    {
      m_isConstructorCached = 2; // true
      return;
    }
    else // for other languages
    {
      DString locName = getClassDef()->localName();
      size_t i=locName.find('<');
      if (i==DString::npos) // not a template class
      {
        m_isConstructorCached = name()==locName ? 2 : 1;
      }
      else
      {
        m_isConstructorCached = name()==locName.left(i) ? 2 : 1;
      }
      return;
    }
  }
}

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

Referenced by isConstructor().

◆ _computeIsDestructor()

void MemberDefImpl::_computeIsDestructor ( )

private

Definition at line 4772 of file memberdef.cpp.

{
  bool isDestructor = false;
  if (m_isDMember) // for D
  {
    isDestructor = name()=="~this";
  }
  else if (getLanguage()==SrcLangExt::PHP) // for PHP
  {
    isDestructor = name()=="__destruct";
  }
  else if (name()=="__del__" &&
           getLanguage()==SrcLangExt::Python) // for Python
  {
    isDestructor = true;
  }
  else if (getLanguage()==SrcLangExt::Fortran) // for Fortran
  {
    isDestructor = typeString()=="final";
  }
  else // other languages
  {
    isDestructor =
           (name().find('~')!=DString::npos || name().find('!')!=DString::npos)  // The ! is for C++/CLI
           && name().find("operator")==DString::npos;
  }
  m_isDestructorCached = isDestructor ? 2 : 1;
}

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

Referenced by isDestructor().

◆ _computeLinkableInProject()

void MemberDefImpl::_computeLinkableInProject ( )

private

Definition at line 1828 of file memberdef.cpp.

{
  AUTO_TRACE("name={}",qualifiedName());
  bool extractStatic  = Config_getBool(EXTRACT_STATIC);
  bool extractPrivateVirtual = Config_getBool(EXTRACT_PRIV_VIRTUAL);
  m_isLinkableCached = 2; // linkable
  //printf("MemberDefImpl::isLinkableInProject(name=%s)\n",qPrint(name()));
  if (isHidden())
  {
    AUTO_TRACE_ADD("is hidden");
    m_isLinkableCached = 1;
    return;
  }
  if (templateMaster())
  {
    AUTO_TRACE_ADD("has master template");
    m_isLinkableCached = templateMaster()->isLinkableInProject() ? 2 : 1;
    return;
  }
  if (isAnonymous())
  {
    AUTO_TRACE_ADD("name invalid");
    m_isLinkableCached = 1; // not a valid or a dummy name
    return;
  }
  if (!hasDocumentation() || isReference())
  {
    AUTO_TRACE_ADD("no docs or reference");
    m_isLinkableCached = 1; // no documentation
    return;
  }
  const GroupDef *groupDef = getGroupDef();
  const ClassDef *classDef = getClassDef();
  if (groupDef && !groupDef->isLinkableInProject())
  {
    AUTO_TRACE_ADD("in not linkable group");
    m_isLinkableCached = 1; // group but group not linkable
    return;
  }
  if (!groupDef && classDef && !classDef->isLinkableInProject())
  {
    AUTO_TRACE_ADD("in not linkable class");
    m_isLinkableCached = 1; // in class but class not linkable
    return;
  }
  const NamespaceDef *nspace = getNamespaceDef();
  const FileDef *fileDef = getFileDef();
  if (!groupDef && nspace /*&& m_related==Relationship::Member*/ && !nspace->isLinkableInProject()
      && (fileDef==nullptr || !fileDef->isLinkableInProject()))
  {
    AUTO_TRACE_ADD("in not linkable namespace");
    m_isLinkableCached = 1; // in namespace but namespace not linkable
    return;
  }
  if (!groupDef && !nspace &&
      /*m_related==Relationship::Member &&*/ !classDef &&
      fileDef && !fileDef->isLinkableInProject())
  {
    AUTO_TRACE_ADD("in not linkable file");
    m_isLinkableCached = 1; // in file (and not in namespace) but file not linkable
    return;
  }
  if ((!protectionLevelVisible(m_prot) && m_mtype!=MemberType::Friend) &&
       !(m_prot==Protection::Private && (m_virt!=Specifier::Normal || isOverride() || isFinal()) && extractPrivateVirtual))
  {
    AUTO_TRACE_ADD("private and invisible");
    m_isLinkableCached = 1; // hidden due to protection
    return;
  }
  if (m_stat && classDef==nullptr && !extractStatic)
  {
    AUTO_TRACE_ADD("static and invisible");
    m_isLinkableCached = 1; // hidden due to staticness
    return;
  }
  AUTO_TRACE_ADD("linkable");
  return; // linkable!
}

References AUTO_TRACE, AUTO_TRACE_ADD, Config_getBool, 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 3023 of file memberdef.cpp.

{
  const MemberVector &bml=reimplementedBy();
  size_t count=0;
  for (const auto &bmd : bml)
  {
    const ClassDef *bcd=bmd->getClassDef();
    // count the members that directly inherit from md and for
    // which the member and class are visible in the docs.
    if ( bcd && bmd->isLinkable() && bcd->isLinkable() )
    {
      count++;
    }
  }
  return count;
}

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

Referenced by _writeReimplementedBy(), and hasDetailedDescription().

◆ _hasVisibleCallerGraph()

bool MemberDefImpl::_hasVisibleCallerGraph ( ) const

private

Definition at line 5748 of file memberdef.cpp.

{
  bool enabled = m_hasCallerGraph &&
         (isFunction() || isSlot() || isSignal()) &&
         Config_getBool(HAVE_DOT);
  if (enabled)
  {
    bool trivial = DotCallGraph::isTrivial(this,true);
    return !trivial;
  }
  return false;
}

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

Referenced by _writeCallerGraph(), and hasDetailedDescription().

◆ _hasVisibleCallGraph()

bool MemberDefImpl::_hasVisibleCallGraph ( ) const

private

Definition at line 5730 of file memberdef.cpp.

{
  bool enabled = m_hasCallGraph &&
         (isFunction() || isSlot() || isSignal()) &&
         Config_getBool(HAVE_DOT);
  if (enabled)
  {
    bool trivial = DotCallGraph::isTrivial(this,false);
    return !trivial;
  }
  return false;
}

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

Referenced by _writeCallGraph(), and hasDetailedDescription().

◆ _isAnonymousBitField()

bool MemberDefImpl::_isAnonymousBitField ( ) const

private

Definition at line 2218 of file memberdef.cpp.

{
  return !m_bitfields.empty() && name().startsWith("__pad"); // anonymous bitfield
}

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

Referenced by warnIfUndocumented(), and writeDeclaration().

◆ _isReimplements()

bool MemberDefImpl::_isReimplements ( ) const

private

Definition at line 2951 of file memberdef.cpp.

{
  const MemberDef *bmd=reimplements();
  const ClassDef *bcd=nullptr;
  if (bmd && (bcd=bmd->getClassDef()))
  {
    // write class that contains a member that is reimplemented by this one
    if (bcd->isLinkable())
    {
      return true;
    }
  }
  return false;
}

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

Referenced by hasDetailedDescription().

◆ _writeCallerGraph()

void MemberDefImpl::_writeCallerGraph ( OutputList & ol ) const

private

Definition at line 2929 of file memberdef.cpp.

{
  if (_hasVisibleCallerGraph())
  {
    DotCallGraph callerGraph(this, true);
    if (callerGraph.isTooBig())
    {
       warn_uncond("Caller graph for '{}' not generated, too many nodes ({}), threshold is {}. Consider increasing DOT_GRAPH_MAX_NODES.\n",
           qualifiedName(), callerGraph.numNodes(), Config_getInt(DOT_GRAPH_MAX_NODES));
    }
    else if (!callerGraph.isTrivial())
    {
      msg("Generating caller graph for function {}\n",qualifiedName());
      ol.disable(OutputType::Man);
      ol.startCallGraph();
      ol.parseText(theTranslator->trCallerGraph());
      ol.endCallGraph(callerGraph);
      ol.enableAll();
    }
  }
}

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

Referenced by writeDocumentation().

◆ _writeCallGraph()

void MemberDefImpl::_writeCallGraph ( OutputList & ol ) const

private

Definition at line 2906 of file memberdef.cpp.

{
  // write call graph
  if (_hasVisibleCallGraph())
  {
    DotCallGraph callGraph(this,false);
    if (callGraph.isTooBig())
    {
       warn_uncond("Call graph for '{}' not generated, too many nodes ({}), threshold is {}. Consider increasing DOT_GRAPH_MAX_NODES.\n",
           qualifiedName(), callGraph.numNodes(), Config_getInt(DOT_GRAPH_MAX_NODES));
    }
    else if (!callGraph.isTrivial())
    {
      msg("Generating call graph for function {}\n",qualifiedName());
      ol.disable(OutputType::Man);
      ol.startCallGraph();
      ol.parseText(theTranslator->trCallGraph());
      ol.endCallGraph(callGraph);
      ol.enableAll();
    }
  }
}

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

Referenced by writeDocumentation().

◆ _writeCategoryRelation()

void MemberDefImpl::_writeCategoryRelation ( OutputList & ol ) const

private

Definition at line 3099 of file memberdef.cpp.

{
  if (getClassDef()) // this should be a member of a class/category
  {
    //printf("%s: category %s relation %s class=%s categoryOf=%s\n",
    //    qPrint(name()),
    //    m_category ? qPrint(m_category->name()) : "<none>",
    //    m_categoryRelation ? qPrint(m_categoryRelation->name()) : "<none>",
    //    qPrint(m_classDef->name()),
    //    m_classDef->categoryOf() ? qPrint(m_classDef->categoryOf()->name()) : "<none>"
    //    );
    DString text;
    DString ref;
    DString file;
    DString anc;
    DString name;
    size_t i=DString::npos;
    if (m_categoryRelation && m_categoryRelation->isLinkable())
    {
      if (m_category)
      {
        // this member is in a normal class and implements method categoryRelation from category
        // so link to method 'categoryRelation' with 'provided by category 'category' text.
        text = theTranslator->trProvidedByCategory();
        name = m_category->displayName();
      }
      else if (getClassDef()->categoryOf())
      {
        // this member is part of a category so link to the corresponding class member of the class we extend
        // so link to method 'categoryRelation' with 'extends class 'classDef->categoryOf()'
        text = theTranslator->trExtendsClass();
        name = getClassDef()->categoryOf()->displayName();
      }
      i=text.find("@0");
      if (i!=DString::npos)
      {
        const MemberDef *md = m_categoryRelation;
        ref  = md->getReference();
        file = md->getOutputFileBase();
        anc  = md->anchor();
      }
    }
    if (i!=DString::npos && !name.empty())
    {
      ol.startParagraph();
      ol.parseText(text.left(i));
      ol.writeObjectLink(ref,file,anc,name);
      ol.parseText(text.mid(i+2));
      ol.endParagraph();
    }
  }
}

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

Referenced by writeDocumentation().

◆ _writeEnumValues()

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

private

Definition at line 3173 of file memberdef.cpp.

{
  // For enum, we also write the documented enum values
  if (isEnumerate())
  {
    bool first=true;
    //printf("** %s: enum values=%zu\n",qPrint(name()),enumFieldList().size());
    bool hasInits = false;
    if (hasEnumValues())
    {
      for (const auto &fmd : enumFieldList())
      {
        if (fmd->isLinkable())
        {
          if (!fmd->initializer().empty())
          {
            hasInits = true;
            break;
          }
        }
      }
    }
    for (const auto &fmd : enumFieldList())
    {
      //printf("Enum %p: isLinkable()=%d\n",fmd,fmd->isLinkable());
      if (fmd->isLinkable())
      {
        if (first)
        {
          ol.startDescTable(theTranslator->trEnumerationValues(),hasInits);
          first=false;
        }
 
        ol.startDescTableRow();
        ol.addIndexItem(fmd->name(),ciname);
        ol.addIndexItem(ciname,fmd->name());
 
        ol.startDescTableTitle();
        ol.startDoxyAnchor(cfname,cname,fmd->anchor(),fmd->name(),fmd->argsString());
        ol.addLabel(cfname,fmd->anchor());
        ol.docify(fmd->name());
        ol.disableAllBut(OutputType::Man);
        ol.writeString(" ");
        ol.enableAll();
        ol.endDoxyAnchor(cfname,fmd->anchor());
        ol.endDescTableTitle();
        if (hasInits)
        {
          ol.startDescTableInit();
          if (!fmd->initializer().empty())
          {
            DString initStr = fmd->initializer().stripWhiteSpace();
            if (initStr.startsWith("=")) initStr = initStr.mid(1).stripWhiteSpace();
            ol.disableAllBut(OutputType::Man);
            ol.writeString("(");
            ol.enableAll();
            ol.docify(initStr);
            ol.disableAllBut(OutputType::Man);
            ol.writeString(")");
            ol.enableAll();
          }
          ol.endDescTableInit();
        }
        ol.startDescTableData();
 
        bool hasBrief = !fmd->briefDescription().empty();
        bool hasDetails = !fmd->documentation().empty();
 
        if (hasBrief)
        {
          ol.generateDoc(fmd->briefFile(),
                         fmd->briefLine(),
                         getOuterScope()?getOuterScope():container,
                         fmd,
                         fmd->briefDescription(),
                         DocOptions()
                         .setIndexWords(true));
        }
        if (hasDetails)
        {
          ol.generateDoc(fmd->docFile(),
                         fmd->docLine(),
                         getOuterScope()?getOuterScope():container,
                         fmd,
                         fmd->documentation()+"\n",
                         DocOptions()
                         .setIndexWords(true));
        }
        ol.endDescTableData();
        ol.endDescTableRow();
      }
    }
    if (!first)
    {
      ol.endDescTable();
    }
  }
}

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(), OutputList::generateDoc(), DefinitionMixin< MemberDefMutable >::getOuterScope(), hasEnumValues(), isEnumerate(), Man, DString::mid(), OutputList::startDescTable(), OutputList::startDescTableData(), OutputList::startDescTableInit(), OutputList::startDescTableRow(), OutputList::startDescTableTitle(), OutputList::startDoxyAnchor(), DString::startsWith(), DString::stripWhiteSpace(), theTranslator, Translator::trEnumerationValues(), and OutputList::writeString().

Referenced by writeDocumentation().

◆ _writeExamples()

void MemberDefImpl::_writeExamples ( OutputList & ol ) const

private

Definition at line 3152 of file memberdef.cpp.

{
  // write the list of examples that use this member
  if (hasExamples())
  {
    ol.startExamples();
    ol.startDescForItem();
    writeExamples(ol,m_examples);
    ol.endDescForItem();
    ol.endExamples();
  }
}

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 3360 of file memberdef.cpp.

{
  SrcLangExt lang = getLanguage();
  bool written = false;
  if (m_incInfo) // explicit \headerfile command
  {
    DString nm=m_incInfo->includeName.empty() ?
      (m_incInfo->fileDef ?
       m_incInfo->fileDef->docName() : DString()
      ) : m_incInfo->includeName;
    if (!nm.empty())
    {
      ol.startParagraph();
      ol.startTypewriter();
      ol.docify(::includeStatement(lang,m_incInfo->kind));
      ol.docify(::includeOpen(lang,m_incInfo->kind));
      ol.pushGeneratorState();
      ol.disable(OutputType::Html);
      ol.docify(nm);
      ol.disableAllBut(OutputType::Html);
      ol.enable(OutputType::Html);
      if (m_incInfo->fileDef)
      {
        ol.writeObjectLink(DString(),m_incInfo->fileDef->includeName(),DString(),nm);
      }
      else
      {
        ol.docify(nm);
      }
      ol.popGeneratorState();
      ol.docify(::includeClose(lang,m_incInfo->kind));
      ol.endTypewriter();
      ol.endParagraph();
      written = true;
    }
  }
  if (!written) // only write out the include file if this is not part of a class or file definition
  {
    bool showGroupedMembInc = Config_getBool(SHOW_GROUPED_MEMB_INC);
    bool forceLocalIncludes = Config_getBool(FORCE_LOCAL_INCLUDES);
    const FileDef *fd = getFileDef();
    DString nm;
    if (inGroup && fd && showGroupedMembInc)
    {
      if (!Config_getList(STRIP_FROM_INC_PATH).empty())
      {
        nm = stripFromIncludePath(fd->absFilePath());
      }
      else
      {
        nm = fd->name();
      }
    }
    if (!nm.empty())
    {
      ol.startParagraph();
      ol.startTypewriter();
      bool isIDLorJava = lang==SrcLangExt::IDL || lang==SrcLangExt::Java;
      if (isIDLorJava)
      {
        ol.docify("import ");
      }
      else
      {
        ol.docify("#include ");
      }
 
      if (isIDLorJava || forceLocalIncludes) ol.docify("\""); else ol.docify("<");
 
      if (fd && fd->isLinkable())
      {
        ol.writeObjectLink(fd->getReference(),fd->getOutputFileBase(),fd->anchor(),nm);
      }
      else
      {
        ol.docify(nm);
      }
 
      if (isIDLorJava || forceLocalIncludes) ol.docify("\""); else ol.docify(">");
 
      ol.endTypewriter();
      ol.endParagraph();
    }
  }
}

References FileDef::absFilePath(), Definition::anchor(), Config_getBool, Config_getList, OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), DString::empty(), OutputList::enable(), OutputList::endParagraph(), OutputList::endTypewriter(), getFileDef(), DefinitionMixin< MemberDefMutable >::getLanguage(), Definition::getOutputFileBase(), Definition::getReference(), Html, includeClose(), includeOpen(), includeStatement(), Definition::isLinkable(), m_incInfo, Definition::name(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startParagraph(), OutputList::startTypewriter(), stripFromIncludePath(), and OutputList::writeObjectLink().

Referenced by writeDocumentation().

◆ _writeMultiLineInitializer()

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

private

Definition at line 3446 of file memberdef.cpp.

{
    //printf("md=%s initLines=%d init='%s'\n",qPrint(name()),initLines,qPrint(init));
    ol.startBold();
    if (m_mtype==MemberType::Define)
      ol.parseText(theTranslator->trDefineValue());
    else
      ol.parseText(theTranslator->trInitialValue());
    ol.endBold();
    DString langCorrected = getDefFileExtension();
    SrcLangExt srcLangExt = getLanguageFromFileName(getDefFileExtension());
    if (srcLangExt == SrcLangExt::Lex)
    {
      langCorrected = ".doxygen_lex_c";
      srcLangExt = SrcLangExt::Cpp;
    }
    auto intf = Doxygen::parserManager->getCodeParser(langCorrected);
    intf->resetCodeParserState();
    auto &codeOL = ol.codeGenerators();
    codeOL.startCodeFragment("DoxyCode");
    intf->parseCode(codeOL,scopeName,m_initializer,srcLangExt,Config_getBool(STRIP_CODE_COMMENTS),
                    CodeParserOptions()
                    .setFileDef(getFileDef())
                    .setInlineFragment(true)
                    .setMemberDef(this)
                    .setShowLineNumbers(false)
                    .setSearchCtx(this)
                   );
    codeOL.endCodeFragment("DoxyCode");
}

References OutputList::codeGenerators(), Config_getBool, OutputList::endBold(), ParserManager::getCodeParser(), DefinitionMixin< MemberDefMutable >::getDefFileExtension(), getFileDef(), getLanguageFromFileName(), m_initializer, m_mtype, Doxygen::parserManager, OutputList::parseText(), setFileDef(), OutputList::startBold(), OutputCodeList::startCodeFragment(), theTranslator, Translator::trDefineValue(), and Translator::trInitialValue().

Referenced by writeDocumentation().

◆ _writeReimplementedBy()

void MemberDefImpl::_writeReimplementedBy ( OutputList & ol ) const

private

Definition at line 3040 of file memberdef.cpp.

{
  const MemberVector &bml=reimplementedBy();
  size_t count = _countReimplementedBy();
  if (count>0)
  {
    auto replaceFunc = [&bml,&ol](size_t entryIndex)
    {
      size_t cnt=0;
      auto it = bml.begin();
      // find the entryIndex-th documented entry in the inheritance list.
      const MemberDef *bmd = nullptr;
      const ClassDef *bcd = nullptr;
      while (it!=bml.end())
      {
        bmd = *it;
        bcd = bmd->getClassDef();
        if ( bmd->isLinkable() && bcd->isLinkable())
        {
          if (cnt==entryIndex) break;
          cnt++;
        }
        ++it;
      }
 
      if (bcd && bmd) // write link for marker
      {
        //ol.writeObjectLink(bcd->getReference(),bcd->getOutputFileBase(),
        //    bmd->anchor(),bcd->name());
        ol.writeObjectLink(bmd->getReference(),bmd->getOutputFileBase(),
            bmd->anchor(),bcd->displayName());
 
        if (bmd->isLinkableInProject() )
        {
          writePageRef(ol,bmd->getOutputFileBase(),bmd->anchor());
        }
      }
    };
 
    DString reimplInLine;
    if (m_virt==Specifier::Pure || (getClassDef() && getClassDef()->compoundType()==ClassDef::Interface))
    {
      reimplInLine = theTranslator->trImplementedInList(static_cast<int>(count));
    }
    else
    {
      reimplInLine = theTranslator->trReimplementedInList(static_cast<int>(count));
    }
 
    // write the list of classes that overwrite this member
    ol.startParagraph();
    writeMarkerList(ol,
                    reimplInLine.str(),
                    count,
                    replaceFunc);
    ol.endParagraph();
  }
}

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(), DString::str(), theTranslator, Translator::trImplementedInList(), Translator::trReimplementedInList(), writeMarkerList(), OutputList::writeObjectLink(), and writePageRef().

Referenced by writeDocumentation().

◆ _writeReimplements()

void MemberDefImpl::_writeReimplements ( OutputList & ol ) const

private

Definition at line 2965 of file memberdef.cpp.

{
  const MemberDef *bmd=reimplements();
  const ClassDef *bcd=nullptr;
  if (bmd && (bcd=bmd->getClassDef()))
  {
    // write class that contains a member that is reimplemented by this one
    if (bcd->isLinkable())
    {
      ol.startParagraph();
      DString reimplFromLine;
      if (bmd->virtualness()!=Specifier::Pure && bcd->compoundType()!=ClassDef::Interface)
      {
        reimplFromLine = theTranslator->trReimplementedFromList(1);
      }
      else
      {
        reimplFromLine = theTranslator->trImplementedFromList(1);
      }
      if (size_t markerPos = reimplFromLine.find("@0"); markerPos!=DString::npos) // should always pass this.
      {
        ol.parseText(reimplFromLine.left(markerPos)); //text left from marker
        if (bmd->isLinkable()) // replace marker with link
        {
          //Definition *bd=bmd->group;
          //if (bd==0) bd=bcd;
          ol.writeObjectLink(bmd->getReference(),bmd->getOutputFileBase(),
              bmd->anchor(),bcd->displayName());
 
          //ol.writeObjectLink(bcd->getReference(),bcd->getOutputFileBase(),
          //    bmd->anchor(),bcd->name());
          if ( bmd->isLinkableInProject() )
          {
            writePageRef(ol,bmd->getOutputFileBase(),bmd->anchor());
          }
        }
        else
        {
          ol.writeObjectLink(bcd->getReference(),bcd->getOutputFileBase(),
              DString(),bcd->displayName());
          if (bcd->isLinkableInProject()/* && !Config_getBool(PDF_HYPERLINKS)*/ )
          {
            writePageRef(ol,bcd->getOutputFileBase(),bcd->anchor());
          }
        }
        ol.parseText(reimplFromLine.right(
              reimplFromLine.length()-markerPos-2)); // text right from marker
 
      }
      else
      {
        err("translation error: no marker in trReimplementsFromList()\n");
      }
      ol.endParagraph();
    }
  }
}

References Definition::anchor(), ClassDef::compoundType(), Definition::displayName(), OutputList::endParagraph(), err, DString::find(), MemberDef::getClassDef(), Definition::getOutputFileBase(), Definition::getReference(), ClassDef::Interface, Definition::isLinkable(), Definition::isLinkableInProject(), DString::left(), DString::length(), DString::npos, OutputList::parseText(), reimplements(), DString::right(), OutputList::startParagraph(), theTranslator, Translator::trImplementedFromList(), Translator::trReimplementedFromList(), 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 2175 of file memberdef.cpp.

{
  ol.docify("template<");
  LinkifyTextOptions options;
  options.setScope(def).setFileScope(getFileDef()).setSelf(this);
  for (auto it = al.begin(); it!=al.end();)
  {
    Argument a = *it;
    linkifyText(TextGeneratorOLImpl(ol),a.type,options);
    if (!a.name.empty())
    {
      ol.docify(" ");
      ol.docify(a.name);
    }
    if (!a.defval.empty())
    {
      ol.docify(" = ");
      ol.docify(a.defval);
    }
    ++it;
    if (it!=al.end()) ol.docify(", ");
  }
  ol.docify("> ");
  if (writeReqClause && !m_requiresClause.empty())
  {
    ol.lineBreak();
    ol.docify("requires ");
    linkifyText(TextGeneratorOLImpl(ol), // out
        m_requiresClause,        // text
        LinkifyTextOptions(options).setAutoBreak(true).setBreakThreshold(120));
  }
}

References ArgumentList::begin(), Argument::defval, OutputList::docify(), DString::empty(), ArgumentList::end(), getFileDef(), OutputList::lineBreak(), linkifyText(), m_requiresClause, Argument::name, LinkifyTextOptions::setFileScope(), LinkifyTextOptions::setScope(), LinkifyTextOptions::setSelf(), and Argument::type.

Referenced by writeDeclaration(), and writeDocumentation().

◆ _writeTypeConstraints()

void MemberDefImpl::_writeTypeConstraints ( OutputList & ol ) const

private

Definition at line 3165 of file memberdef.cpp.

{
  if (m_typeConstraints.hasParameters())
  {
    writeTypeConstraints(ol,this,m_typeConstraints);
  }
}

References ArgumentList::hasParameters(), m_typeConstraints, and writeTypeConstraints().

Referenced by writeDocumentation().

◆ addExample()

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

overridevirtual

Implements MemberDefMutable.

Definition at line 1662 of file memberdef.cpp.

{
  //printf("%s::addExample(%s,%s,%s)\n",qPrint(name()),anchor,nameStr,file);
  return m_examples.inSort(Example(anchor,nameStr,file));
}

References anchor(), ExampleList::inSort(), and m_examples.

◆ addListReference()

void MemberDefImpl::addListReference ( const Definition * )

overridevirtual

Implements MemberDefMutable.

Definition at line 4573 of file memberdef.cpp.

{
  bool optimizeOutputForC = Config_getBool(OPTIMIZE_OUTPUT_FOR_C);
  SrcLangExt lang = getLanguage();
  if (!isLinkableInProject()) return;
  DString memLabel;
  if (optimizeOutputForC)
  {
    memLabel=theTranslator->trGlobal(true,true);
  }
  else if (lang==SrcLangExt::Fortran)
  {
    memLabel=theTranslator->trSubprogram(true,true);
  }
  else
  {
    memLabel=theTranslator->trMember(true,true);
  }
  DString memName = name();
  Definition *pd=getOuterScope();
  DString pdName = pd->definitionType()==Definition::TypeClass ?
                    (toClassDef(pd))->displayName() : pd->name();
  DString sep = getLanguageSpecificSeparator(lang,true);
  DString memArgs;
  if (!isRelated())
  {
    if (isObjCMethod())
    {
      memName = "[" + pd->name() + " " + name() + "]";
    }
    else
    {
      if (pd!=Doxygen::globalScope) memName.prepend(pdName+sep);
      memArgs = argsString();
    }
  }
  const RefItemVector &xrefItems = xrefListItems();
  if (sep!="::")
  {
    memName = substitute(memName,"::",sep);
  }
  addRefItem(xrefItems,
        qualifiedName()+argsString(), // argsString is needed for overloaded functions (see bug 609624)
        memLabel,
        getOutputFileBase()+"#"+anchor(),memName,memArgs,pd);
}

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(), DString::prepend(), qualifiedName(), substitute(), theTranslator, toClassDef(), Translator::trGlobal(), Translator::trMember(), Translator::trSubprogram(), Definition::TypeClass, and DefinitionMixin< MemberDefMutable >::xrefListItems().

◆ addQualifiers()

void MemberDefImpl::addQualifiers ( const StringVector & qualifiers )

overridevirtual

Implements MemberDefMutable.

Definition at line 5900 of file memberdef.cpp.

{
  for (const auto &sx : qualifiers)
  {
    bool alreadyAdded = std::find(m_qualifiers.begin(), m_qualifiers.end(), sx) != m_qualifiers.end();
    if (!alreadyAdded)
    {
      m_qualifiers.push_back(sx);
    }
  }
}

References m_qualifiers.

◆ addRequirementReferences()

void MemberDefImpl::addRequirementReferences ( const Definition * )

overridevirtual

Implements MemberDefMutable.

Definition at line 4620 of file memberdef.cpp.

{
  RequirementManager::instance().addRequirementRefsForSymbol(this);
}

References RequirementManager::addRequirementRefsForSymbol(), and RequirementManager::instance().

◆ anchor()

DString MemberDefImpl::anchor ( ) const

overridevirtual

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

Implements Definition.

Definition at line 1804 of file memberdef.cpp.

{
  DString result=m_anc;
  if (m_groupAlias)     return m_groupAlias->anchor();
  if (m_templateMaster) return m_templateMaster->anchor();
  if (anonymousMemberForDetails()) return anonymousMemberForDetails()->anchor();
  if (m_enumScope && m_enumScope!=this) // avoid recursion for C#'s public enum E { E, F }
  {
    result.prepend(m_enumScope->anchor());
  }
  if (getGroupDef())
  {
    if (m_groupMember)
    {
      result=m_groupMember->anchor();
    }
    else if (getReference().empty())
    {
      result.prepend("g");
    }
  }
  return result;
}

References Definition::anchor(), anonymousMemberForDetails(), getGroupDef(), getReference(), m_anc, m_enumScope, m_groupAlias, m_groupMember, m_templateMaster, and DString::prepend().

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

◆ anonymousMemberForDeclaration()

const MemberDef * MemberDefImpl::anonymousMemberForDeclaration ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5582 of file memberdef.cpp.

{
  return m_annMemberForDecl;
}

References m_annMemberForDecl.

◆ anonymousMemberForDetails()

const MemberDef * MemberDefImpl::anonymousMemberForDetails ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5587 of file memberdef.cpp.

{
  return m_annMemberForDetails;
}

References m_annMemberForDetails.

Referenced by anchor(), and getOutputFileBase().

◆ argsString()

DString MemberDefImpl::argsString ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5087 of file memberdef.cpp.

{
  return m_args;
}

References m_args.

Referenced by addListReference(), isFunctionPtr(), sourceRefName(), warnIfUndocumented(), writeDeclaration(), writeDocumentation(), writeMemberDocSimple(), and writeTagFile().

◆ argumentList()

const ArgumentList & MemberDefImpl::argumentList ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5647 of file memberdef.cpp.

{
  return m_defArgList;
}

References m_defArgList.

Referenced by detectUndocumentedParams(), and warnIfUndocumentedParams().

◆ bitfieldString()

DString MemberDefImpl::bitfieldString ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5097 of file memberdef.cpp.

{
  return m_bitfields;
}

References m_bitfields.

◆ briefDescription()

DString 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 6437 of file memberdef.cpp.

{
  if (m_templateMaster)
  {
    return m_templateMaster->briefDescription(abbr);
  }
  else
  {
    return DefinitionMixin::briefDescription(abbr);
  }
}

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

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

◆ cacheTypedefVal()

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

overridevirtual

Implements MemberDefMutable.

Definition at line 6113 of file memberdef.cpp.

{
  m_isTypedefValCached=true;
  m_cachedTypedefValue=val;
  m_cachedTypedefTemplSpec=templSpec;
  m_cachedResolvedType=resolvedType;
  //printf("MemberDefImpl::cacheTypedefVal=%s m_impl=%p\n",qPrint(m_cachedResolvedType),m_impl);
}

References m_cachedResolvedType, m_cachedTypedefTemplSpec, m_cachedTypedefValue, and m_isTypedefValCached.

◆ category()

ClassDef * MemberDefImpl::category ( ) const

overridevirtual

Implements MemberDef.

Definition at line 6073 of file memberdef.cpp.

{
  return m_category;
}

References m_category.

◆ categoryRelation()

const MemberDef * MemberDefImpl::categoryRelation ( ) const

overridevirtual

Implements MemberDef.

Definition at line 6083 of file memberdef.cpp.

{
  return m_categoryRelation;
}

References m_categoryRelation.

◆ codeSymbolType()

CodeSymbolType MemberDefImpl::codeSymbolType ( ) const

overridevirtual

Used for syntax highlighting symbol class

Implements Definition.

Definition at line 6524 of file memberdef.cpp.

{
  switch (memberType())
  {
    case MemberType::Define:      return CodeSymbolType::Define;
    case MemberType::Function:    return CodeSymbolType::Function;
    case MemberType::Variable:    return CodeSymbolType::Variable;
    case MemberType::Typedef:     return CodeSymbolType::Typedef;
    case MemberType::Enumeration: return CodeSymbolType::Enumeration;
    case MemberType::EnumValue:   return CodeSymbolType::EnumValue;
    case MemberType::Signal:      return CodeSymbolType::Signal;
    case MemberType::Slot:        return CodeSymbolType::Slot;
    case MemberType::Friend:      return CodeSymbolType::Friend;
    case MemberType::DCOP:        return CodeSymbolType::DCOP;
    case MemberType::Property:    return CodeSymbolType::Property;
    case MemberType::Event:       return CodeSymbolType::Event;
    case MemberType::Interface:   return CodeSymbolType::Interface;
    case MemberType::Service:     return CodeSymbolType::Service;
    case MemberType::Sequence:    return CodeSymbolType::Sequence;
    case MemberType::Dictionary:  return CodeSymbolType::Dictionary;
  }
  return CodeSymbolType::Default;
}

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 6122 of file memberdef.cpp.

{
  {
    const ArgumentList &srcAl = bmd->argumentList();
    ArgumentList &dstAl = m_defArgList;
    auto srcIt = srcAl.begin();
    auto dstIt = dstAl.begin();
    while ( srcIt!=srcAl.end() && dstIt!=dstAl.end())
    {
      Argument &argDst       = *dstIt;
      const Argument &argSrc = *srcIt;
      if (!argSrc.name.empty())
      {
        argDst.name = argSrc.name;
      }
      argDst.docs = argSrc.docs;
      ++srcIt;
      ++dstIt;
    }
  }
 
  {
    const ArgumentList &srcAl = bmd->declArgumentList();
    ArgumentList &dstAl = m_declArgList;
    auto srcIt = srcAl.begin();
    auto dstIt = dstAl.begin();
 
    while ( srcIt!=srcAl.end() && dstIt!=dstAl.end())
    {
      Argument &argDst       = *dstIt;
      const Argument &argSrc = *srcIt;
      if (!argSrc.name.empty())
      {
        argDst.name = argSrc.name;
      }
      argDst.docs = argSrc.docs;
      ++srcIt;
      ++dstIt;
    }
  }
}

References MemberDef::argumentList(), ArgumentList::begin(), MemberDef::declArgumentList(), Argument::docs, DString::empty(), 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 4494 of file memberdef.cpp.

{
  //printf("  Member %s %s %s\n",qPrint(typeString()),qPrint(name()),qPrint(argsString()));
  std::unique_ptr<ArgumentList> actualArgList = std::make_unique<ArgumentList>(m_defArgList);
  if (!m_defArgList.empty())
  {
    // replace formal arguments with actuals
    for (Argument &arg : *actualArgList)
    {
      arg.type = substituteTemplateArgumentsInString(arg.type,formalArgs,actualArgs.get());
    }
    actualArgList->setTrailingReturnType(
       substituteTemplateArgumentsInString(actualArgList->trailingReturnType(),formalArgs,actualArgs.get()));
  }
 
  DString methodName=name();
  if (methodName.startsWith("operator ")) // conversion operator
  {
    methodName=substituteTemplateArgumentsInString(methodName,formalArgs,actualArgs.get());
  }
 
  auto imd = createMemberDef(
                       getDefFileName(),getDefLine(),getDefColumn(),
                       substituteTemplateArgumentsInString(m_type,formalArgs,actualArgs.get()),
                       methodName,
                       substituteTemplateArgumentsInString(m_args,formalArgs,actualArgs.get()),
                       m_exception, m_prot,
                       m_virt, m_stat, m_related, m_mtype,
                       ArgumentList(), ArgumentList(), ""
                   );
  auto mmd = toMemberDefMutable(imd.get());
  mmd->moveArgumentList(std::move(actualArgList));
  mmd->setDefinition(substituteTemplateArgumentsInString(m_def,formalArgs,actualArgs.get()));
  mmd->setBodyDef(getBodyDef());
  mmd->setBodySegment(getDefLine(),getStartBodyLine(),getEndBodyLine());
  mmd->setFormalTemplateArguments(formalArgs);
 
  // TODO: init other member variables (if needed).
  // TODO: reimplemented info
  return imd;
}

References createMemberDef(), ArgumentList::empty(), 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(), DString::startsWith(), substituteTemplateArgumentsInString(), and toMemberDefMutable().

◆ declaration()

DString MemberDefImpl::declaration ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5067 of file memberdef.cpp.

{
  return m_decl;
}

References m_decl.

◆ declArgumentList()

const ArgumentList & MemberDefImpl::declArgumentList ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5652 of file memberdef.cpp.

{
  return m_declArgList;
}

References m_declArgList.

Referenced by detectUndocumentedParams(), and warnIfUndocumentedParams().

◆ deepCopy()

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

overridevirtual

Implements MemberDef.

Definition at line 1480 of file memberdef.cpp.

{
  std::unique_ptr<MemberDefImpl> result(new MemberDefImpl(
        getDefFileName(),getDefLine(),getDefColumn(),m_type,localName(),m_args,m_exception,
        m_prot,m_virt,m_stat,m_related,m_mtype,m_tArgList,m_defArgList,m_metaData));
  // first copy base members
  result->DefinitionMixin<MemberDefMutable>::operator=(*this);
  // then copy other members
  result->m_typeConstraints                = m_typeConstraints                ;
  result->m_declArgList                    = m_declArgList                    ;
  result->m_classDef                       = m_classDef                       ;
  result->m_fileDef                        = m_fileDef                        ;
  result->m_moduleDef                      = m_moduleDef                      ;
  result->m_nspace                         = m_nspace                         ;
  result->m_enumScope                      = m_enumScope                      ;
  result->m_livesInsideEnum                = m_livesInsideEnum                ;
  result->m_annEnumType                    = m_annEnumType                    ;
  result->m_annMemberForDecl               = m_annMemberForDecl               ;
  result->m_annMemberForDetails            = m_annMemberForDetails            ;
  result->m_enumFields                     = m_enumFields                     ;
  result->m_redefines                      = m_redefines                      ;
  result->m_redefinedBy                    = m_redefinedBy                    ;
  result->m_memDef                         = m_memDef                         ;
  result->m_memDec                         = m_memDec                         ;
  result->m_relatedAlso                    = m_relatedAlso                    ;
  result->m_examples                       = m_examples                       ;
  result->m_def                            = m_def                            ;
  result->m_anc                            = m_anc                            ;
  result->m_decl                           = m_decl                           ;
  result->m_bitfields                      = m_bitfields                      ;
  result->m_read                           = m_read                           ;
  result->m_write                          = m_write                          ;
  result->m_exception                      = m_exception                      ;
  result->m_initializer                    = m_initializer                    ;
  result->m_extraTypeChars                 = m_extraTypeChars                 ;
  result->m_enumBaseType                   = m_enumBaseType                   ;
  result->m_requiresClause                 = m_requiresClause                 ;
  result->m_initLines                      = m_initLines                      ;
  result->m_memSpec                        = m_memSpec                        ;
  result->m_vhdlSpec                       = m_vhdlSpec                       ;
  result->m_maxInitLines                   = m_maxInitLines                   ;
  result->m_userInitLines                  = m_userInitLines                  ;
  result->m_defArgList                     = m_defArgList                     ;
  result->m_declArgList                    = m_declArgList                    ;
  result->m_tArgList                       = m_tArgList                       ;
  result->m_typeConstraints                = m_typeConstraints                ;
  result->m_templateMaster                 = m_templateMaster                 ;
  result->m_formalTemplateArguments        = m_formalTemplateArguments        ;
  result->m_defTmpArgLists                 = m_defTmpArgLists                 ;
  result->m_anonymousType                  = m_anonymousType                  ;
  result->m_sectionMap                     = m_sectionMap                     ;
  result->m_groupAlias                     = m_groupAlias                     ;
  result->m_grpId                          = m_grpId                          ;
  result->m_memberGroup                    = m_memberGroup                    ;
  result->m_group                          = m_group                          ;
  result->m_grouppri                       = m_grouppri                       ;
  result->m_groupFileName                  = m_groupFileName                  ;
  result->m_groupStartLine                 = m_groupStartLine                 ;
  result->m_groupMember                    = m_groupMember                    ;
  result->m_isTypedefValCached             = m_isTypedefValCached             ;
  result->m_cachedTypedefValue             = m_cachedTypedefValue             ;
  result->m_cachedTypedefTemplSpec         = m_cachedTypedefTemplSpec         ;
  result->m_cachedResolvedType             = m_cachedResolvedType             ;
  result->m_docProvider                    = m_docProvider                    ;
  result->m_explicitOutputFileBase         = m_explicitOutputFileBase         ;
  result->m_qualifiers                     = m_qualifiers                     ;
  result->m_implOnly                       = m_implOnly                       ;
  result->m_hasDocumentedParams            = m_hasDocumentedParams            ;
  result->m_hasDocumentedReturnType        = m_hasDocumentedReturnType        ;
  result->m_isDMember                      = m_isDMember                      ;
  result->m_proto                          = m_proto                          ;
  result->m_docEnumValues                  = m_docEnumValues                  ;
  result->m_hasDetailedDescriptionCached   = m_hasDetailedDescriptionCached   ;
  result->m_detailedDescriptionCachedValue = m_detailedDescriptionCachedValue ;
  result->m_hasCallGraph                   = m_hasCallGraph                   ;
  result->m_hasCallerGraph                 = m_hasCallerGraph                 ;
  result->m_hasReferencedByRelation        = m_hasReferencedByRelation        ;
  result->m_hasReferencesRelation          = m_hasReferencesRelation          ;
  result->m_hasEnumValues                  = m_hasEnumValues                  ;
  result->m_hasInlineSource                = m_hasInlineSource                ;
  result->m_explExt                        = m_explExt                        ;
  result->m_tspec                          = m_tspec                          ;
  result->m_groupHasDocs                   = m_groupHasDocs                   ;
  result->m_docsForDefinition              = m_docsForDefinition              ;
  result->m_category                       = m_category                       ;
  result->m_categoryRelation               = m_categoryRelation               ;
  result->m_declFileName                   = m_declFileName                   ;
  result->m_declLine                       = m_declLine                       ;
  result->m_declColumn                     = m_declColumn                     ;
  result->m_numberOfFlowKW                 = m_numberOfFlowKW                 ;
  result->setDefinitionTemplateParameterLists(m_defTmpArgLists);
  if (m_incInfo)
  {
    result->m_incInfo = std::make_unique<IncludeInfo>();
    *(result->m_incInfo) = *m_incInfo;
  }
 
  result->m_isLinkableCached    = 0;
  result->m_isConstructorCached = 0;
  result->m_isDestructorCached  = 0;
  return result;
}

References DefinitionMixin< MemberDefMutable >::getDefColumn(), DefinitionMixin< MemberDefMutable >::getDefFileName(), DefinitionMixin< MemberDefMutable >::getDefLine(), DefinitionMixin< MemberDefMutable >::localName(), m_anc, m_annEnumType, m_annMemberForDecl, m_annMemberForDetails, m_anonymousType, m_args, m_bitfields, 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_incInfo, 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()

DString MemberDefImpl::definition ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5072 of file memberdef.cpp.

{
  return m_def;
}

References m_def.

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

◆ definitionTemplateParameterLists()

const ArgumentLists & MemberDefImpl::definitionTemplateParameterLists ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5710 of file memberdef.cpp.

{
  return m_defTmpArgLists;
}

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; }

Definition::TypeMember

@ TypeMember

Definition definition.h:88

References definitionType(), and Definition::TypeMember.

Referenced by definitionType().

◆ detectUndocumentedParams()

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

overridevirtual

Implements MemberDef.

Definition at line 4255 of file memberdef.cpp.

{
  //printf("%s:detectUndocumentedParams(%d,%d)\n",qPrint(name()),hasParamCommand,hasReturnCommand);
  bool isPython = getLanguage()==SrcLangExt::Python;
 
  // this function is called while parsing the documentation. A member can have multiple
  // documentation blocks, which could be handled by multiple threads, hence this guard.
  std::lock_guard<std::mutex> lock(g_detectUndocumentedParamsMutex);
 
  if (!m_hasDocumentedParams && hasParamCommand)
  {
    //printf("%s:hasDocumentedParams=true;\n",qPrint(name()));
    m_hasDocumentedParams = true;
  }
  else if (!m_hasDocumentedParams)
  {
    const ArgumentList &al     = argumentList();
    const ArgumentList &declAl = declArgumentList();
    bool allDoc=true; // no parameter => all parameters are documented
    if ( // member has parameters
        al.hasParameters()  // with at least one parameter (that is not void)
       )
    {
      // see if all parameters have documentation
      for (auto it = al.begin(); it!=al.end() && allDoc; ++it)
      {
        const Argument &a = *it;
        if (!a.name.empty() && a.type!="void" && a.name!="..." &&
            !(isPython && (a.name=="self" || a.name=="cls"))
           )
        {
          allDoc = !a.docs.empty();
        }
        //printf("a.type=%s a.name=%s doc=%s\n",
        //        qPrint(a.type),qPrint(a.name),qPrint(a.docs));
      }
      if (!allDoc && declAl.empty()) // try declaration arguments as well
      {
        allDoc=true;
        for (auto it = al.begin(); it!=al.end() && allDoc; ++it)
        {
          const Argument &a = *it;
          if (!a.name.empty() && a.type!="void" && a.name!="..." &&
              !(isPython && (a.name=="self" || a.name=="cls"))
             )
          {
            allDoc = !a.docs.empty();
          }
          //printf("a.name=%s doc=%s\n",qPrint(a.name),qPrint(a.docs));
        }
      }
    }
    if (allDoc)
    {
      //printf("%s:hasDocumentedParams=true;\n",qPrint(name()));
      m_hasDocumentedParams = true;
    }
  }
 
  //printf("Member %s hasDocumentedReturnType=%d hasReturnCommand=%d\n",
  //    qPrint(name()),m_hasDocumentedReturnType,hasReturnCommand);
  m_hasDocumentedReturnType = m_hasDocumentedReturnType || hasReturnCommand;
}

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

◆ displayDefinition()

DString MemberDefImpl::displayDefinition ( ) const

overridevirtual

Implements MemberDef.

Definition at line 3277 of file memberdef.cpp.

{
  DString ldef = definition();
  DString title = name();
  if (isEnumerate())
  {
    if (isAnonymous())
    {
      ldef = title = "anonymous enum";
      if (!m_enumBaseType.empty())
      {
        ldef+=" : "+m_enumBaseType;
      }
    }
    else
    {
      ldef.prepend("enum ");
      if (isSliceLocal())
      {
        ldef.prepend("local ");
      }
    }
  }
  else if (isEnumValue())
  {
    if (isAnonymous())
    {
      ldef=ldef.mid(2);
    }
  }
 
  std::string sdef = ldef.str();
  reg::Match match;
  if (reg::search(sdef,match,reAnonymous))
  {
    const ClassDef *annoClassDef=getClassDefOfAnonymousType();
    if (annoClassDef)
    {
      static const reg::Ex ar(R"([\w@:]*@\d+[\w@:]*)");
      reg::Match amatch;
      reg::search(sdef,amatch,ar);
      ldef = amatch.prefix().str() + annoClassDef->displayName() + amatch.suffix().str();
    }
    else
    {
      ldef = match.prefix().str() + " { ... } " + removeAnonymousScopes(match.suffix().str());
    }
  }
 
  const ClassDef *cd=getClassDef();
  if (cd && cd->isObjectiveC())
  {
    // strip scope name
    if (size_t ep = ldef.find("::"); ep!=DString::npos)
    {
      if (size_t sp=ldef.rfind(' ',ep); sp!=DString::npos)
      {
        ldef=ldef.left(sp+1)+ldef.mid(ep+2);
      }
    }
    // strip keywords
    if (size_t dp = ldef.find(':'); dp!=DString::npos)
    {
      ldef=ldef.left(dp+1);
    }
    int l=static_cast<int>(ldef.length());
    //printf("start >%s<\n",qPrint(ldef));
    int i=l-1;
    while (i>=0 && (isId(ldef.at(i)) || ldef.at(i)==':')) i--;
    while (i>=0 && isspace(static_cast<uint8_t>(ldef.at(i)))) i--;
    if (i>0)
    {
      // insert branches around the type
      ldef = "("+ldef.left(i+1)+")"+ldef.mid(i+1);
    }
    //printf("end   >%s< i=%d\n",qPrint(ldef),i);
    if (isStatic()) ldef.prepend("+ "); else ldef.prepend("- ");
  }
  SrcLangExt lang = getLanguage();
  DString sep = getLanguageSpecificSeparator(lang,true);
  return substitute(ldef,"::",sep);
}

References DString::at(), definition(), Definition::displayName(), DString::empty(), DString::find(), getClassDef(), getClassDefOfAnonymousType(), DefinitionMixin< MemberDefMutable >::getLanguage(), getLanguageSpecificSeparator(), DefinitionMixin< MemberDefMutable >::isAnonymous(), isEnumerate(), isEnumValue(), isId(), ClassDef::isObjectiveC(), isSliceLocal(), isStatic(), DString::left(), DString::length(), m_enumBaseType, DString::mid(), DefinitionMixin< MemberDefMutable >::name(), DString::npos, reg::Match::prefix(), DString::prepend(), reAnonymous, removeAnonymousScopes(), DString::rfind(), reg::search(), DString::str(), reg::SubMatch::str(), substitute(), and reg::Match::suffix().

◆ displayName()

DString MemberDefImpl::displayName ( bool includeScope = true ) const

overridevirtual

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

Implements Definition.

Definition at line 6190 of file memberdef.cpp.

{
  return DefinitionMixin::name();
}

References DefinitionMixin< Base >::name().

Referenced by addListReference(), and writeDocumentation().

◆ documentation()

DString MemberDefImpl::documentation ( ) const

overridevirtual

Returns the detailed description of this definition

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 6449 of file memberdef.cpp.

{
  if (m_templateMaster)
  {
    return m_templateMaster->documentation();
  }
  else
  {
    return DefinitionMixin::documentation();
  }
}

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

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

◆ enumBaseType()

DString MemberDefImpl::enumBaseType ( ) const

overridevirtual

Implements MemberDef.

Definition at line 6098 of file memberdef.cpp.

{
  return m_enumBaseType;
}

References m_enumBaseType.

◆ enumFieldList()

const MemberVector & MemberDefImpl::enumFieldList ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5632 of file memberdef.cpp.

{
  return m_enumFields;
}

References m_enumFields.

Referenced by _writeEnumValues(), and warnIfUndocumented().

◆ excpString()

DString MemberDefImpl::excpString ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5092 of file memberdef.cpp.

{
  return m_exception;
}

References m_exception.

Referenced by writeDeclaration(), and writeDocumentation().

◆ extraTypeChars()

DString MemberDefImpl::extraTypeChars ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5077 of file memberdef.cpp.

{
  return m_extraTypeChars;
}

References m_extraTypeChars.

◆ fieldType()

DString MemberDefImpl::fieldType ( ) const

overridevirtual

Implements MemberDef.

Definition at line 4028 of file memberdef.cpp.

{
  DString type = m_type;
  if (isTypedef() && getLanguage() != SrcLangExt::Slice) type.prepend("typedef ");
  return simplifyTypeForTable(type);
}

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

Referenced by writeMemberDocSimple().

◆ findSectionsInDocumentation()

void MemberDefImpl::findSectionsInDocumentation ( )

overridevirtual

Implements MemberDefMutable.

Definition at line 4956 of file memberdef.cpp.

{
  docFindSections(briefDescription(),this,docFile());
  docFindSections(documentation(),this,docFile());
  docFindSections(inbodyDocumentation(),this,docFile());
}

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

◆ formalTemplateArguments()

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

overridevirtual

Implements MemberDef.

Definition at line 5786 of file memberdef.cpp.

{
  return m_formalTemplateArguments;
}

References m_formalTemplateArguments.

◆ getAnonymousEnumType()

const MemberDef * MemberDefImpl::getAnonymousEnumType ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5577 of file memberdef.cpp.

{
  return m_annEnumType;
}

References m_annEnumType.

Referenced by writeDeclaration(), and writeDocumentation().

◆ getCachedResolvedTypedef()

DString MemberDefImpl::getCachedResolvedTypedef ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5806 of file memberdef.cpp.

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

References m_cachedResolvedType.

◆ getCachedTypedefTemplSpec()

DString MemberDefImpl::getCachedTypedefTemplSpec ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5801 of file memberdef.cpp.

{
  return m_cachedTypedefTemplSpec;
}

References m_cachedTypedefTemplSpec.

◆ getCachedTypedefVal()

const ClassDef * MemberDefImpl::getCachedTypedefVal ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5796 of file memberdef.cpp.

{
  return m_cachedTypedefValue;
}

References m_cachedTypedefValue.

◆ getClassDef() [1/2]

const ClassDef * MemberDefImpl::getClassDef ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5127 of file memberdef.cpp.

{
  return m_classDef;
}

References m_classDef.

Referenced by _computeIsConstructor(), _computeLinkableInProject(), _writeCategoryRelation(), _writeReimplementedBy(), displayDefinition(), getLabels(), getOutputFileBase(), getReference(), getScopeString(), hasDetailedDescription(), isBriefSectionVisible(), isCSharpProperty(), isDetailedSectionVisible(), isObjCMethod(), isObjCProperty(), objCMethodName(), qualifiedName(), warnIfUndocumented(), writeDeclaration(), writeDocumentation(), and writeLink().

◆ getClassDef() [2/2]

ClassDef * MemberDefImpl::getClassDef ( )

overridevirtual

Implements MemberDef.

Definition at line 5132 of file memberdef.cpp.

{
  return m_classDef;
}

References m_classDef.

◆ getClassDefMutable()

ClassDefMutable * MemberDefImpl::getClassDefMutable ( )

overridevirtual

Implements MemberDefMutable.

Definition at line 5137 of file memberdef.cpp.

{
  return toClassDefMutable(m_classDef);
}

References m_classDef, and toClassDefMutable().

◆ getClassDefOfAnonymousType()

const 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 2031 of file memberdef.cpp.

{
  return m_anonymousType;
}

References m_anonymousType.

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

◆ getDeclColumn()

size_t MemberDefImpl::getDeclColumn ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5842 of file memberdef.cpp.

{
  return m_declColumn;
}

References m_declColumn.

◆ getDeclFileName()

DString MemberDefImpl::getDeclFileName ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5832 of file memberdef.cpp.

{
  return m_declFileName;
}

References m_declFileName.

◆ getDeclLine()

int MemberDefImpl::getDeclLine ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5837 of file memberdef.cpp.

{
  return m_declLine;
}

References m_declLine.

◆ getDeclType()

DString MemberDefImpl::getDeclType ( ) const

overridevirtual

Implements MemberDef.

Definition at line 2128 of file memberdef.cpp.

{
  SrcLangExt lang = getLanguage();
  DString ltype(m_type);
  if (lang==SrcLangExt::Cpp && isEnumerate() && isStrong())
  {
    if (isEnumStruct())
    {
      ltype+=" struct";
    }
    else
    {
      ltype+=" class";
    }
  }
  if (isTypedef() && getLanguage() != SrcLangExt::Slice)
  {
    ltype.prepend("typedef ");
  }
  if (isTypeAlias())
  {
    if (lang==SrcLangExt::Python)
    {
      ltype="type";
    }
    else
    {
      ltype="using";
    }
  }
  // strip 'friend' keyword from ltype
  ltype.stripPrefix("friend ");
  if (ltype=="@") // rename type from enum values
  {
    ltype="";
  }
  else
  {
    if (isObjCMethod())
    {
      ltype.prepend("(");
      ltype.append(")");
    }
  }
  return ltype;
}

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

◆ getEnumScope()

const MemberDef * MemberDefImpl::getEnumScope ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5597 of file memberdef.cpp.

{
  return m_enumScope;
}

References m_enumScope.

Referenced by getOutputFileBase(), and writeLink().

◆ getExamples()

const ExampleList & MemberDefImpl::getExamples ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5637 of file memberdef.cpp.

{
  return m_examples;
}

References m_examples.

◆ getFileDef() [1/2]

const FileDef * MemberDefImpl::getFileDef ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5142 of file memberdef.cpp.

{
  return m_fileDef;
}

References m_fileDef.

Referenced by _computeLinkableInProject(), _writeGroupInclude(), _writeMultiLineInitializer(), _writeTemplatePrefix(), getOutputFileBase(), getReference(), hasDetailedDescription(), sourceRefName(), warnIfUndocumented(), writeDeclaration(), and writeDocumentation().

◆ getFileDef() [2/2]

FileDef * MemberDefImpl::getFileDef ( )

overridevirtual

Implements MemberDef.

Definition at line 5147 of file memberdef.cpp.

{
  return m_fileDef;
}

References m_fileDef.

◆ getGroupAlias()

const MemberDef * MemberDefImpl::getGroupAlias ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5827 of file memberdef.cpp.

{
  return m_groupAlias;
}

References m_groupAlias.

◆ getGroupDef() [1/2]

const GroupDef * MemberDefImpl::getGroupDef ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5172 of file memberdef.cpp.

{
  return m_group;
}

References m_group.

Referenced by _computeLinkableInProject(), anchor(), getOutputFileBase(), getReference(), hasDetailedDescription(), isDetailedSectionVisible(), warnIfUndocumented(), writeDeclaration(), writeDocumentation(), and writeLink().

◆ getGroupDef() [2/2]

GroupDef * MemberDefImpl::getGroupDef ( )

overridevirtual

Implements MemberDef.

Definition at line 5177 of file memberdef.cpp.

{
  return m_group;
}

References m_group.

◆ getGroupFileName()

DString MemberDefImpl::getGroupFileName ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5192 of file memberdef.cpp.

{
  return m_groupFileName;
}

References m_groupFileName.

◆ getGroupHasDocs()

bool MemberDefImpl::getGroupHasDocs ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5202 of file memberdef.cpp.

{
  return m_groupHasDocs;
}

References m_groupHasDocs.

◆ getGroupPri()

Grouping::GroupPri_t MemberDefImpl::getGroupPri ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5187 of file memberdef.cpp.

{
  return m_grouppri;
}

References m_grouppri.

◆ getGroupStartLine()

int MemberDefImpl::getGroupStartLine ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5197 of file memberdef.cpp.

{
  return m_groupStartLine;
}

References m_groupStartLine.

◆ getLabels()

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

overridevirtual

Implements MemberDef.

Definition at line 2769 of file memberdef.cpp.

{
  StringVector sl;
  bool inlineInfo = Config_getBool(INLINE_INFO);
  bool inherited = getClassDef() &&
                   (getClassDef()!=container || m_explicitInherited) &&
                   container->definitionType()==TypeClass &&
                   !isRelated();
  Specifier lvirt=virtualness();
  if ((!isObjCMethod() || isOptional() || isRequired()) &&
      (protection()!=Protection::Public || lvirt!=Specifier::Normal ||
       isFriend() || isRelated() ||
       (isInline() && inlineInfo) ||
       isSignal() || isSlot() ||
       isStatic() || isExternal() ||
       isExported() ||
       inherited ||
       TypeSpecifier(m_memSpec).setInline(false)!=TypeSpecifier()
      )
     )
  {
    // write the member specifier list
    //ol.writeLatexSpacing();
    //ol.startTypewriter();
    //ol.docify(" [");
    SrcLangExt lang = getLanguage();
    bool optVhdl = lang==SrcLangExt::VHDL;
    bool extractPrivate = Config_getBool(EXTRACT_PRIVATE);
    if (optVhdl)
    {
      sl.push_back(theTranslator->trVhdlType(getVhdlSpecifiers(),true).str());
    }
    else
    {
      if (isFriend())                                   sl.emplace_back("friend");
      else if (isRelated())                             sl.emplace_back("related");
      else
      {
        if      (isExternal())                          sl.emplace_back("extern");
        if      (inlineInfo && isInline())              sl.emplace_back("inline");
        if      (isExplicit())                          sl.emplace_back("explicit");
        if      (isMutable())                           sl.emplace_back("mutable");
        if      (isThreadLocal())                       sl.emplace_back("thread_local");
        if      (isStatic())                            sl.emplace_back("static");
        if      (isGettable())                          sl.emplace_back("get");
        if      (isProtectedGettable())                 sl.emplace_back("protected get");
        if      (isSettable())                          sl.emplace_back("set");
        if      (isProtectedSettable())                 sl.emplace_back("protected set");
        if      (isProperty() && isInitonly())          sl.emplace_back("init");
        if (extractPrivate)
        {
          if    (isPrivateGettable())                   sl.emplace_back("private get");
          if    (isPrivateSettable())                   sl.emplace_back("private set");
        }
        if      (isNoDiscard())                         sl.emplace_back("nodiscard");
        if      (isConstExpr())                         sl.emplace_back("constexpr");
        if      (isConstEval())                         sl.emplace_back("consteval");
        if      (isConstInit())                         sl.emplace_back("constinit");
        if      (isAddable())                           sl.emplace_back("add");
        if      (!isUNOProperty() && isRemovable())     sl.emplace_back("remove");
        if      (isRaisable())                          sl.emplace_back("raise");
        if      (isReadable())                          sl.emplace_back("read");
        if      (isWritable())                          sl.emplace_back("write");
        if      (isFinal())                             sl.emplace_back("final");
        if      (isAbstract())                          sl.emplace_back("abstract");
        if      (isOverride())                          sl.emplace_back("override");
        if      (!isProperty() && isInitonly())         sl.emplace_back("initonly");
        if      (isSealed())                            sl.emplace_back("sealed");
        if      (isNew())                               sl.emplace_back("new");
        if      (isOptional())                          sl.emplace_back("optional");
        if      (isRequired())                          sl.emplace_back("required");
        if      (isExported())                          sl.emplace_back("export");
 
        if      (isNonAtomic())                         sl.emplace_back("nonatomic");
        else if (isObjCProperty())                      sl.emplace_back("atomic");
 
        // mutual exclusive Objective 2.0 property attributes
        if      (isAssign())                            sl.emplace_back("assign");
        else if (isCopy())                              sl.emplace_back("copy");
        else if (isRetain())                            sl.emplace_back("retain");
        else if (isWeak())                              sl.emplace_back("weak");
        else if (lang!=SrcLangExt::CSharp && isStrong()) sl.emplace_back("strong");
        else if (isUnretained())                        sl.emplace_back("unsafe_unretained");
 
        if (!isObjCMethod())
        {
          if      (protection()==Protection::Protected) sl.emplace_back("protected");
          else if (protection()==Protection::Private)   sl.emplace_back("private");
          else if (protection()==Protection::Package)   sl.emplace_back("package");
 
          if      (lvirt==Specifier::Virtual)           sl.emplace_back("virtual");
          else if (lvirt==Specifier::Pure)              sl.emplace_back("pure virtual");
          if      (isSignal())                          sl.emplace_back("signal");
          if      (isSlot())                            sl.emplace_back("slot");
          if      (isDefault())                         sl.emplace_back("default");
          if      (isDelete())                          sl.emplace_back("delete");
          if      (isNoExcept())                        sl.emplace_back("noexcept");
          if      (isAttribute())                       sl.emplace_back("attribute");
          if      (isUNOProperty())                     sl.emplace_back("property");
          if      (isReadonly())                        sl.emplace_back("readonly");
          if      (isBound())                           sl.emplace_back("bound");
          if      (isUNOProperty() && isRemovable())    sl.emplace_back("removable");
          if      (isConstrained())                     sl.emplace_back("constrained");
          if      (isTransient())                       sl.emplace_back("transient");
          if      (isMaybeVoid())                       sl.emplace_back("maybevoid");
          if      (isMaybeDefault())                    sl.emplace_back("maybedefault");
          if      (isMaybeAmbiguous())                  sl.emplace_back("maybeambiguous");
          if      (isPublished())                       sl.emplace_back("published"); // enum
        }
        if (isObjCProperty() && isImplementation())
        {
          sl.emplace_back("implementation");
        }
      }
      if (inherited)
      {
        sl.emplace_back("inherited");
      }
    }
  }
  else if (isObjCMethod() && isImplementation())
  {
    sl.emplace_back("implementation");
  }
 
  for (const auto &sx : m_qualifiers)
  {
    bool alreadyAdded = std::find(sl.begin(), sl.end(), sx) != sl.end();
    if (!alreadyAdded)
    {
      sl.push_back(sx);
    }
  }
 
  return sl;
}

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(), isProperty(), isProtectedGettable(), isProtectedSettable(), isPublished(), isRaisable(), isReadable(), isReadonly(), isRelated(), isRemovable(), isRequired(), isRetain(), isSealed(), isSettable(), isSignal(), isSlot(), isStatic(), isStrong(), isThreadLocal(), isTransient(), isUNOProperty(), isUnretained(), isWeak(), isWritable(), m_explicitInherited, m_memSpec, m_qualifiers, protection(), theTranslator, Translator::trVhdlType(), Definition::TypeClass, and virtualness().

Referenced by writeDocumentation().

◆ getMemberGroup()

MemberGroup * MemberDefImpl::getMemberGroup ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5720 of file memberdef.cpp.

{
  return m_memberGroup;
}

References m_memberGroup.

◆ getMemberGroupId()

int MemberDefImpl::getMemberGroupId ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5715 of file memberdef.cpp.

{
  return m_grpId;
}

References m_grpId.

◆ getMemberSpecifiers()

TypeSpecifier MemberDefImpl::getMemberSpecifiers ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5117 of file memberdef.cpp.

{
  return m_memSpec;
}

References m_memSpec.

◆ getModuleDef()

const ModuleDef * MemberDefImpl::getModuleDef ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5182 of file memberdef.cpp.

{
  return m_moduleDef;
}

References m_moduleDef.

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

◆ getNamespaceDef() [1/2]

const NamespaceDef * MemberDefImpl::getNamespaceDef ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5152 of file memberdef.cpp.

{
  return m_nspace;
}

References m_nspace.

Referenced by _computeLinkableInProject(), getOutputFileBase(), getReference(), getScopeString(), hasDetailedDescription(), isDetailedSectionVisible(), warnIfUndocumented(), writeDeclaration(), writeDocumentation(), writeLink(), and writeTagFile().

◆ getNamespaceDef() [2/2]

NamespaceDef * MemberDefImpl::getNamespaceDef ( )

overridevirtual

Implements MemberDef.

Definition at line 5157 of file memberdef.cpp.

{
  return m_nspace;
}

References m_nspace.

◆ getOutputFileBase()

DString 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 1693 of file memberdef.cpp.

{
  bool separateMemberPages = Config_getBool(SEPARATE_MEMBER_PAGES);
  bool inlineSimpleClasses = Config_getBool(INLINE_SIMPLE_STRUCTS);
  DString baseName;
 
  //printf("Member: %s: templateMaster=%p group=%p classDef=%p nspace=%p fileDef=%p\n",
  //    qPrint(name()),m_templateMaster,m_group,m_classDef,
  //    m_nspace,m_fileDef);
  const NamespaceDef *nspace = getNamespaceDef();
  const FileDef *fileDef = getFileDef();
  const ClassDef *classDef = getClassDef();
  const ModuleDef *moduleDef = getModuleDef();
  const GroupDef *groupDef = getGroupDef();
  if (!m_explicitOutputFileBase.empty())
  {
    return m_explicitOutputFileBase;
  }
  else if (templateMaster() && (classDef==nullptr || classDef->isImplicitTemplateInstance()))
  {
    return templateMaster()->getOutputFileBase();
  }
  else if (anonymousMemberForDetails())
  {
    return anonymousMemberForDetails()->getOutputFileBase();
  }
  else if (groupDef)
  {
    baseName=groupDef->getOutputFileBase();
  }
  else if (classDef)
  {
    baseName=classDef->getOutputFileBase();
    if (inlineSimpleClasses && classDef->isSimple())
    {
      return baseName;
    }
  }
  else if (nspace && (nspace->isLinkable() || nspace->isAnonymous()))
  {
    baseName=nspace->getOutputFileBase();
  }
  else if (fileDef)
  {
    baseName=fileDef->getOutputFileBase();
  }
  else if (moduleDef)
  {
    baseName=moduleDef->getOutputFileBase();
  }
 
  if (baseName.empty())
  {
    warn(getDefFileName(),getDefLine(),
       "Internal inconsistency: member {} does not belong to any container!",name()
      );
    return "dummy";
  }
  else if (separateMemberPages && hasDetailedDescription())
  {
    if (getEnumScope()) // enum value, which is part of enum's documentation
    {
      baseName+="_"+getEnumScope()->anchor();
    }
    else
    {
      baseName+="_"+anchor();
    }
  }
  return baseName;
}

References Definition::anchor(), anchor(), anonymousMemberForDetails(), Config_getBool, DString::empty(), getClassDef(), DefinitionMixin< MemberDefMutable >::getDefFileName(), DefinitionMixin< MemberDefMutable >::getDefLine(), getEnumScope(), getFileDef(), getGroupDef(), getModuleDef(), getNamespaceDef(), Definition::getOutputFileBase(), hasDetailedDescription(), Definition::isAnonymous(), ClassDef::isImplicitTemplateInstance(), 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 5895 of file memberdef.cpp.

{
  return m_qualifiers;
}

References m_qualifiers.

◆ getReadAccessor()

DString MemberDefImpl::getReadAccessor ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5162 of file memberdef.cpp.

{
  return m_read;
}

References m_read.

◆ getReference()

DString 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 1765 of file memberdef.cpp.

{
  DString ref = DefinitionMixin::getReference();
  if (!ref.empty())
  {
    return ref;
  }
  const NamespaceDef *nspace = getNamespaceDef();
  const FileDef *fileDef = getFileDef();
  const ClassDef *classDef = getClassDef();
  const ModuleDef *moduleDef = getModuleDef();
  const GroupDef *groupDef = getGroupDef();
  if (templateMaster())
  {
    return templateMaster()->getReference();
  }
  else if (groupDef)
  {
    return groupDef->getReference();
  }
  else if (classDef)
  {
    return classDef->getReference();
  }
  else if (nspace)
  {
    return nspace->getReference();
  }
  else if (moduleDef)
  {
    return moduleDef->getReference();
  }
  else if (fileDef)
  {
    return fileDef->getReference();
  }
  return "";
}

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

Referenced by anchor(), and writeLink().

◆ getScopeString()

DString MemberDefImpl::getScopeString ( ) const

overridevirtual

Implements MemberDef.

Definition at line 4404 of file memberdef.cpp.

{
  DString result;
  if (isStrong()) result=name();
  else if (getClassDef()) result=getClassDef()->displayName();
  else if (getNamespaceDef()) result=getNamespaceDef()->displayName();
  return result;
}

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 4625 of file memberdef.cpp.

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

References m_sectionMap.

◆ getVhdlSpecifiers()

VhdlSpecifier MemberDefImpl::getVhdlSpecifiers ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5122 of file memberdef.cpp.

{
  return m_vhdlSpec;
}

References m_vhdlSpec.

Referenced by getLabels().

◆ getWriteAccessor()

DString MemberDefImpl::getWriteAccessor ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5167 of file memberdef.cpp.

{
  return m_write;
}

References m_write.

◆ hasCallerGraph()

bool MemberDefImpl::hasCallerGraph ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5743 of file memberdef.cpp.

{
  return m_hasCallerGraph;
}

References m_hasCallerGraph.

◆ hasCallGraph()

bool MemberDefImpl::hasCallGraph ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5725 of file memberdef.cpp.

{
  return m_hasCallGraph;
}

References m_hasCallGraph.

◆ hasDetailedDescription()

bool MemberDefImpl::hasDetailedDescription ( ) const

overridevirtual

Implements MemberDef.

Definition at line 2631 of file memberdef.cpp.

{
  std::lock_guard<std::mutex> lock(g_hasDetailedDescriptionMutex);
  //printf(">hasDetailedDescription(cached=%d)\n",m_hasDetailedDescriptionCached);
  if (!m_hasDetailedDescriptionCached)
  {
    bool extractAll            = Config_getBool(EXTRACT_ALL);
    bool alwaysDetailedSec     = Config_getBool(ALWAYS_DETAILED_SEC);
    bool repeatBrief           = Config_getBool(REPEAT_BRIEF);
    bool briefMemberDesc       = Config_getBool(BRIEF_MEMBER_DESC);
    bool hideUndocMembers      = Config_getBool(HIDE_UNDOC_MEMBERS);
    bool extractStatic         = Config_getBool(EXTRACT_STATIC);
    bool extractPrivateVirtual = Config_getBool(EXTRACT_PRIV_VIRTUAL);
    bool inlineSources         = hasInlineSource();
    bool includes              = Config_getBool(SHOW_INCLUDE_FILES) && m_incInfo!=nullptr;
 
    // the member has detailed documentation because the user added some comments
    bool docFilter =
           // extract all is enabled
           extractAll ||
           // has detailed docs
           !documentation().empty() ||
           // has inbody docs
           !inbodyDocumentation().empty() ||
           // is an enum with values that are documented
           (isEnumerate() && hasDocumentedEnumValues()) ||
           // is documented enum value
           (m_mtype==MemberType::EnumValue && !briefDescription().empty()) ||
           // has brief description that is part of the detailed description
           (!briefDescription().empty() &&           // has brief docs
            (alwaysDetailedSec &&                      // they are visible in
             (repeatBrief ||                           // detailed section or
              !briefMemberDesc                         // they are explicitly not
             )                                         // shown in brief section
            )
           ) ||
           // has one or more documented arguments
           (m_templateMaster ?
            m_templateMaster->argumentList().hasDocumentation() :
            m_defArgList.hasDocumentation()) ||
           (m_templateMaster ?
            m_templateMaster->templateArguments().hasTemplateDocumentation() :
            m_tArgList.hasTemplateDocumentation()) ||
           // user-specified qualifiers
           !m_qualifiers.empty();
 
    // generate function                  guard
    // ==================                 =======
    // _writeGroupInclude              -> ignored in calculation
    // multiLineInitializer()          -> hasMultiLineInitializer()
    // _writeReimplements              -> _isReimplements()
    // _writeReimplementedBy           -> _countReimplementedBy()>0
    // _writeExamples                  -> hasExamples()
    // _writeTypeConstraints           -> m_typeConstraints.hasParameters()
    // writeSourceDef                  -> !getSourceFileBase().empty();
    // writeInlineCode                 -> hasInlineSource() && hasSources()
    // writeSourceRefs                 -> hasReferencesRelation() && hasSourceRefs()
    // writeSourceReffedBy             -> hasReferencedByRelation() && hasSourceReffedBy()
    // _writeCallGraph                 -> _hasVisibleCallGraph()
    // _writeCallerGraph               -> _hasVisibleCallerGraph()
 
    // the member has detailed documentation because there is some generated info
    bool docInfo =
           // has a multi-line initialization block
           (hasMultiLineInitializer()) ||
           // reimplements / reimplemented by
           _isReimplements() || (_countReimplementedBy() > 0) ||
           // examples
           hasExamples() ||
           // type constraints
           m_typeConstraints.hasParameters() ||
           // has source definition
           !getSourceFileBase().empty() ||
           // has inline sources
           (inlineSources && hasSources()) ||
           // has references
           (hasReferencesRelation() && hasSourceRefs()) ||
           (hasReferencedByRelation() && hasSourceReffedBy()) ||
           // call graph
           _hasVisibleCallGraph() ||
           // caller graph
           _hasVisibleCallerGraph() ||
           // requirement references
           hasRequirementRefs() ||
           // has \headerfile command
           includes;
 
    if (!hideUndocMembers) // if HIDE_UNDOC_MEMBERS is NO we also show the detailed section
                           // if there is only some generated info
    {
      docFilter = docFilter || docInfo;
    }
 
    // this is not a global static or global statics should be extracted
    bool staticFilter = getClassDef()!=nullptr || !isStatic() || extractStatic;
 
    // a module does not contain details for members, so either the namespace or file should be linkable
    bool moduleFilter = getModuleDef()==nullptr || (getFileDef() && getFileDef()->isLinkable()) ||
                                                   (getNamespaceDef() && getNamespaceDef()->isLinkable()) ||
                                                   (getGroupDef() && getGroupDef()->isLinkable());
 
    // only include members that are non-private unless EXTRACT_PRIVATE is
    // set to YES or the member is part of a   group
    bool privateFilter = protectionLevelVisible(protection()) || m_mtype==MemberType::Friend ||
                         (m_prot==Protection::Private && (m_virt!=Specifier::Normal || isOverride() || isFinal()) && extractPrivateVirtual);
 
    // hide friend (class|struct|union) member if HIDE_FRIEND_COMPOUNDS
    // is true
    bool friendCompoundFilter = !(Config_getBool(HIDE_FRIEND_COMPOUNDS) && isFriend());
 
    m_detailedDescriptionCachedValue =
        (docFilter && staticFilter && moduleFilter && privateFilter && friendCompoundFilter && !isHidden());
    //printf("docFilter=%d docInfo=%d staticFilter=%d privateFilter=%d friendCompoundFilter=%d !isHidden()=%d",
    //    docFilter,docInfo,staticFilter,privateFilter,friendCompoundFilter,!isHidden());
    m_hasDetailedDescriptionCached = true;
  }
  //printf("<hasDetailedDescription(cached=%d)\n",m_hasDetailedDescriptionCached);
  return m_detailedDescriptionCachedValue;
}

References _countReimplementedBy(), _hasVisibleCallerGraph(), _hasVisibleCallGraph(), _isReimplements(), MemberDef::argumentList(), briefDescription(), Config_getBool, documentation(), DString::empty(), g_hasDetailedDescriptionMutex, getClassDef(), getFileDef(), getGroupDef(), getModuleDef(), getNamespaceDef(), DefinitionMixin< MemberDefMutable >::getSourceFileBase(), ArgumentList::hasDocumentation(), hasDocumentation(), hasDocumentedEnumValues(), hasExamples(), hasInlineSource(), hasMultiLineInitializer(), ArgumentList::hasParameters(), hasReferencedByRelation(), hasReferencesRelation(), DefinitionMixin< MemberDefMutable >::hasRequirementRefs(), DefinitionMixin< MemberDefMutable >::hasSourceReffedBy(), DefinitionMixin< MemberDefMutable >::hasSourceRefs(), DefinitionMixin< MemberDefMutable >::hasSources(), ArgumentList::hasTemplateDocumentation(), DefinitionMixin< MemberDefMutable >::inbodyDocumentation(), isEnumerate(), isFinal(), isFriend(), DefinitionMixin< MemberDefMutable >::isHidden(), Definition::isLinkable(), isLinkable(), isOverride(), isStatic(), m_defArgList, m_detailedDescriptionCachedValue, m_hasDetailedDescriptionCached, m_incInfo, m_mtype, m_prot, m_qualifiers, m_tArgList, m_templateMaster, m_typeConstraints, m_virt, protection(), protectionLevelVisible(), and MemberDef::templateArguments().

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 4391 of file memberdef.cpp.

{
  return DefinitionMixin::hasDocumentation() ||
         (m_mtype==MemberType::Enumeration && m_docEnumValues) ||  // has enum values
         (m_defArgList.hasDocumentation()|| m_tArgList.hasTemplateDocumentation());   // has doc (template) arguments
}

References ArgumentList::hasDocumentation(), DefinitionMixin< Base >::hasDocumentation(), ArgumentList::hasTemplateDocumentation(), 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 5572 of file memberdef.cpp.

{
  return m_docEnumValues;
}

References m_docEnumValues.

Referenced by hasDetailedDescription(), and writeEnumDeclaration().

◆ hasEnumValues()

bool MemberDefImpl::hasEnumValues ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5776 of file memberdef.cpp.

{
  return m_hasEnumValues;
}

References m_hasEnumValues.

Referenced by _writeEnumValues().

◆ hasExamples()

bool MemberDefImpl::hasExamples ( ) const

overridevirtual

Implements MemberDef.

Definition at line 1668 of file memberdef.cpp.

{
  return !m_examples.empty();
}

References m_examples.

Referenced by _writeExamples(), and hasDetailedDescription().

◆ hasInlineSource()

bool MemberDefImpl::hasInlineSource ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5771 of file memberdef.cpp.

{
  return m_hasInlineSource;
}

References m_hasInlineSource.

Referenced by hasDetailedDescription().

◆ hasMultiLineInitializer()

bool MemberDefImpl::hasMultiLineInitializer ( ) const

overridevirtual

Implements MemberDef.

Definition at line 4548 of file memberdef.cpp.

{
  //printf("initLines=%d userInitLines=%d maxInitLines=%d\n",
  //    initLines,userInitLines,maxInitLines);
  bool isFuncLikeMacro = m_mtype==MemberType::Define && m_defArgList.hasParameters();
  return (m_initLines>0 || (!m_initializer.empty() && isFuncLikeMacro)) &&
         ((m_initLines<m_maxInitLines && m_userInitLines==-1) // implicitly enabled
          || m_initLines<m_userInitLines // explicitly enabled
         );
}

References DString::empty(), ArgumentList::hasParameters(), 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 4537 of file memberdef.cpp.

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

References DString::empty(), ArgumentList::hasParameters(), 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 5761 of file memberdef.cpp.

{
  return m_hasReferencedByRelation;
}

References m_hasReferencedByRelation.

Referenced by hasDetailedDescription(), and writeDocumentation().

◆ hasReferencesRelation()

bool MemberDefImpl::hasReferencesRelation ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5766 of file memberdef.cpp.

{
  return m_hasReferencesRelation;
}

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 6461 of file memberdef.cpp.

{
  if (m_templateMaster)
  {
    return m_templateMaster->hasUserDocumentation();
  }
  else
  {
    return DefinitionMixin::hasUserDocumentation();
  }
}

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

Referenced by warnIfUndocumented().

◆ incrementFlowKeyWordCount()

void MemberDefImpl::incrementFlowKeyWordCount ( )

overridevirtual

Implements MemberDefMutable.

Definition at line 6178 of file memberdef.cpp.

{
  m_numberOfFlowKW++;
}

References m_numberOfFlowKW.

◆ inheritsDocsFrom()

const MemberDef * MemberDefImpl::inheritsDocsFrom ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5822 of file memberdef.cpp.

{
  return m_docProvider;
}

References m_docProvider.

◆ init()

void MemberDefImpl::init	(	Definition *	def,
		const DString &	t,
		const DString &	a,
		const DString &	e,
		Protection	p,
		Specifier	v,
		bool	s,
		Relationship	r,
		MemberType	mt,
		const ArgumentList &	tal,
		const ArgumentList &	al,
		const DString &	meta )

private

Definition at line 1358 of file memberdef.cpp.

{
  m_classDef=nullptr;
  m_fileDef=nullptr;
  m_moduleDef=nullptr;
  m_redefines=nullptr;
  m_relatedAlso=nullptr;
  m_nspace=nullptr;
  m_memDef=nullptr;
  m_memDec=nullptr;
  m_group=nullptr;
  m_grpId=-1;
  m_enumScope=nullptr;
  m_livesInsideEnum=false;
  m_hasCallGraph            = Config_getBool(CALL_GRAPH);
  m_hasCallerGraph          = Config_getBool(CALLER_GRAPH);
  m_hasReferencedByRelation = Config_getBool(REFERENCED_BY_RELATION);
  m_hasReferencesRelation   = Config_getBool(REFERENCES_RELATION);
  m_hasEnumValues           = Config_getBool(SHOW_ENUM_VALUES);
  m_hasInlineSource         = Config_getBool(INLINE_SOURCES);
  m_initLines=0;
  m_type=t;
  if (mt==MemberType::Typedef) m_type.stripPrefix("typedef ");
  //  type.stripPrefix("struct ");
  //  type.stripPrefix("class " );
  //  type.stripPrefix("union " );
  m_type=removeRedundantWhiteSpace(m_type);
  m_args=a;
  m_args=removeRedundantWhiteSpace(m_args);
  if (m_type.empty()) m_decl=d->name()+m_args; else m_decl=m_type+" "+d->name()+m_args;
 
  m_memberGroup=nullptr;
  m_virt=v;
  m_prot=p;
  m_related=r;
  m_stat=s;
  m_mtype=mt;
  m_exception=e;
  m_proto=false;
  m_memSpec=TypeSpecifier();
  m_vhdlSpec=VhdlSpecifier::UNKNOWN;
  m_annEnumType=nullptr;
  m_annMemberForDecl=nullptr;
  m_annMemberForDetails=nullptr;
  m_groupAlias=nullptr;
  m_explExt=false;
  m_tspec=false;
  m_anonymousType=nullptr;
  m_maxInitLines=Config_getInt(MAX_INITIALIZER_LINES);
  m_userInitLines=-1;
  m_docEnumValues=false;
  // copy function template arguments (if any)
  m_tArgList = tal;
  //printf("new member al=%p\n",al);
  // copy function definition arguments (if any)
  m_defArgList = al;
  // convert function declaration arguments (if any)
  if (!m_args.empty())
  {
    m_declArgList = *stringToArgumentList(d->getLanguage(),m_args,&m_extraTypeChars);
    //printf("setDeclArgList %s to %s const=%d\n",qPrint(args),
    //    qPrint(argListToString(declArgList)),declArgList->constSpecifier);
  }
  m_metaData = meta;
  m_templateMaster = nullptr;
  m_docsForDefinition = true;
  m_isTypedefValCached = false;
  m_cachedTypedefValue = nullptr;
  m_implOnly=false;
  m_groupMember = nullptr;
  m_hasDocumentedParams = false;
  m_hasDocumentedReturnType = false;
  m_docProvider = nullptr;
  m_isDMember = d->getDefFileName().lower().endsWith(".d");
}

References Config_getBool, Config_getInt, DString::empty(), DString::endsWith(), Definition::getDefFileName(), Definition::getLanguage(), DString::lower(), m_annEnumType, m_annMemberForDecl, m_annMemberForDetails, m_anonymousType, m_args, 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(), DString::stripPrefix(), and UNKNOWN.

Referenced by MemberDefImpl(), and writeDocumentation().

◆ initializer()

const DString & MemberDefImpl::initializer ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5102 of file memberdef.cpp.

{
  return m_initializer;
}

References m_initializer.

Referenced by setInitializer().

◆ initializerLines()

int MemberDefImpl::initializerLines ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5107 of file memberdef.cpp.

{
  return m_initLines;
}

References m_initLines.

◆ insertEnumField()

void MemberDefImpl::insertEnumField ( MemberDef * md )

overridevirtual

Implements MemberDefMutable.

Definition at line 1657 of file memberdef.cpp.

{
  m_enumFields.push_back(md);
}

References m_enumFields, and MemberVector::push_back().

◆ insertReimplementedBy()

void MemberDefImpl::insertReimplementedBy ( MemberDef * md )

overridevirtual

Implements MemberDefMutable.

Definition at line 1612 of file memberdef.cpp.

{
  if (m_templateMaster)
  {
    MemberDefMutable *mdm = toMemberDefMutable(const_cast<MemberDef *>(m_templateMaster));
    if (mdm)
    {
      mdm->insertReimplementedBy(md);
    }
  }
  if (!m_redefinedBy.contains(md))
  {
    m_redefinedBy.inSort(md);
  }
}

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

◆ invalidateCachedArgumentTypes()

void MemberDefImpl::invalidateCachedArgumentTypes ( )

overridevirtual

Implements MemberDefMutable.

Definition at line 6172 of file memberdef.cpp.

{
  invalidateCachedTypesInArgumentList(m_defArgList);
  invalidateCachedTypesInArgumentList(m_declArgList);
}

References invalidateCachedTypesInArgumentList(), m_declArgList, and m_defArgList.

◆ invalidateTypedefValCache()

void MemberDefImpl::invalidateTypedefValCache ( )

overridevirtual

Implements MemberDefMutable.

Definition at line 6058 of file memberdef.cpp.

{
  m_isTypedefValCached=false;
}

References m_isTypedefValCached.

◆ isAbstract()

bool MemberDefImpl::isAbstract ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5408 of file memberdef.cpp.

{
  return m_memSpec.isAbstract();
}

References m_memSpec.

Referenced by getLabels().

◆ isAddable()

bool MemberDefImpl::isAddable ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5358 of file memberdef.cpp.

{
  return m_memSpec.isAddable();
}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isAssign()

bool MemberDefImpl::isAssign ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5433 of file memberdef.cpp.

{
  return m_memSpec.isAssign();
}

References m_memSpec.

Referenced by getLabels().

◆ isAttribute()

bool MemberDefImpl::isAttribute ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5490 of file memberdef.cpp.

{
  return m_memSpec.isAttribute();
}

References m_memSpec.

Referenced by getLabels().

◆ isBound()

bool MemberDefImpl::isBound ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5505 of file memberdef.cpp.

{
  return m_memSpec.isBound();
}

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 2039 of file memberdef.cpp.

{
  bool extractStatic       = Config_getBool(EXTRACT_STATIC);
  bool extractPrivateVirtual = Config_getBool(EXTRACT_PRIV_VIRTUAL);
  bool hideUndocMembers    = Config_getBool(HIDE_UNDOC_MEMBERS);
  bool briefMemberDesc     = Config_getBool(BRIEF_MEMBER_DESC);
  bool repeatBrief         = Config_getBool(REPEAT_BRIEF);
  bool hideFriendCompounds = Config_getBool(HIDE_FRIEND_COMPOUNDS);
 
  //printf("Member %s grpId=%d docs=%s file=%s args=%s\n",
  //    qPrint(name()),
  //    0,"", //grpId,grpId==-1?"<none>":Doxygen::memberDocDict[grpId]->data(),
  //    "", //qPrint(getFileDef()->name()),
  //    argsString());
 
  bool hasDocs = hasDocumentation();
 
  // only include static members with file/namespace scope if
  // explicitly enabled in the config file
  bool visibleIfStatic = !(getClassDef()==nullptr &&
                           isStatic() &&
                           !extractStatic
                          );
 
  // only include members is the are documented or
  // HIDE_UNDOC_MEMBERS is NO in the config file
  bool visibleIfDocumented = (!hideUndocMembers ||
                              hasDocs ||
                              isDocumentedFriendClass()
                             );
 
  // hide members with no detailed description and brief descriptions
  // explicitly disabled.
  bool visibleIfEnabled = !(hideUndocMembers &&
                            documentation().empty() &&
                            !briefMemberDesc &&
                            !repeatBrief
                           );
 
  // Hide friend (class|struct|union) declarations if HIDE_FRIEND_COMPOUNDS is true
  bool visibleIfFriendCompound = !(hideFriendCompounds &&
                                   isFriend()
                                  );
 
  // only include members that are non-private unless EXTRACT_PRIVATE is
  // set to YES or the member is part of a group. And as a special case,
  // private *documented* virtual members are shown if EXTRACT_PRIV_VIRTUAL
  // is set to YES
  bool visibleIfPrivate = (protectionLevelVisible(protection()) ||
                           m_mtype==MemberType::Friend ||
                           (m_prot==Protection::Private &&
                               (m_virt!=Specifier::Normal || isOverride() || isFinal()) && extractPrivateVirtual && hasDocs)
                          );
 
  // hide member if it overrides a member in a superclass and has no
  // documentation of its own
  //bool visibleIfDocVirtual = !reimplements() ||
  //                           !Config_getBool(INHERIT_DOCS) ||
  //                           hasDocs;
 
  // true if this member is a constructor or destructor
  bool cOrDTor = isConstructor() || isDestructor();
 
  // hide default constructors or destructors (no args) without
  // documentation
  bool visibleIfNotDefaultCDTor = !(cOrDTor &&
                                   (m_defArgList.empty() ||
                                    m_defArgList.front().type == "void"
                                   ) &&
                                   !hasDocs
                                  );
 
 
  //printf("visibleIfStatic=%d visibleIfDocumented=%d visibleIfEnabled=%d "
  //       "visibleIfPrivate=%d visibleIfNotDefaultCDTor=%d "
  //       "visibleIfFriendCompound=%d\n",
  //       visibleIfStatic,visibleIfDocumented,
  //       visibleIfEnabled,visibleIfPrivate,visibleIfNotDefaultCDTor,
  //       visibleIfFriendCompound);
 
  bool visible = visibleIfStatic     && visibleIfDocumented      &&
                 visibleIfEnabled    && visibleIfPrivate         &&
                 /*visibleIfDocVirtual &&*/ visibleIfNotDefaultCDTor &&
                 visibleIfFriendCompound &&
                 !isHidden();
  //printf("MemberDefImpl::isBriefSectionVisible() %d\n",visible);
  return visible;
}

References Config_getBool, documentation(), ArgumentList::empty(), DString::empty(), ArgumentList::front(), getClassDef(), hasDocumentation(), isConstructor(), isDestructor(), isDocumentedFriendClass(), isFinal(), isFriend(), DefinitionMixin< MemberDefMutable >::isHidden(), isOverride(), isStatic(), m_defArgList, m_mtype, m_prot, m_virt, protection(), protectionLevelVisible(), and Argument::type.

Referenced by writeEnumDeclaration().

◆ isCallable()

bool MemberDefImpl::isCallable ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5556 of file memberdef.cpp.

{
  return isFunction() ||
         isSlot() ||
         isSignal() ||
         isConstructor() ||
         isDestructor() ||
         isObjCMethod() ||
         isFriend();
}

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

Referenced by sourceRefName().

◆ isConstEval()

bool MemberDefImpl::isConstEval ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5622 of file memberdef.cpp.

{
  return m_memSpec.isConstEval();
}

References m_memSpec.

Referenced by getLabels().

◆ isConstExpr()

bool MemberDefImpl::isConstExpr ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5617 of file memberdef.cpp.

{
  return m_memSpec.isConstExpr();
}

References m_memSpec.

Referenced by getLabels().

◆ isConstInit()

bool MemberDefImpl::isConstInit ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5627 of file memberdef.cpp.

{
  return m_memSpec.isConstInit();
}

References m_memSpec.

Referenced by getLabels().

◆ isConstrained()

bool MemberDefImpl::isConstrained ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5510 of file memberdef.cpp.

{
  return m_memSpec.isConstrained();
}

References m_memSpec.

Referenced by getLabels().

◆ isConstructor()

bool MemberDefImpl::isConstructor ( ) const

overridevirtual

Implements MemberDef.

Definition at line 4760 of file memberdef.cpp.

{
  if (m_isConstructorCached==0)
  {
    MemberDefImpl *that = const_cast<MemberDefImpl*>(this);
    that->_computeIsConstructor();
  }
  ASSERT(m_isConstructorCached>0);
  return m_isConstructorCached==2;
 
}

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

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

◆ isCopy()

bool MemberDefImpl::isCopy ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5428 of file memberdef.cpp.

{
  return m_memSpec.isCopy();
}

References m_memSpec.

Referenced by getLabels().

◆ isCSharpProperty()

bool MemberDefImpl::isCSharpProperty ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5009 of file memberdef.cpp.

{
  if (getClassDef() && getClassDef()->isCSharp() && isProperty()) return true;
  return false;
}

References getClassDef(), and isProperty().

◆ isDCOP()

bool MemberDefImpl::isDCOP ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5278 of file memberdef.cpp.

{
  return m_mtype==MemberType::DCOP;
}

References m_mtype.

◆ isDefault()

bool MemberDefImpl::isDefault ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5475 of file memberdef.cpp.

{
  return m_memSpec.isDefault();
}

References m_memSpec.

Referenced by getLabels().

◆ isDefine()

bool MemberDefImpl::isDefine ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5268 of file memberdef.cpp.

{
  return m_mtype==MemberType::Define;
}

References m_mtype.

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

◆ isDelete()

bool MemberDefImpl::isDelete ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5480 of file memberdef.cpp.

{
  return m_memSpec.isDelete();
}

References m_memSpec.

Referenced by getLabels().

◆ isDeleted()

bool MemberDefImpl::isDeleted ( ) const

overridevirtual

Implements MemberDef.

Definition at line 4386 of file memberdef.cpp.

{
  return m_defArgList.isDeleted();
}

References ArgumentList::isDeleted(), and m_defArgList.

Referenced by warnIfUndocumented(), and warnIfUndocumentedParams().

◆ isDestructor()

bool MemberDefImpl::isDestructor ( ) const

overridevirtual

Implements MemberDef.

Definition at line 4801 of file memberdef.cpp.

{
  if (m_isDestructorCached==0)
  {
    MemberDefImpl *that=const_cast<MemberDefImpl*>(this);
    that->_computeIsDestructor();
  }
  ASSERT(m_isDestructorCached>0);
  return m_isDestructorCached==2;
}

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 2751 of file memberdef.cpp.

{
  bool separateMemPages = Config_getBool(SEPARATE_MEMBER_PAGES);
  bool inlineSimpleStructs = Config_getBool(INLINE_SIMPLE_STRUCTS);
  bool hideUndocMembers = Config_getBool(HIDE_UNDOC_MEMBERS);
  bool groupFilter = getGroupDef()==nullptr || container==MemberListContainer::Group || separateMemPages;
  bool fileFilter  = getNamespaceDef()==nullptr || !getNamespaceDef()->isLinkable() || container!=MemberListContainer::File;
  bool simpleFilter = (hasBriefDescription() || !hideUndocMembers) && inlineSimpleStructs &&
                      getClassDef()!=nullptr && getClassDef()->isSimple();
 
  bool visible = hasDetailedDescription() && groupFilter && fileFilter &&
                 !isReference();
  bool result = visible || simpleFilter;
  //printf("%s::isDetailedSectionVisible: %d groupFilter=%d fileFilter=%d\n",
  //    qPrint(name()),result,groupFilter,fileFilter);
  return result;
}

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 5252 of file memberdef.cpp.

{
  return m_mtype==MemberType::Dictionary;
}

References m_mtype.

◆ isDocsForDefinition()

bool MemberDefImpl::isDocsForDefinition ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5592 of file memberdef.cpp.

{
  return m_docsForDefinition;
}

References m_docsForDefinition.

Referenced by warnIfUndocumentedParams().

◆ isDocTransferDone()

bool MemberDefImpl::isDocTransferDone ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5112 of file memberdef.cpp.

{
  return m_docTransferDone;
}

References m_docTransferDone.

◆ isDocumentedFriendClass()

bool MemberDefImpl::isDocumentedFriendClass ( ) const

overridevirtual

Implements MemberDef.

Definition at line 4377 of file memberdef.cpp.

{
  ClassDef *fcd=nullptr;
  DString baseName=name();
  if (size_t i=baseName.find('<'); i!=DString::npos) baseName=baseName.left(i);
  return (isFriendClass() &&
         (fcd=getClass(baseName)) && fcd->isLinkable());
}

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

Referenced by isBriefSectionVisible(), and writeDeclaration().

◆ isEnumerate()

bool MemberDefImpl::isEnumerate ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5232 of file memberdef.cpp.

{
  return m_mtype==MemberType::Enumeration;
}

References m_mtype.

Referenced by _writeEnumValues(), displayDefinition(), getDeclType(), hasDetailedDescription(), warnIfUndocumented(), and writeDocumentation().

◆ isEnumStruct()

bool MemberDefImpl::isEnumStruct ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5453 of file memberdef.cpp.

{
  return m_memSpec.isEnumStruct();
}

References m_memSpec.

Referenced by getDeclType(), and writeDocumentation().

◆ isEnumValue()

bool MemberDefImpl::isEnumValue ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5237 of file memberdef.cpp.

{
  return m_mtype==MemberType::EnumValue;
}

References m_mtype.

Referenced by displayDefinition(), and writeDocumentation().

◆ isEvent()

bool MemberDefImpl::isEvent ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5288 of file memberdef.cpp.

{
  return m_mtype==MemberType::Event;
}

References m_mtype.

Referenced by writeDeclaration().

◆ isExplicit()

bool MemberDefImpl::isExplicit ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5313 of file memberdef.cpp.

{
  return m_memSpec.isExplicit();
}

References m_memSpec.

Referenced by getLabels().

◆ isExternal()

bool MemberDefImpl::isExternal ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5546 of file memberdef.cpp.

{
  return m_explExt;
}

References m_explExt.

Referenced by getLabels().

◆ isFinal()

bool MemberDefImpl::isFinal ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5383 of file memberdef.cpp.

{
  return m_memSpec.isFinal();
}

References m_memSpec.

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

◆ isForeign()

bool MemberDefImpl::isForeign ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5298 of file memberdef.cpp.

{
  return m_related == Relationship::Foreign;
}

References m_related.

Referenced by isRelatedOrFriend().

◆ isFriend()

bool MemberDefImpl::isFriend ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5273 of file memberdef.cpp.

{
  return m_mtype==MemberType::Friend;
}

References m_mtype.

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

◆ isFriendClass()

bool MemberDefImpl::isFriendClass ( ) const

overridevirtual

Implements MemberDef.

Definition at line 6497 of file memberdef.cpp.

{
  return isFriend() && isTypeAClassFriend(m_type);
}

References isFriend(), isTypeAClassFriend(), and m_type.

Referenced by isDocumentedFriendClass(), and warnIfUndocumented().

◆ isFriendToHide()

bool MemberDefImpl::isFriendToHide ( ) const

overridevirtual

Implements MemberDef.

Definition at line 6490 of file memberdef.cpp.

{
  bool hideFriendCompounds = Config_getBool(HIDE_FRIEND_COMPOUNDS);
  bool isFriendToHide = hideFriendCompounds && isTypeAClassFriend(m_type);
  return isFriendToHide;
}

References Config_getBool, isFriendToHide(), isTypeAClassFriend(), and m_type.

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

◆ isFunction()

bool MemberDefImpl::isFunction ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5257 of file memberdef.cpp.

{
  return m_mtype==MemberType::Function;
}

References m_mtype.

Referenced by _hasVisibleCallerGraph(), _hasVisibleCallGraph(), isCallable(), isFunctionOrSignalSlot(), isObjCMethod(), warnIfUndocumentedParams(), and writeDocumentation().

◆ isFunctionOrSignalSlot()

bool MemberDefImpl::isFunctionOrSignalSlot ( ) const

overridevirtual

Implements MemberDef.

Definition at line 6508 of file memberdef.cpp.

{
  return isFunction() || isSlot() || isSignal();
}

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

◆ isFunctionPtr()

bool MemberDefImpl::isFunctionPtr ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5262 of file memberdef.cpp.

{
  return m_mtype==MemberType::Variable &&
         DString(argsString()).find(")(")!=DString::npos;
}

References argsString(), DString::find(), m_mtype, and DString::npos.

Referenced by writeMemberDocSimple().

◆ isGettable()

bool MemberDefImpl::isGettable ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5328 of file memberdef.cpp.

{
  return m_memSpec.isGettable();
}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isImplementation()

bool MemberDefImpl::isImplementation ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5541 of file memberdef.cpp.

{
  return m_implOnly;
}

References m_implOnly.

Referenced by getLabels(), and writeDeclaration().

◆ isInitonly()

bool MemberDefImpl::isInitonly ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5403 of file memberdef.cpp.

{
  return m_memSpec.isInitonly();
}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isInline()

bool MemberDefImpl::isInline ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5308 of file memberdef.cpp.

{
  return m_memSpec.isInline();
}

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 1952 of file memberdef.cpp.

{
  if (m_templateMaster)
  {
    return m_templateMaster->isLinkable();
  }
  else
  {
    return isLinkableInProject() || isReference();
  }
}

References Definition::isLinkable(), 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 1941 of file memberdef.cpp.

{
  if (m_isLinkableCached==0)
  {
    MemberDefImpl *that = const_cast<MemberDefImpl*>(this);
    that->_computeLinkableInProject();
  }
  ASSERT(m_isLinkableCached>0);
  return m_isLinkableCached==2;
}

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 5530 of file memberdef.cpp.

{
  return m_memSpec.isMaybeAmbiguous();
}

References m_memSpec.

Referenced by getLabels().

◆ isMaybeDefault()

bool MemberDefImpl::isMaybeDefault ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5525 of file memberdef.cpp.

{
  return m_memSpec.isMaybeDefault();
}

References m_memSpec.

Referenced by getLabels().

◆ isMaybeVoid()

bool MemberDefImpl::isMaybeVoid ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5520 of file memberdef.cpp.

{
  return m_memSpec.isMaybeVoid();
}

References m_memSpec.

Referenced by getLabels().

◆ isMutable()

bool MemberDefImpl::isMutable ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5318 of file memberdef.cpp.

{
  return m_memSpec.isMutable();
}

References m_memSpec.

Referenced by getLabels().

◆ isNew()

bool MemberDefImpl::isNew ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5388 of file memberdef.cpp.

{
  return m_memSpec.isNew();
}

References m_memSpec.

Referenced by getLabels().

◆ isNoDiscard()

bool MemberDefImpl::isNoDiscard ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5612 of file memberdef.cpp.

{
  return m_memSpec.isNoDiscard();
}

References m_memSpec.

Referenced by getLabels().

◆ isNoExcept()

bool MemberDefImpl::isNoExcept ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5485 of file memberdef.cpp.

{
  return m_memSpec.isNoExcept();
}

References m_memSpec.

Referenced by getLabels().

◆ isNonAtomic()

bool MemberDefImpl::isNonAtomic ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5423 of file memberdef.cpp.

{
  return m_memSpec.isNonAtomic();
}

References m_memSpec.

Referenced by getLabels().

◆ isNotFriend()

bool MemberDefImpl::isNotFriend ( ) const

overridevirtual

Implements MemberDef.

Definition at line 6503 of file memberdef.cpp.

{
  return !(isFriend() && isFriendToHide());
}

References isFriend(), and isFriendToHide().

◆ isObjCMethod()

bool MemberDefImpl::isObjCMethod ( ) const

overridevirtual

Implements MemberDef.

Definition at line 4997 of file memberdef.cpp.

{
  if (getClassDef() && getClassDef()->isObjectiveC() && isFunction()) return true;
  return false;
}

References getClassDef(), and isFunction().

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

◆ isObjCProperty()

bool MemberDefImpl::isObjCProperty ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5003 of file memberdef.cpp.

{
  if (getClassDef() && getClassDef()->isObjectiveC() && isProperty()) return true;
  return false;
}

References getClassDef(), and isProperty().

Referenced by getLabels(), and writeDeclaration().

◆ isOptional()

bool MemberDefImpl::isOptional ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5413 of file memberdef.cpp.

{
  return m_memSpec.isOptional();
}

References m_memSpec.

Referenced by getLabels().

◆ isOverride()

bool MemberDefImpl::isOverride ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5398 of file memberdef.cpp.

{
  return m_memSpec.isOverride();
}

References m_memSpec.

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

◆ isPrivateGettable()

bool MemberDefImpl::isPrivateGettable ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5333 of file memberdef.cpp.

{
  return m_memSpec.isPrivateGettable();
}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isPrivateSettable()

bool MemberDefImpl::isPrivateSettable ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5348 of file memberdef.cpp.

{
  return m_memSpec.isPrivateSettable();
}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isProperty()

bool MemberDefImpl::isProperty ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5283 of file memberdef.cpp.

{
  return m_mtype==MemberType::Property;
}

References m_mtype.

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

◆ isProtectedGettable()

bool MemberDefImpl::isProtectedGettable ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5338 of file memberdef.cpp.

{
  return m_memSpec.isProtectedGettable();
}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isProtectedSettable()

bool MemberDefImpl::isProtectedSettable ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5353 of file memberdef.cpp.

{
  return m_memSpec.isProtectedSettable();
}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isPrototype()

bool MemberDefImpl::isPrototype ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5642 of file memberdef.cpp.

{
  return m_proto;
}

References m_proto.

◆ isPublished()

bool MemberDefImpl::isPublished ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5535 of file memberdef.cpp.

{
  return m_memSpec.isPublished();
}

References m_memSpec.

Referenced by getLabels().

◆ isRaisable()

bool MemberDefImpl::isRaisable ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5368 of file memberdef.cpp.

{
  return m_memSpec.isRaisable();
}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isReadable()

bool MemberDefImpl::isReadable ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5373 of file memberdef.cpp.

{
  return m_memSpec.isReadable();
}

References m_memSpec.

Referenced by getLabels().

◆ isReadonly()

bool MemberDefImpl::isReadonly ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5500 of file memberdef.cpp.

{
  return m_memSpec.isReadonly();
}

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 6518 of file memberdef.cpp.

{
  return DefinitionMixin::isReference() ||
         (m_templateMaster && m_templateMaster->isReference());
}

References Definition::isReference(), 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 1638 of file memberdef.cpp.

{
  if (cd)
  {
    for (const auto &md : m_redefinedBy)
    {
      const ClassDef *mcd = md->getClassDef();
      if (mcd)
      {
        if (cd==mcd || cd->isBaseClass(mcd,true))
        {
          return true;
        }
      }
    }
  }
  return false;
}

References ClassDef::isBaseClass(), and m_redefinedBy.

◆ isRelated()

bool MemberDefImpl::isRelated ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5293 of file memberdef.cpp.

{
  return m_related == Relationship::Related;
}

References m_related.

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

◆ isRelatedOrFriend()

bool MemberDefImpl::isRelatedOrFriend ( ) const

overridevirtual

Implements MemberDef.

Definition at line 6513 of file memberdef.cpp.

{
  return isRelated() || isForeign() || (isFriend() && !isFriendToHide());
}

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

◆ isRemovable()

bool MemberDefImpl::isRemovable ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5363 of file memberdef.cpp.

{
  return m_memSpec.isRemovable();
}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isRequired()

bool MemberDefImpl::isRequired ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5418 of file memberdef.cpp.

{
  return m_memSpec.isRequired();
}

References m_memSpec.

Referenced by getLabels().

◆ isRetain()

bool MemberDefImpl::isRetain ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5438 of file memberdef.cpp.

{
  return m_memSpec.isRetain();
}

References m_memSpec.

Referenced by getLabels().

◆ isSealed()

bool MemberDefImpl::isSealed ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5393 of file memberdef.cpp.

{
  return m_memSpec.isSealed();
}

References m_memSpec.

Referenced by getLabels().

◆ isSequence()

bool MemberDefImpl::isSequence ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5247 of file memberdef.cpp.

{
  return m_mtype==MemberType::Sequence;
}

References m_mtype.

◆ isSettable()

bool MemberDefImpl::isSettable ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5343 of file memberdef.cpp.

{
  return m_memSpec.isSettable();
}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isSignal()

bool MemberDefImpl::isSignal ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5217 of file memberdef.cpp.

{
  return m_mtype==MemberType::Signal;
}

References m_mtype.

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

◆ isSliceLocal()

bool MemberDefImpl::isSliceLocal ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5607 of file memberdef.cpp.

{
  return m_memSpec.isLocal();
}

References m_memSpec.

Referenced by displayDefinition(), and writeDocumentation().

◆ isSlot()

bool MemberDefImpl::isSlot ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5222 of file memberdef.cpp.

{
  return m_mtype==MemberType::Slot;
}

References m_mtype.

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

◆ isStatic()

bool MemberDefImpl::isStatic ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5303 of file memberdef.cpp.

{
  return m_stat;
}

References m_stat.

Referenced by displayDefinition(), getLabels(), hasDetailedDescription(), isBriefSectionVisible(), objCMethodName(), qualifiedName(), sourceRefName(), visibleInIndex(), writeDeclaration(), writeDocumentation(), writeLink(), and writeTagFile().

◆ isStrong()

bool MemberDefImpl::isStrong ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5448 of file memberdef.cpp.

{
  return m_memSpec.isStrong();
}

References m_memSpec.

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

◆ isStrongEnumValue()

bool MemberDefImpl::isStrongEnumValue ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5458 of file memberdef.cpp.

{
  return m_mtype==MemberType::EnumValue &&
         m_enumScope &&
         m_enumScope->isStrong();
}

References MemberDef::isStrong(), m_enumScope, and m_mtype.

◆ isTemplateSpecialization()

bool MemberDefImpl::isTemplateSpecialization ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5551 of file memberdef.cpp.

{
  return m_tspec;
}

References m_tspec.

Referenced by writeDocumentation().

◆ isThreadLocal()

bool MemberDefImpl::isThreadLocal ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5323 of file memberdef.cpp.

{
  return m_memSpec.isThreadLocal();
}

References m_memSpec.

Referenced by getLabels().

◆ isTransient()

bool MemberDefImpl::isTransient ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5515 of file memberdef.cpp.

{
  return m_memSpec.isTransient();
}

References m_memSpec.

Referenced by getLabels().

◆ isTypeAlias()

bool MemberDefImpl::isTypeAlias ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5470 of file memberdef.cpp.

{
  return m_memSpec.isAlias();
}

References m_memSpec.

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

◆ isTypedef()

bool MemberDefImpl::isTypedef ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5242 of file memberdef.cpp.

{
  return m_mtype==MemberType::Typedef;
}

References m_mtype.

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

◆ isTypedefValCached()

bool MemberDefImpl::isTypedefValCached ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5791 of file memberdef.cpp.

{
  return m_isTypedefValCached;
}

References m_isTypedefValCached.

◆ isUNOProperty()

bool MemberDefImpl::isUNOProperty ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5495 of file memberdef.cpp.

{
  return m_memSpec.isProperty();
}

References m_memSpec.

Referenced by getLabels().

◆ isUnretained()

bool MemberDefImpl::isUnretained ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5465 of file memberdef.cpp.

{
  return m_memSpec.isUnretained();
}

References m_memSpec.

Referenced by getLabels().

◆ isVariable()

bool MemberDefImpl::isVariable ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5227 of file memberdef.cpp.

{
  return m_mtype==MemberType::Variable;
}

References m_mtype.

Referenced by writeDocumentation(), and writeMemberDocSimple().

◆ isWeak()

bool MemberDefImpl::isWeak ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5443 of file memberdef.cpp.

{
  return m_memSpec.isWeak();
}

References m_memSpec.

Referenced by getLabels().

◆ isWritable()

bool MemberDefImpl::isWritable ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5378 of file memberdef.cpp.

{
  return m_memSpec.isWritable();
}

References m_memSpec.

Referenced by getLabels().

◆ livesInsideEnum()

bool MemberDefImpl::livesInsideEnum ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5602 of file memberdef.cpp.

{
  return m_livesInsideEnum;
}

References m_livesInsideEnum.

Referenced by setEnumScope().

◆ makeForeign()

void MemberDefImpl::makeForeign ( )

overridevirtual

Implements MemberDefMutable.

Definition at line 5946 of file memberdef.cpp.

{
  m_related = Relationship::Foreign;
  m_isLinkableCached = 0;
}

References m_isLinkableCached, and m_related.

◆ makeImplementationDetail()

void MemberDefImpl::makeImplementationDetail ( )

overridevirtual

Implements MemberDefMutable.

Definition at line 6032 of file memberdef.cpp.

{
  m_implOnly=true;
}

References m_implOnly.

◆ makeRelated()

void MemberDefImpl::makeRelated ( )

overridevirtual

Implements MemberDefMutable.

Definition at line 5940 of file memberdef.cpp.

{
  m_related = Relationship::Related;
  m_isLinkableCached = 0;
}

References m_isLinkableCached, and m_related.

◆ memberDeclaration()

MemberDef * MemberDefImpl::memberDeclaration ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5817 of file memberdef.cpp.

{
  return m_memDec;
}

References m_memDec.

◆ memberDefinition()

MemberDef * MemberDefImpl::memberDefinition ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5812 of file memberdef.cpp.

{
  return m_memDef;
}

References m_memDef.

◆ memberType()

MemberType MemberDefImpl::memberType ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5212 of file memberdef.cpp.

{
  return m_mtype;
}

References m_mtype.

Referenced by codeSymbolType().

◆ memberTypeName()

DString MemberDefImpl::memberTypeName ( ) const

overridevirtual

Implements MemberDef.

Definition at line 4144 of file memberdef.cpp.

{
  if (m_mtype == MemberType::Define)
  {
    return "macro definition";
  }
  else if (m_mtype == MemberType::Enumeration)
  {
    return "enumeration";
  }
  return to_string_lower(m_mtype);
}

References m_mtype.

Referenced by warnIfUndocumented().

◆ mergeMemberSpecifiers()

void MemberDefImpl::mergeMemberSpecifiers ( TypeSpecifier s )

overridevirtual

Implements MemberDefMutable.

Definition at line 5890 of file memberdef.cpp.

{
  m_memSpec.merge(s);
}

References m_memSpec.

◆ moveArgumentList()

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

overridevirtual

Implements MemberDefMutable.

Definition at line 4936 of file memberdef.cpp.

{
  m_defArgList = *al;
}

References m_defArgList.

◆ moveDeclArgumentList()

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

overridevirtual

Implements MemberDefMutable.

Definition at line 4941 of file memberdef.cpp.

{
  m_declArgList = *al;
}

References m_declArgList.

◆ moveTo()

void MemberDefImpl::moveTo ( Definition * scope )

overridevirtual

Implements MemberDef.

Definition at line 1583 of file memberdef.cpp.

{
   setOuterScope(scope);
   if (scope->definitionType()==Definition::TypeClass)
   {
     m_classDef = toClassDef(scope);
   }
   else if (scope->definitionType()==Definition::TypeFile)
   {
     m_fileDef = toFileDef(scope);
   }
   else if (scope->definitionType()==Definition::TypeModule)
   {
     m_moduleDef = toModuleDef(scope);
   }
   else if (scope->definitionType()==Definition::TypeNamespace)
   {
     m_nspace = toNamespaceDef(scope);
   }
   m_isLinkableCached = 0;
   m_isConstructorCached = 0;
}

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 6183 of file memberdef.cpp.

{
  return m_numberOfFlowKW;
}

References m_numberOfFlowKW.

◆ objCMethodName()

DString MemberDefImpl::objCMethodName	(	bool	localLink,
		bool	showStatic ) const

overridevirtual

Implements MemberDef.

Definition at line 5050 of file memberdef.cpp.

{
  DString qm;
  if (showStatic)
  {
    if (isStatic()) qm="+ "; else qm="- ";
  }
  qm+=name();
  if (!localLink) // link to method of same class
  {
    qm+=" (";
    qm+=getClassDef()->name();
    qm+=")";
  }
  return qm;
}

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

◆ overrideCallerGraph()

void MemberDefImpl::overrideCallerGraph ( bool e )

overridevirtual

Implements MemberDefMutable.

Definition at line 4969 of file memberdef.cpp.

{
  m_hasCallerGraph=e;
  if (e) Doxygen::parseSourcesNeeded = true;
}

References m_hasCallerGraph, and Doxygen::parseSourcesNeeded.

◆ overrideCallGraph()

void MemberDefImpl::overrideCallGraph ( bool e )

overridevirtual

Implements MemberDefMutable.

Definition at line 4963 of file memberdef.cpp.

{
  m_hasCallGraph=e;
  if (e) Doxygen::parseSourcesNeeded = true;
}

References m_hasCallGraph, and Doxygen::parseSourcesNeeded.

◆ overrideEnumValues()

void MemberDefImpl::overrideEnumValues ( bool e )

overridevirtual

Implements MemberDefMutable.

Definition at line 4987 of file memberdef.cpp.

{
  m_hasEnumValues=e;
}

References m_hasEnumValues.

◆ overrideInlineSource()

void MemberDefImpl::overrideInlineSource ( bool e )

overridevirtual

Implements MemberDefMutable.

Definition at line 4992 of file memberdef.cpp.

{
  m_hasInlineSource=e;
}

References m_hasInlineSource.

◆ overrideReferencedByRelation()

void MemberDefImpl::overrideReferencedByRelation ( bool e )

overridevirtual

Implements MemberDefMutable.

Definition at line 4975 of file memberdef.cpp.

{
  m_hasReferencedByRelation=e;
  if (e) Doxygen::parseSourcesNeeded = true;
}

References m_hasReferencedByRelation, and Doxygen::parseSourcesNeeded.

◆ overrideReferencesRelation()

void MemberDefImpl::overrideReferencesRelation ( bool e )

overridevirtual

Implements MemberDefMutable.

Definition at line 4981 of file memberdef.cpp.

{
  m_hasReferencesRelation=e;
  if (e) Doxygen::parseSourcesNeeded = true;
}

References m_hasReferencesRelation, and Doxygen::parseSourcesNeeded.

◆ protection()

Protection MemberDefImpl::protection ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5207 of file memberdef.cpp.

{
  return m_prot;
}

References m_prot.

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

◆ qualifiedName()

DString MemberDefImpl::qualifiedName ( ) const

overridevirtual

Returns the fully qualified name of this definition

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 5015 of file memberdef.cpp.

{
  if (isObjCMethod())
  {
    DString qm;
    if (isStatic()) qm="+"; else qm="-";
    qm+="[";
    qm+=getClassDef()->name()+" ";
    qm+=name();
    qm+="]";
    return qm;
  }
  else if (m_enumScope && m_enumScope->isStrong())
  {
    return m_enumScope->qualifiedName()+
           getLanguageSpecificSeparator(getLanguage())+
           localName();
  }
  else
  {
    return DefinitionMixin::qualifiedName();
  }
}

References getClassDef(), DefinitionMixin< MemberDefMutable >::getLanguage(), getLanguageSpecificSeparator(), isObjCMethod(), isStatic(), MemberDef::isStrong(), DefinitionMixin< MemberDefMutable >::localName(), m_enumScope, Definition::name(), DefinitionMixin< MemberDefMutable >::name(), Definition::qualifiedName(), 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 6548 of file memberdef.cpp.

{
  return m_redefineCount;
}

References m_redefineCount.

◆ reimplementedBy()

const MemberVector & MemberDefImpl::reimplementedBy ( ) const

overridevirtual

Implements MemberDef.

Definition at line 1633 of file memberdef.cpp.

{
  return m_redefinedBy;
}

References m_redefinedBy.

Referenced by _countReimplementedBy(), and _writeReimplementedBy().

◆ reimplements()

const MemberDef * MemberDefImpl::reimplements ( ) const

overridevirtual

Implements MemberDef.

Definition at line 1628 of file memberdef.cpp.

{
  return m_redefines;
}

References m_redefines.

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

◆ relatedAlso()

ClassDef * MemberDefImpl::relatedAlso ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5567 of file memberdef.cpp.

{
  return m_relatedAlso;
}

References m_relatedAlso.

◆ requiresClause()

DString MemberDefImpl::requiresClause ( ) const

overridevirtual

Implements MemberDef.

Definition at line 6108 of file memberdef.cpp.

{
  return m_requiresClause;
}

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 5657 of file memberdef.cpp.

{
  ArgumentList &decAl = m_declArgList;
  ArgumentList &defAl = m_defArgList;
  const ArgumentList &decAlSrc = md->declArgumentList();
  const ArgumentList &defAlSrc = md->argumentList();
  auto decSrc = decAlSrc.begin(), defSrc = defAlSrc.begin();
  for (auto decIt = decAl.begin(), defIt = defAl.begin();
       decIt != decAl.end() && defIt != defAl.end() && decSrc != decAlSrc.end() && defSrc != defAlSrc.end();
       ++decIt, ++defIt, ++decSrc, ++defSrc++)
  {
    Argument &decA = *decIt;
    Argument &defA = *defIt;
    const Argument &decAS = *decSrc;
    const Argument &defAS = *defSrc;
    if (decA.name.empty())
    {
      if (!defA.name.empty())
      {
        decA.name = defA.name;
      }
      else if (!decAS.name.empty())
      {
        decA.name = decAS.name;
      }
      else if (!defAS.name.empty())
      {
        decA.name = defAS.name;
      }
    }
    if (defA.name.empty())
    {
      if (!decA.name.empty())
      {
        defA.name = decA.name;
      }
      else if (!decAS.name.empty())
      {
        defA.name = decAS.name;
      }
      else if (!defAS.name.empty())
      {
        defA.name = defAS.name;
      }
    }
  }
}

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

◆ setAnchor()

void MemberDefImpl::setAnchor ( )

overridevirtual

Implements MemberDefMutable.

Definition at line 4413 of file memberdef.cpp.

{
  DString memAnchor = name();
  if (!m_args.empty()) memAnchor+=m_args;
  if (m_memSpec.isAlias()) // this is for backward compatibility
  {
    memAnchor.prepend(" =  "+m_initializer);
  }
  memAnchor.prepend(definition()); // actually the method name is now included
            // twice, which is silly, but we keep it this way for backward
            // compatibility.
 
  // include number of template arguments as well,
  // to distinguish between two template
  // specializations that only differ in the template parameters.
  if (m_tArgList.hasParameters())
  {
    char buf[20];
    snprintf(buf,20,"%d:",static_cast<int>(m_tArgList.size()));
    buf[19]='\0';
    memAnchor.prepend(buf);
  }
  if (!m_requiresClause.empty())
  {
    memAnchor+=" "+m_requiresClause;
  }
  if (m_redefineCount>0)
  {
    char buf[20];
    snprintf(buf,20,":%d",m_redefineCount);
    buf[19]='\0';
    memAnchor.append(buf);
  }
 
  // convert to md5 hash
  m_anc = "a"+md5str(memAnchor.view());
}

References DString::append(), definition(), DString::empty(), ArgumentList::hasParameters(), m_anc, m_args, m_initializer, m_memSpec, m_redefineCount, m_requiresClause, m_tArgList, md5str(), DefinitionMixin< MemberDefMutable >::name(), DString::prepend(), ArgumentList::size(), and DString::view().

◆ setAnonymousEnumType()

void MemberDefImpl::setAnonymousEnumType ( const MemberDef * md )

overridevirtual

Implements MemberDefMutable.

Definition at line 5979 of file memberdef.cpp.

{
  m_annEnumType = md;
}

References m_annEnumType.

◆ setAnonymousMemberForDeclaration()

void MemberDefImpl::setAnonymousMemberForDeclaration ( const MemberDef * md )

overridevirtual

Implements MemberDefMutable.

Definition at line 5984 of file memberdef.cpp.

{
  m_annMemberForDecl = md;
}

References m_annMemberForDecl.

◆ setAnonymousMemberForDetails()

void MemberDefImpl::setAnonymousMemberForDetails ( const MemberDef * md )

overridevirtual

Implements MemberDefMutable.

Definition at line 5989 of file memberdef.cpp.

{
  m_annMemberForDetails = md;
}

References m_annMemberForDetails.

◆ setArgsString()

void MemberDefImpl::setArgsString ( const DString & as )

overridevirtual

Implements MemberDefMutable.

Definition at line 5957 of file memberdef.cpp.

{
  m_args = as;
}

References m_args.

◆ setBitfields()

void MemberDefImpl::setBitfields ( const DString & s )

overridevirtual

Implements MemberDefMutable.

Definition at line 5912 of file memberdef.cpp.

{
  m_bitfields = DString(s).simplifyWhiteSpace();
}

References m_bitfields, and DString::simplifyWhiteSpace().

◆ setBriefDescription()

void MemberDefImpl::setBriefDescription	(	const DString &	b,
		const DString &	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 1913 of file memberdef.cpp.

{
  DefinitionMixin::setBriefDescription(b,briefFile,briefLine);
  m_isLinkableCached = 0;
}

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 6078 of file memberdef.cpp.

{
  m_category = def;
}

References m_category.

◆ setCategoryRelation()

void MemberDefImpl::setCategoryRelation ( const MemberDef * md )

overridevirtual

Implements MemberDefMutable.

Definition at line 6088 of file memberdef.cpp.

{
  m_categoryRelation = md;
}

References m_categoryRelation.

◆ setClassDefOfAnonymousType()

void MemberDefImpl::setClassDefOfAnonymousType ( const ClassDef * cd )

overridevirtual

Implements MemberDefMutable.

Definition at line 2023 of file memberdef.cpp.

{
  m_anonymousType = cd;
}

References m_anonymousType.

◆ setDeclFile()

void MemberDefImpl::setDeclFile	(	const DString &	df,
		int	line,
		size_t	column )

overridevirtual

Implements MemberDefMutable.

Definition at line 6020 of file memberdef.cpp.

{
  m_declFileName = df;
  m_declLine = line;
  m_declColumn = column;
}

References m_declColumn, m_declFileName, and m_declLine.

Referenced by setExplicitExternal(), and setPrototype().

◆ setDefinition()

void MemberDefImpl::setDefinition ( const DString & d )

overridevirtual

Implements MemberDefMutable.

Definition at line 5856 of file memberdef.cpp.

{
  m_def=d;
}

References m_def.

◆ setDefinitionTemplateParameterLists()

void MemberDefImpl::setDefinitionTemplateParameterLists ( const ArgumentLists & lists )

overridevirtual

Implements MemberDefMutable.

Definition at line 1965 of file memberdef.cpp.

{
  m_defTmpArgLists = lists;
}

References m_defTmpArgLists.

◆ setDocsForDefinition()

void MemberDefImpl::setDocsForDefinition ( bool b )

overridevirtual

Implements MemberDefMutable.

Definition at line 6048 of file memberdef.cpp.

{
  m_docsForDefinition = b;
}

References m_docsForDefinition.

◆ setDocTransferDone()

void MemberDefImpl::setDocTransferDone ( )

overridevirtual

Implements MemberDefMutable.

Definition at line 1919 of file memberdef.cpp.

{
  m_docTransferDone = true;
}

References m_docTransferDone.

◆ setDocumentation()

void MemberDefImpl::setDocumentation	(	const DString &	d,
		const DString &	docFile,
		int	docLine,
		bool	stripWhiteSpace = true )

overridevirtual

Sets the documentation of this definition to d.

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 1907 of file memberdef.cpp.

{
  DefinitionMixin::setDocumentation(d,docFile,docLine,stripWhiteSpace);
  m_isLinkableCached = 0;
}

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 5974 of file memberdef.cpp.

{
  m_docEnumValues=value;
}

References m_docEnumValues.

◆ setEnumBaseType()

void MemberDefImpl::setEnumBaseType ( const DString & type )

overridevirtual

Implements MemberDefMutable.

Definition at line 6093 of file memberdef.cpp.

{
  m_enumBaseType = type;
}

References m_enumBaseType.

◆ setEnumClassScope()

void MemberDefImpl::setEnumClassScope ( ClassDef * cd )

overridevirtual

Implements MemberDefMutable.

Definition at line 5967 of file memberdef.cpp.

{
  m_classDef = cd;
  m_isLinkableCached = 0;
  m_isConstructorCached = 0;
}

References m_classDef, m_isConstructorCached, and m_isLinkableCached.

◆ setEnumScope()

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

overridevirtual

Implements MemberDefMutable.

Definition at line 4465 of file memberdef.cpp.

{
  m_enumScope=md;
  m_livesInsideEnum=livesInsideEnum;
  if (md->getGroupDef())
  {
    m_group           = md->getGroupDef();
    m_grouppri        = md->getGroupPri();
    m_groupFileName   = md->getGroupFileName();
    m_groupStartLine  = md->getGroupStartLine();
    m_groupHasDocs    = md->getGroupHasDocs();
    m_isLinkableCached = 0;
  }
}

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 DString &	df,
		int	line,
		size_t	column )

overridevirtual

Implements MemberDefMutable.

Definition at line 6007 of file memberdef.cpp.

{
  m_explExt=b;
  if (b)
  {
    setDeclFile(df,line,column);
  }
  else
  {
    setDefFile(df,line,column);
  }
}

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

◆ setExplicitInherited()

void MemberDefImpl::setExplicitInherited ( bool b )

overridevirtual

Implements MemberDefMutable.

Definition at line 1924 of file memberdef.cpp.

{
  m_explicitInherited = b;
}

References m_explicitInherited.

◆ setFileDef()

void MemberDefImpl::setFileDef ( FileDef * fd )

overridevirtual

Implements MemberDefMutable.

Definition at line 5861 of file memberdef.cpp.

{
  m_fileDef=fd;
  m_isLinkableCached = 0;
  m_isConstructorCached = 0;
  m_isDestructorCached = 0;
}

References m_fileDef, m_isConstructorCached, m_isDestructorCached, and m_isLinkableCached.

Referenced by _writeMultiLineInitializer().

◆ setFormalTemplateArguments()

void MemberDefImpl::setFormalTemplateArguments ( const ArgumentList & al )

overridevirtual

Implements MemberDefMutable.

Definition at line 6043 of file memberdef.cpp.

{
  m_formalTemplateArguments = al;
}

References m_formalTemplateArguments.

◆ setGroupAlias()

void MemberDefImpl::setGroupAlias ( const MemberDef * md )

overridevirtual

Implements MemberDefMutable.

Definition at line 6053 of file memberdef.cpp.

{
  m_groupAlias = md;
}

References m_groupAlias.

◆ setGroupDef()

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

overridevirtual

Implements MemberDefMutable.

Definition at line 4451 of file memberdef.cpp.

{
  //printf("%s MemberDefImpl::setGroupDef(%s)\n",qPrint(name()),qPrint(gd->name()));
  m_group=gd;
  m_grouppri=pri;
  m_groupFileName=fileName;
  m_groupStartLine=startLine;
  m_groupHasDocs=hasDocs;
  m_groupMember=member;
  m_isLinkableCached = 0;
}

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 1935 of file memberdef.cpp.

{
  DefinitionMixin::setHidden(b);
  m_isLinkableCached = 0;
}

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

◆ setInbodyDocumentation()

void MemberDefImpl::setInbodyDocumentation	(	const DString &	d,
		const DString &	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 1929 of file memberdef.cpp.

{
  DefinitionMixin::setInbodyDocumentation(d,inbodyFile,inbodyLine);
  m_isLinkableCached = 0;
}

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

◆ setIncludeFile()

void MemberDefImpl::setIncludeFile	(	FileDef *	fd,
		const DString &	incName,
		bool	local,
		bool	force )

overridevirtual

Implements MemberDefMutable.

Definition at line 6479 of file memberdef.cpp.

{
  if (!force || includeName.empty()) return;
  //printf("MemberDefImpl::setIncludeFile(%p,%s,%d,%d)\n",fd,includeName,local,force);
  if (!m_incInfo) m_incInfo = std::make_unique<IncludeInfo>();
  m_incInfo->fileDef     = fd;
  m_incInfo->includeName = includeName;
  m_incInfo->kind        = local ? IncludeKind::IncludeLocal : IncludeKind::IncludeSystem;
}

References DString::empty(), IncludeLocal, IncludeSystem, and m_incInfo.

◆ setInheritsDocsFrom()

void MemberDefImpl::setInheritsDocsFrom ( const MemberDef * md )

overridevirtual

Implements MemberDefMutable.

Definition at line 5952 of file memberdef.cpp.

{
  m_docProvider = md;
}

References m_docProvider.

◆ setInitializer()

void MemberDefImpl::setInitializer ( const DString & i )

overridevirtual

Implements MemberDefMutable.

Definition at line 4559 of file memberdef.cpp.

{
  size_t indent=0;
  m_initializer=detab(initializer,indent);
  int l=static_cast<int>(m_initializer.length());
  int p=l-1;
  while (p>=0 && isspace(static_cast<uint8_t>(m_initializer.at(p)))) p--;
  m_initializer=m_initializer.left(p+1);
  m_initLines=m_initializer.contains('\n');
  stripIndentationVerbatim(m_initializer,indent, false);
 
  //printf("%s::setInitializer(%s)\n",qPrint(name()),qPrint(m_initializer));
}

References DString::at(), DString::contains(), detab(), initializer(), DString::left(), DString::length(), m_initializer, m_initLines, and stripIndentationVerbatim().

◆ setMaxInitLines()

void MemberDefImpl::setMaxInitLines ( int lines )

overridevirtual

Implements MemberDefMutable.

Definition at line 5917 of file memberdef.cpp.

{
  if (lines!=-1)
  {
    m_userInitLines=lines;
  }
}

References m_userInitLines.

◆ setMemberClass()

void MemberDefImpl::setMemberClass ( ClassDef * cd )

overridevirtual

Implements MemberDefMutable.

Definition at line 4480 of file memberdef.cpp.

{
  m_classDef=cd;
  m_isLinkableCached = 0;
  m_isConstructorCached = 0;
  setOuterScope(cd);
}

References m_classDef, m_isConstructorCached, m_isLinkableCached, and DefinitionMixin< MemberDefMutable >::setOuterScope().

◆ setMemberDeclaration()

void MemberDefImpl::setMemberDeclaration ( MemberDef * md )

overridevirtual

Implements MemberDefMutable.

Definition at line 6068 of file memberdef.cpp.

{
  m_memDec=md;
}

References m_memDec.

◆ setMemberDefinition()

void MemberDefImpl::setMemberDefinition ( MemberDef * md )

overridevirtual

Implements MemberDefMutable.

Definition at line 6063 of file memberdef.cpp.

{
  m_memDef=md;
}

References m_memDef.

◆ setMemberGroup()

void MemberDefImpl::setMemberGroup ( MemberGroup * grp )

overridevirtual

Implements MemberDef.

Definition at line 4399 of file memberdef.cpp.

{
  m_memberGroup = grp;
}

References m_memberGroup.

◆ setMemberGroupId()

void MemberDefImpl::setMemberGroupId ( int id )

overridevirtual

Implements MemberDefMutable.

Definition at line 6027 of file memberdef.cpp.

{
  m_grpId=id;
}

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

◆ setMemberSpecifiers()

void MemberDefImpl::setMemberSpecifiers ( TypeSpecifier s )

overridevirtual

Implements MemberDefMutable.

Definition at line 5880 of file memberdef.cpp.

{
  m_memSpec=s;
}

References m_memSpec.

◆ setMemberType()

void MemberDefImpl::setMemberType ( MemberType t )

overridevirtual

Implements MemberDefMutable.

Definition at line 5850 of file memberdef.cpp.

{
  m_mtype=t;
  m_isLinkableCached = 0;
}

References m_isLinkableCached, and m_mtype.

◆ setModuleDef()

void MemberDefImpl::setModuleDef ( ModuleDef * mod )

overridevirtual

Implements MemberDefMutable.

Definition at line 5869 of file memberdef.cpp.

{
  m_moduleDef=mod;
}

References m_moduleDef.

◆ setNamespace()

void MemberDefImpl::setNamespace ( NamespaceDef * nd )

overridevirtual

Implements MemberDefMutable.

Definition at line 4488 of file memberdef.cpp.

{
  m_nspace=nd;
  setOuterScope(nd);
}

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

◆ setProtection()

void MemberDefImpl::setProtection ( Protection p )

overridevirtual

Implements MemberDefMutable.

Definition at line 5874 of file memberdef.cpp.

{
  m_prot=p;
  m_isLinkableCached = 0;
}

References m_isLinkableCached, and m_prot.

◆ setPrototype()

void MemberDefImpl::setPrototype	(	bool	p,
		const DString &	df,
		int	line,
		size_t	column )

overridevirtual

Implements MemberDefMutable.

Definition at line 5994 of file memberdef.cpp.

{
  m_proto=p;
  if (p)
  {
    setDeclFile(df,line,column);
  }
  else
  {
    setDefFile(df,line,column);
  }
}

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

◆ setReadAccessor()

void MemberDefImpl::setReadAccessor ( const DString & r )

overridevirtual

Implements MemberDefMutable.

Definition at line 5925 of file memberdef.cpp.

{
  m_read=r;
}

References m_read.

◆ setRedefineCount()

void MemberDefImpl::setRedefineCount ( int count )

overridevirtual

Implements MemberDefMutable.

Definition at line 6553 of file memberdef.cpp.

{
  m_redefineCount=count;
}

References m_redefineCount.

◆ setReimplements()

void MemberDefImpl::setReimplements ( MemberDef * md )

overridevirtual

Implements MemberDefMutable.

Definition at line 1607 of file memberdef.cpp.

{
  m_redefines = md;
}

References m_redefines.

◆ setRelatedAlso()

void MemberDefImpl::setRelatedAlso ( ClassDef * cd )

overridevirtual

Implements MemberDefMutable.

Definition at line 5962 of file memberdef.cpp.

{
  m_relatedAlso=cd;
}

References m_relatedAlso.

◆ setRequiresClause()

void MemberDefImpl::setRequiresClause ( const DString & req )

overridevirtual

Implements MemberDefMutable.

Definition at line 6103 of file memberdef.cpp.

{
  m_requiresClause = req;
}

References m_requiresClause.

◆ setSectionList()

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

overridevirtual

Implements MemberDefMutable.

Definition at line 4631 of file memberdef.cpp.

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

References m_sectionMap.

◆ setTagInfo()

void MemberDefImpl::setTagInfo ( const TagInfo * i )

overridevirtual

Implements MemberDefMutable.

Definition at line 5039 of file memberdef.cpp.

{
  if (ti)
  {
    //printf("%s: Setting tag name=%s anchor=%s\n",qPrint(name()),qPrint(ti->tagName),qPrint(ti->anchor));
    m_anc=ti->anchor;
    setReference(ti->tagName);
    m_explicitOutputFileBase = stripExtension(ti->fileName);
  }
}

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 6037 of file memberdef.cpp.

{
  m_templateMaster=mt;
  m_isLinkableCached = 0;
}

References m_isLinkableCached, and m_templateMaster.

◆ setTemplateSpecialization()

void MemberDefImpl::setTemplateSpecialization ( bool b )

overridevirtual

Implements MemberDefMutable.

Definition at line 5935 of file memberdef.cpp.

{
  m_tspec=b;
}

References m_tspec.

◆ setType()

void MemberDefImpl::setType ( const DString & t )

overridevirtual

Implements MemberDefMutable.

Definition at line 4951 of file memberdef.cpp.

{
  m_type = t;
}

References m_type.

◆ setTypeConstraints()

void MemberDefImpl::setTypeConstraints ( const ArgumentList & al )

overridevirtual

Implements MemberDefMutable.

Definition at line 4946 of file memberdef.cpp.

{
  m_typeConstraints = al;
}

References m_typeConstraints.

◆ setVhdlSpecifiers()

void MemberDefImpl::setVhdlSpecifiers ( VhdlSpecifier s )

overridevirtual

Implements MemberDefMutable.

Definition at line 5885 of file memberdef.cpp.

{
  m_vhdlSpec=s;
}

References m_vhdlSpec.

◆ setWriteAccessor()

void MemberDefImpl::setWriteAccessor ( const DString & w )

overridevirtual

Implements MemberDefMutable.

Definition at line 5930 of file memberdef.cpp.

{
  m_write=w;
}

References m_write.

◆ sourceRefName()

DString MemberDefImpl::sourceRefName ( ) const

overridevirtual

Implements MemberDef.

Definition at line 1673 of file memberdef.cpp.

{
  DString n  = name();
  DString s = getScopeString();
 
  if (!s.empty())
  {
    n.prepend(s+"::");
  }
  else if (isStatic() && getFileDef())
  {
    n.prepend(getFileDef()->name()+":");
  }
  if (isCallable())
  {
    n.append(argsString());
  }
  return n;
}

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

◆ templateArguments()

const ArgumentList & MemberDefImpl::templateArguments ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5705 of file memberdef.cpp.

{
  return m_tArgList;
}

References m_tArgList.

◆ templateMaster()

const MemberDef * MemberDefImpl::templateMaster ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5781 of file memberdef.cpp.

{
  return m_templateMaster;
}

References m_templateMaster.

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

◆ typeConstraints()

const ArgumentList & MemberDefImpl::typeConstraints ( ) const

overridevirtual

Implements MemberDef.

Definition at line 6473 of file memberdef.cpp.

{
  return m_typeConstraints;
}

References m_typeConstraints.

◆ typeString()

DString MemberDefImpl::typeString ( ) const

overridevirtual

Implements MemberDef.

Definition at line 5082 of file memberdef.cpp.

{
  return m_type;
}

References m_type.

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

◆ virtualness()

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

overridevirtual

Implements MemberDef.

Definition at line 4637 of file memberdef.cpp.

{
  if (count>25)
  {
     warn(getDefFileName(),getDefLine(),
       "Internal inconsistency: recursion detected in overload relation for member {}!",name());
     return Specifier::Normal;
  }
  Specifier v = m_virt;
  const MemberDef *rmd = reimplements();
  while (rmd && v==Specifier::Normal)
  {
    v = rmd->virtualness(count+1)==Specifier::Normal ? Specifier::Normal : Specifier::Virtual;
    rmd = rmd->reimplements();
  }
  return v;
}

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 4229 of file memberdef.cpp.

{
  bool hideUndocMembers = Config_getBool(HIDE_UNDOC_MEMBERS);
  bool extractStatic = Config_getBool(EXTRACT_STATIC);
  return (!isAnonymous() &&
      (!hideUndocMembers || hasDocumentation()) &&
      (!isStatic() || extractStatic) &&
      isLinkable()
     );
}

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

◆ warnIfUndocumented()

void MemberDefImpl::warnIfUndocumented ( ) const

overridevirtual

Implements MemberDef.

Definition at line 4157 of file memberdef.cpp.

{
  /*
   *  Removed bug_303020:
   *  if (m_memberGroup) return;
   */
  const ClassDef     *cd = getClassDef();
  const NamespaceDef *nd = getNamespaceDef();
  const FileDef      *fd = getFileDef();
  const GroupDef     *gd = getGroupDef();
  const Definition *d=nullptr;
  DString t;
  if (cd)
  {
    t=cd->compoundTypeString();
    d=cd;
  }
  else if (nd)
  {
    t=nd->compoundTypeString();
    d=nd;
  }
  else if (gd)
  {
    t="group";
    d=gd;
  }
  else
  {
    t="file";
    d=fd;
  }
  bool extractAll = Config_getBool(EXTRACT_ALL);
 
  //printf("%s:warnIfUndoc: hasUserDocs=%d isFriendClass=%d protection=%d isRef=%d isDel=%d\n",
  //    qPrint(name()),
  //    hasUserDocumentation(),isFriendClass(),protectionLevelVisible(m_prot),isReference(),isDeleted());
  if ((!hasUserDocumentation() && !extractAll) &&
      !isFriendClass() &&
      name().find('@')==DString::npos && d && d->name().find('@')==DString::npos &&
      !_isAnonymousBitField() &&
      protectionLevelVisible(m_prot) &&
      !isReference() && !isDeleted()
     )
  {
    SrcLangExt lang = getLanguage();
    DString sep = getLanguageSpecificSeparator(lang,true);
    warn_undoc(getDefFileName(),getDefLine(),"Member {}{} ({}) of {} {} is not documented.",
         name(),argsString(),memberTypeName(),t,
         substitute(d->name(),"::",sep));
  }
  else if (!hasDetailedDescription())
  {
    warnIfUndocumentedParams();
  }
 
  // if it is an enum, we check that its members are documented
  if (!extractAll && isEnumerate() && Config_getBool(WARN_IF_UNDOC_ENUM_VAL))
  {
    for (const auto &fmd : enumFieldList())
    {
      if (!fmd->isLinkableInProject())
      {
        SrcLangExt lang = getLanguage();
        DString sep = getLanguageSpecificSeparator(lang,true);
        warn(fmd->getDefFileName(),fmd->getDefLine(), "Documentation for enum member '{}{}{}' is missing.",
             qualifiedName(),sep,fmd->name());
      }
    }
  }
}

References _isAnonymousBitField(), argsString(), ClassDef::compoundTypeString(), NamespaceDef::compoundTypeString(), Config_getBool, enumFieldList(), DString::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(), DString::npos, protectionLevelVisible(), qualifiedName(), substitute(), warn, warn_undoc, and warnIfUndocumentedParams().

Referenced by writeDeclaration().

◆ warnIfUndocumentedParams()

void MemberDefImpl::warnIfUndocumentedParams ( ) const

overridevirtual

Implements MemberDef.

Definition at line 4319 of file memberdef.cpp.

{
  DString returnType = typeString();
  bool isFortran = getLanguage()==SrcLangExt::Fortran;
  bool isFortranSubroutine = isFortran && returnType.find("subroutine")!=DString::npos;
 
  bool isVoidReturn =   returnType=="void" || returnType.endsWith(" void");
  if (!isVoidReturn && (returnType=="auto" || returnType.endsWith(" auto")))
  {
    const ArgumentList &defArgList=isDocsForDefinition() ?  argumentList() : declArgumentList();
    if (!defArgList.trailingReturnType().empty())
    {
      DString strippedTrailingReturn = stripTrailingReturn(defArgList.trailingReturnType());
      isVoidReturn = (strippedTrailingReturn=="void") || (strippedTrailingReturn.endsWith(" void"));
    }
  }
  if (!Config_getBool(EXTRACT_ALL) &&
      Config_getBool(WARN_IF_UNDOCUMENTED) &&
      Config_getBool(WARN_NO_PARAMDOC) &&
      isFunction() &&
      !isDeleted() &&
      !isReference() &&
      !Doxygen::suppressDocWarnings)
  {
    if (!m_hasDocumentedParams)
    {
      warn_doc_error(docFile(),docLine(),
          "parameters of member {} are not documented",
          qualifiedName());
    }
    if (!m_hasDocumentedReturnType &&
        hasDocumentation() && !returnType.empty() &&
        !( // not one of the cases where nothing is returned
          isVoidReturn        || // void return type
          isFortranSubroutine || // fortran subroutine
          isConstructor()     || // a constructor
          isDestructor()      || // or a destructor
          isFriend()             // or a friend
         )
       )
    {
      warn_doc_error(docFile(),docLine(),
          "return type of member {} is not documented",
          qualifiedName());
    }
  }
  if (Config_getBool(WARN_IF_DOC_ERROR) &&
            m_hasDocumentedReturnType &&
            (isVoidReturn        || // void return type
             isFortranSubroutine || // fortran subroutine
             isConstructor()     || // a constructor
             isDestructor()))       // or destructor
  {
    warn_doc_error(docFile(),docLine(),"found documented return type for {} that does not return anything",
                   qualifiedName());
  }
}

References argumentList(), Config_getBool, declArgumentList(), DefinitionMixin< MemberDefMutable >::docFile(), DefinitionMixin< MemberDefMutable >::docLine(), DString::empty(), DString::endsWith(), DString::find(), DefinitionMixin< MemberDefMutable >::getLanguage(), hasDocumentation(), isConstructor(), isDeleted(), isDestructor(), isDocsForDefinition(), isFriend(), isFunction(), isReference(), m_hasDocumentedParams, m_hasDocumentedReturnType, DString::npos, 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 DString &	inheritId = DString() ) const

overridevirtual

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

Implements MemberDef.

Definition at line 2223 of file memberdef.cpp.

{
  //printf("> %s MemberDefImpl::writeDeclaration() inGroup=%d inheritId=%s\n",qPrint(qualifiedName()),inGroup,qPrint(inheritId));
 
  // hide enum value, since they appear already as part of the enum, unless they
  // are explicitly grouped.
  if (!inGroup && m_mtype==MemberType::EnumValue) return;
 
  const Definition *d=nullptr;
  ASSERT (cd!=nullptr || nd!=nullptr || fd!=nullptr || gd!=nullptr || mod!=nullptr); // member should belong to something
  if (cd) d=cd;
  else if (nd) d=nd;
  else if (fd) d=fd;
  else d=gd;
  if (d==gd || d==mod) // see bug 753608
  {
    if (getClassDef())          d = getClassDef();
    else if (getNamespaceDef()) d = getNamespaceDef();
    else if (getFileDef())      d = getFileDef();
  }
  else if (d==fd) // see issue #9850, namespace member can be shown in file scope as well
  {
    if (getNamespaceDef()) d = getNamespaceDef();
  }
  if (d==nullptr)
  {
    err("No context could be derived for member '{}'\n",name());
    return; // should not happen
  }
 
  DString cname  = d->name();
  DString cdname = d->displayName();
  DString cfname = getOutputFileBase();
 
  // search for the last anonymous scope in the member type
  const ClassDef *annoClassDef=getClassDefOfAnonymousType();
 
  ol.startMemberDeclaration();
 
  // start a new member declaration
  OutputGenerator::MemberItemType anonType = !m_tArgList.empty() ? OutputGenerator::MemberItemType::Templated      :
                                                                   OutputGenerator::MemberItemType::Normal;
  ol.startMemberItem(annoClassDef && isAnonymous() ? DString() : anchor(), anonType, inheritId);
 
 
  // If there is no detailed description we need to write the anchor here.
  bool detailsVisible = hasDetailedDescription();
  bool writeAnchor = (inGroup || getGroupDef()==nullptr) &&     // only write anchors for member that have no details and are
                     !detailsVisible &&                         // rendered inside the group page or are not grouped at all
                     inheritId.empty();
 
  if (writeAnchor)
  {
    DString doxyArgs=argsString();
    DString doxyName=name();
    if (!cname.empty())
    {
      doxyName.prepend(cdname+getLanguageSpecificSeparator(getLanguage()));
    }
    ol.startDoxyAnchor(cfname,cname,anchor(),doxyName,doxyArgs);
    ol.addLabel(cfname,anchor());
  }
 
  if (!detailsVisible)
  {
    ol.pushGeneratorState();
    ol.disable(OutputType::Man);
    ol.disable(OutputType::Latex);
    ol.disable(OutputType::Docbook);
    ol.docify("\n");
    ol.popGeneratorState();
  }
 
  if (annoClassDef)
  {
    for (int j=0;j<indentLevel;j++)
    {
      ol.writeNonBreakableSpace(3);
    }
  }
 
  // *** write template lists
  if (m_tArgList.hasParameters() && getLanguage()==SrcLangExt::Cpp)
  {
     ol.startMemberTemplateParams();
    _writeTemplatePrefix(ol,d,m_tArgList);
     ol.endMemberTemplateParams(anchor(),inheritId);
  }
 
 
  // *** write type
  DString ltype(m_type);
  auto lang = getLanguage();
  if (isTypedef() && lang != SrcLangExt::Slice)
  {
    ltype.prepend("typedef ");
  }
  if (isTypeAlias())
  {
    if (lang==SrcLangExt::Python)
    {
      ltype="type";
    }
    else
    {
      ltype="using";
    }
  }
  // strip 'friend' keyword from ltype
  ltype.stripPrefix("friend ");
  static const reg::Ex r(R"(@\d+)"); // anonymous type marker
  reg::Match match;
  std::string stype = ltype.str();
  bool endAnonScopeNeeded=false;
  LinkifyTextOptions options;
  options.setScope(d).setFileScope(getBodyDef()).setSelf(this);
  if (reg::search(stype,match,r)) // member has an anonymous type marker
  {
    //printf("name=%s annoClassDef=%p stype='%s' scopeName='%s'\n",
    //    qPrint(name()),(void*)annoClassDef,qPrint(stype),qPrint(cname));
 
    static const reg::Ex ar(R"([\w@:]*@\d+[\w@:]*)"); // anonymous type marker(s) including scope
    reg::Match amatch;
    reg::search(stype,amatch,ar);
    size_t ai = amatch.position();
    size_t al = amatch.length();
    const MemberDef *amd = getAnonymousEnumType();
    if (annoClassDef && amd==nullptr) // type is an anonymous compound
    {
      if (isAnonymous()) // anonymous type without a variable name, e.g. "struct { int x; };" or "union { int x; };"
      {
        ol.startAnonTypeScope(indentLevel);
        annoClassDef->writeDeclaration(ol,inGroup,indentLevel+1,inheritedFrom,inheritId);
        //printf(">>>>>>>>>>>>>> startMemberItem(2)\n");
        anonType = OutputGenerator::MemberItemType::AnonymousEnd;
        ol.startMemberItem(anchor(),anonType,inheritId);
        for (int j=0;j< indentLevel;j++)
        {
          ol.writeNonBreakableSpace(3);
        }
        ol.docify("};");
        endAnonScopeNeeded=true;
      }
      else
      {
        ol.writeObjectLink(annoClassDef->getReference(),annoClassDef->getOutputFileBase(),
                           annoClassDef->anchor(),ltype.left(ai)+ltype.mid(ai+al));
      }
    }
    else if (amd) // type is an anonymous enum
    {
      DString typePlaceholder = " { ... } ";
      if (lang==SrcLangExt::Cpp)
      {
        if (amd->isEnumStruct()) typePlaceholder.prepend(" struct");
        else if (amd->isStrong()) typePlaceholder.prepend(" class");
      }
      ol.writeObjectLink(amd->getReference(),amd->getOutputFileBase(),
                         amd->anchor(),ltype.left(ai)+typePlaceholder+ltype.mid(ai+al));
    }
    else // fallback if anonymous type is not found
    {
      size_t i = match.position();
      size_t l = match.length();
      ltype = ltype.left(i) + " { ... } " + removeAnonymousScopes(ltype.mid(i+l));
      linkifyText(TextGeneratorOLImpl(ol), ltype, options);
    }
  }
  else if (ltype=="@") // rename type from enum values
  {
    ltype="";
  }
  else
  {
    if (isObjCMethod())
    {
      ltype.prepend("(");
      ltype.append(")");
    }
    linkifyText(TextGeneratorOLImpl(ol),ltype,options);
  }
 
  if (!ltype.empty())
  {
    ol.pushGeneratorState();
    ol.disable(OutputType::Html);
    ol.docify(" ");
    ol.popGeneratorState();
  }
 
  if (!isAnonymous())
  {
    ol.insertMemberAlign(m_tArgList.hasParameters());
  }
 
  // *** write name
  if (!isAnonymous() && !_isAnonymousBitField()) // hide anonymous stuff
  {
    bool extractPrivateVirtual = Config_getBool(EXTRACT_PRIV_VIRTUAL);
    bool extractStatic  = Config_getBool(EXTRACT_STATIC);
    bool visibleIfPrivate = (protectionLevelVisible(protection()) ||
                             m_mtype==MemberType::Friend ||
                             (m_prot==Protection::Private &&
                                (m_virt!=Specifier::Normal || isOverride() || isFinal()) &&
                                extractPrivateVirtual && hasDocumentation()
                             ));
    //printf("Member name=`%s gd=%p md->groupDef=%p inGroup=%d isLinkable()=%d hasDocumentation=%d\n",qPrint(name()),gd,getGroupDef(),inGroup,isLinkable(),hasDocumentation());
    if (!name().empty() && // name valid
        (hasDetailedDescription() || isReference()) && // has docs
        visibleIfPrivate &&
        !(isStatic() && getClassDef()==nullptr && !extractStatic) // hidden due to static-ness
       )
    {
      //printf("writeLink %s->%d\n",qPrint(name),hasDocumentation());
      const ClassDef *rcd = cd;
      if (isReference() && getClassDef()) rcd = getClassDef();
      writeLink(ol,rcd,nd,fd,gd,mod);
    }
    else if (isDocumentedFriendClass())
      // if the member is an undocumented friend declaration for some class,
      // then maybe we can link to the class
    {
      writeLink(ol,getClass(name()),nullptr,nullptr,nullptr,nullptr);
    }
    else
      // there is a brief member description and brief member
      // descriptions are enabled or there is no detailed description.
    {
      const ClassDef *rcd = cd;
      if (isReference() && getClassDef()) rcd = getClassDef();
      writeLink(ol,rcd,nd,fd,gd,mod,true);
    }
  }
 
  // *** write arguments
  if (!argsString().empty() && !isObjCMethod())
  {
    if (!isDefine() && !isTypedef()) ol.writeString(" ");
    linkifyText(TextGeneratorOLImpl(ol), // out
                isDefine() ?
                   substitute(argsString(),",",", ") :
                isTypedef() ?
                   substitute(argsString(),")(",") (") :
                   combineArgsAndException(argsString(),excpString()), // text
                LinkifyTextOptions(options)
                .setArgumentList(&m_defArgList)
                .setAutoBreak(false)
                .setIndentLevel(indentLevel)
               );
  }
 
  // *** write bitfields
  if (!m_bitfields.empty()) // add bitfields
  {
    linkifyText(TextGeneratorOLImpl(ol),m_bitfields,options);
  }
  else if (hasOneLineInitializer()
      //!init.empty() && initLines==0 && // one line initializer
      //((maxInitLines>0 && userInitLines==-1) || userInitLines>0) // enabled by default or explicitly
          ) // add initializer
  {
    if (isTypeAlias()) // using statement
    {
      ol.writeString(" = ");
      linkifyText(TextGeneratorOLImpl(ol),m_initializer.simplifyWhiteSpace(),options);
    }
    else if (!isDefine())
    {
      //ol.writeString(" = ");
      ol.writeString(" ");
      linkifyText(TextGeneratorOLImpl(ol),m_initializer.simplifyWhiteSpace(),options);
    }
    else
    {
      ol.writeNonBreakableSpace(3);
      linkifyText(TextGeneratorOLImpl(ol),m_initializer,options);
    }
  }
 
 
  if ((isObjCMethod() || isObjCProperty()) && isImplementation())
  {
    ol.startTypewriter();
    ol.docify(" [implementation]");
    ol.endTypewriter();
  }
 
  bool extractPrivate = Config_getBool(EXTRACT_PRIVATE);
 
  if (isProperty() && (isSettable() || isGettable() ||
      isPrivateSettable() || isPrivateGettable() ||
      isProtectedSettable() || isProtectedGettable() || isInitonly()))
  {
      ol.writeLatexSpacing();
      ol.startTypewriter();
      ol.docify(" [");
      StringVector sl;
 
      if (isGettable())             sl.emplace_back("get");
      if (isProtectedGettable())    sl.emplace_back("protected get");
      if (isSettable())             sl.emplace_back("set");
      if (isProtectedSettable())    sl.emplace_back("protected set");
      if (isInitonly())             sl.emplace_back("init");
      if (extractPrivate)
      {
        if (isPrivateGettable())    sl.emplace_back("private get");
        if (isPrivateSettable())    sl.emplace_back("private set");
      }
      bool first=true;
      for (const auto &s : sl)
      {
         if (!first)
         {
           ol.docify(", ");
         }
         first=false;
         ol.docify(s);
      }
      ol.docify("]");
      ol.endTypewriter();
  }
 
  if (isEvent() && (isAddable() || isRemovable() || isRaisable()))
  {
      ol.writeLatexSpacing();
      ol.startTypewriter();
      ol.docify(" [");
      StringVector sl;
      if (isAddable())   sl.emplace_back("add");
      if (isRemovable()) sl.emplace_back("remove");
      if (isRaisable())  sl.emplace_back("raise");
      bool first=true;
      for (const auto &s : sl)
      {
        if (!first)
        {
          ol.docify(", ");
        }
        first=false;
        ol.docify(s);
      }
      ol.docify("]");
      ol.endTypewriter();
  }
 
  if (writeAnchor)
  {
    ol.endDoxyAnchor(cfname,anchor());
  }
 
  //printf("endMember %s annoClassDef=%p annEnumType=%p\n",
  //    qPrint(name()),annoClassDef,annEnumType);
  ol.endMemberItem(anonType);
  if (endAnonScopeNeeded)
  {
    ol.endAnonTypeScope(indentLevel);
  }
 
  // write brief description
  if (!briefDescription().empty() &&
      Config_getBool(BRIEF_MEMBER_DESC)
     )
  {
    auto parser { createDocParser() };
    auto ast    { validatingParseDoc(*parser.get(),
                                     briefFile(),
                                     briefLine(),
                                     getOuterScope()?getOuterScope():d,
                                     this,
                                     briefDescription(),
                                     DocOptions()
                                     .setIndexWords(inheritedFrom==nullptr)
                                     .setSingleLine(true))
                };
    if (!ast->empty())
    {
      ol.startMemberDescription(anchor(),inheritId);
      ol.writeDoc(ast.get(),getOuterScope()?getOuterScope():d,this);
      if (detailsVisible) // add More.. link only when both brief and details are visible
      {
        if (!isAnonymous()) // hide anonymous stuff
        {
          ol.pushGeneratorState();
          ol.disableAllBut(OutputType::Html);
          ol.docify(" ");
          ol.popGeneratorState();
        }
      }
      // for RTF we need to add an extra empty paragraph
      ol.pushGeneratorState();
      ol.disableAllBut(OutputType::RTF);
      ol.startParagraph();
      ol.endParagraph();
      ol.popGeneratorState();
      ol.endMemberDescription();
    }
  }
 
  ol.endMemberDeclaration(anchor(),inheritId);
 
  warnIfUndocumented();
  //printf("< %s MemberDefImpl::writeDeclaration() inGroup=%d\n",qPrint(qualifiedName()),inGroup);
}

References _isAnonymousBitField(), _writeTemplatePrefix(), OutputList::addLabel(), Definition::anchor(), anchor(), OutputGenerator::AnonymousEnd, DString::append(), argsString(), ASSERT, briefDescription(), DefinitionMixin< MemberDefMutable >::briefFile(), DefinitionMixin< MemberDefMutable >::briefLine(), combineArgsAndException(), Config_getBool, createDocParser(), OutputList::disable(), OutputList::disableAllBut(), Definition::displayName(), Docbook, OutputList::docify(), ArgumentList::empty(), DString::empty(), OutputList::endAnonTypeScope(), OutputList::endDoxyAnchor(), OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberItem(), OutputList::endMemberTemplateParams(), OutputList::endParagraph(), OutputList::endTypewriter(), err, excpString(), getAnonymousEnumType(), DefinitionMixin< MemberDefMutable >::getBodyDef(), getClass(), getClassDef(), getClassDefOfAnonymousType(), getFileDef(), getGroupDef(), DefinitionMixin< MemberDefMutable >::getLanguage(), getLanguageSpecificSeparator(), getNamespaceDef(), DefinitionMixin< MemberDefMutable >::getOuterScope(), Definition::getOutputFileBase(), getOutputFileBase(), Definition::getReference(), hasDetailedDescription(), hasDocumentation(), hasOneLineInitializer(), ArgumentList::hasParameters(), Html, OutputList::insertMemberAlign(), isAddable(), DefinitionMixin< MemberDefMutable >::isAnonymous(), isDefine(), isDocumentedFriendClass(), MemberDef::isEnumStruct(), isEvent(), isFinal(), isGettable(), isImplementation(), isInitonly(), isObjCMethod(), isObjCProperty(), isOverride(), isPrivateGettable(), isPrivateSettable(), isProperty(), isProtectedGettable(), isProtectedSettable(), isRaisable(), isReference(), isRemovable(), isSettable(), isStatic(), MemberDef::isStrong(), isTypeAlias(), isTypedef(), Latex, DString::left(), reg::Match::length(), linkifyText(), m_bitfields, m_defArgList, m_initializer, m_mtype, m_prot, m_tArgList, m_type, m_virt, Man, DString::mid(), Definition::name(), DefinitionMixin< MemberDefMutable >::name(), OutputGenerator::Normal, OutputList::popGeneratorState(), reg::Match::position(), DString::prepend(), protection(), protectionLevelVisible(), OutputList::pushGeneratorState(), removeAnonymousScopes(), RTF, reg::search(), LinkifyTextOptions::setFileScope(), LinkifyTextOptions::setScope(), LinkifyTextOptions::setSelf(), DString::simplifyWhiteSpace(), OutputList::startAnonTypeScope(), OutputList::startDoxyAnchor(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberItem(), OutputList::startMemberTemplateParams(), OutputList::startParagraph(), OutputList::startTypewriter(), DString::str(), DString::stripPrefix(), substitute(), OutputGenerator::Templated, validatingParseDoc(), warnIfUndocumented(), ClassDef::writeDeclaration(), OutputList::writeDoc(), OutputList::writeLatexSpacing(), writeLink(), OutputList::writeNonBreakableSpace(), OutputList::writeObjectLink(), and OutputList::writeString().

◆ writeDocumentation()

void MemberDefImpl::writeDocumentation	(	const MemberList *	ml,
		int	memCount,
		int	memTotal,
		OutputList &	ol,
		const DString &	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 3480 of file memberdef.cpp.

{
  // if this member is in a group find the real scope name.
  bool hasParameterList = false;
 
  //printf("MemberDefImpl::writeDocumentation(): name='%s' hasDocs='%d' containerType=%d inGroup=%d sectionLinkable=%d\n",
  //    qPrint(name()),hasDocs,container->definitionType(),inGroup,hasDetailedDescription());
 
  //if ( !hasDocs ) return;
  //if (isEnumValue() && !showEnumValues) return;
 
  SrcLangExt lang = getLanguage();
  //printf("member=%s lang=%d\n",qPrint(name()),lang);
  bool optVhdl = lang==SrcLangExt::VHDL;
  DString sep = getLanguageSpecificSeparator(lang,true);
 
  DString scopeName = scName;
  DString memAnchor = anchor();
  DString ciname = container->displayName();
  const Definition *scopedContainer = container; // see bug 753608
  if (container->definitionType()==TypeGroup)
  {
    if (getClassDef())          { scopeName=getClassDef()->displayName();     scopedContainer=getClassDef(); }
    else if (getNamespaceDef()) { scopeName=getNamespaceDef()->displayName(); scopedContainer=getNamespaceDef(); }
    else if (getFileDef())      { scopeName=getFileDef()->displayName();      scopedContainer=getFileDef(); }
    ciname = (toGroupDef(container))->groupTitle();
  }
  else if (container->definitionType()==TypeFile && getNamespaceDef() && getNamespaceDef()->isLinkable())
  { // member is in a namespace, but is written as part of the file documentation
    // as well, so we need to make sure its anchor is unique (it is not really used).
    memAnchor.prepend("file_");
  }
 
  DString cname   = container->name();
  DString cfname  = getOutputFileBase();
 
  // get member name
  DString doxyName=name();
  // prepend scope if there is any. TODO: make this optional for C only docs
  if (!scopeName.empty())
  {
    doxyName.prepend(scopeName+sep);
  }
  DString doxyArgs=argsString();
 
  DString ldef = definition();
  DString title = name();
 
  //printf("member '%s' def='%s'\n",qPrint(name()),qPrint(ldef));
  if (isEnumerate())
  {
    if (title.at(0)=='@')
    {
      ldef = title = "anonymous enum";
      if (isSliceLocal())
      {
        ldef.prepend("local ");
      }
      if (lang==SrcLangExt::Cpp)
      {
        if (isEnumStruct()) ldef.append(" struct");
        else if (isStrong()) ldef.append(" class");
      }
      if (!m_enumBaseType.empty())
      {
        ldef+=" : "+m_enumBaseType;
      }
    }
    else
    {
      if (lang==SrcLangExt::Cpp)
      {
        if (isEnumStruct()) ldef.prepend("struct ");
        else if (isStrong()) ldef.prepend("class ");
      }
      ldef.prepend("enum ");
      if (isSliceLocal())
      {
        ldef.prepend("local ");
      }
    }
  }
  else if (isEnumValue())
  {
    if (ldef.at(0)=='@')
    {
      ldef=ldef.mid(2);
    }
  }
  else if (isFunction() && !isObjCMethod())
  {
    title += "()";
  }
  if (lang == SrcLangExt::Slice)
  {
    // Remove the container scope from the member name.
    DString prefix = scName + sep;
    if (size_t pos = ldef.rfind(prefix); pos != DString::npos)
    {
      ldef.remove(pos, prefix.length());
    }
  }
  ldef.stripPrefix("constexpr ");
  ldef.stripPrefix("consteval ");
  ldef.stripPrefix("constinit ");
  ldef.stripPrefix("static ");
 
  //----------------------------------------
 
  ol.pushGeneratorState();
 
  bool htmlEndLabelTable=false;
  StringVector sl = getLabels(scopedContainer);
 
  static const reg::Ex r(R"(@\d+)");
  reg::Match match;
  std::string sdef = ldef.str();
  LinkifyTextOptions options;
  options.setScope(scopedContainer).setFileScope(getBodyDef()).setSelf(this);
  if ((isVariable() || isTypedef()) && reg::search(sdef,match,r))
  {
    // find enum type and insert it in the definition
    bool found=false;
    for (const auto &vmd : *ml)
    {
      if (vmd->isEnumerate() && match.str()==vmd->name())
      {
        ol.startDoxyAnchor(cfname, cname, memAnchor, doxyName, doxyArgs);
        ol.startMemberDoc(ciname,name(),memAnchor,name(),memCount,memTotal,showInline);
        ol.addLabel(cfname, memAnchor);
        DString prefix = match.prefix().str();
        DString suffix = match.suffix().str();
        linkifyText(TextGeneratorOLImpl(ol),prefix,options);
        vmd->writeEnumDeclaration(ol,getClassDef(),getNamespaceDef(),getFileDef(),getGroupDef(),getModuleDef());
        linkifyText(TextGeneratorOLImpl(ol),suffix,options);
 
        found=true;
        break;
      }
    }
    if (!found) // anonymous compound
    {
      const ClassDef *annoClassDef=getClassDefOfAnonymousType();
      DString typeName;
      if (annoClassDef) typeName=annoClassDef->compoundTypeString();
      ol.startDoxyAnchor(cfname, cname, memAnchor, doxyName, doxyArgs);
      ol.startMemberDoc(ciname,name(),memAnchor,title,memCount,memTotal,showInline);
      ol.addLabel(cfname, memAnchor);
      // search for the last anonymous compound name in the definition
 
      ol.startMemberDocName(isObjCMethod());
      if (reg::search(sdef,match,reAnonymous))
      {
        static const reg::Ex ar(R"([\w@:]*@\d+[\w@:]*)");
        reg::Match amatch;
        reg::search(sdef,amatch,ar);
        DString prefix = amatch.prefix().str();
        DString suffix = removeAnonymousScopes(amatch.suffix().str());
        //printf("writeDocumentation(): anonymous compound in definition: sdef='%s' prefix='%s' suffix='%s' annoClassDef=%p\n",
        //    qPrint(sdef), qPrint(prefix),qPrint(suffix),(void*)annoClassDef);
        const MemberDef *amd = getAnonymousEnumType();
        if (annoClassDef && amd==nullptr)
        {
          ol.docify(prefix);
          DString annTypeName = annoClassDef->displayName(true);
          if (suffix.empty())
          {
            suffix="::"+localName();
          }
          ol.writeObjectLink(annoClassDef->getReference(),annoClassDef->getOutputFileBase(),
              annoClassDef->anchor(),annTypeName);
          linkifyText(TextGeneratorOLImpl(ol),suffix,options);
        }
        else if (amd) // type is an anonymous enum
        {
          DString typePlaceholder = " { ... } ";
          if (lang==SrcLangExt::Cpp)
          {
            if (amd->isEnumStruct()) typePlaceholder.prepend(" struct");
            else if (amd->isStrong()) typePlaceholder.prepend(" class");
          }
          ol.writeObjectLink(amd->getReference(),amd->getOutputFileBase(),amd->anchor(),prefix+typePlaceholder+suffix);
        }
        else
        {
          prefix = match.prefix().str();
          suffix = removeAnonymousScopes(match.suffix().str());
          ol.docify(prefix);
          ol.docify(" ");
          if (getNamespaceDef()) ol.docify(getNamespaceDef()->displayName());
          //ol.docify(" { ... } ");
          linkifyText(TextGeneratorOLImpl(ol),suffix,options);
        }
      }
      else
      {
        linkifyText(TextGeneratorOLImpl(ol),ldef,options);
      }
    }
  }
  else // not an enum value or anonymous compound
  {
    ol.startDoxyAnchor(cfname, cname, memAnchor, doxyName, doxyArgs);
    ol.startMemberDoc(ciname,name(),memAnchor,title,memCount,memTotal,showInline);
    ol.addLabel(cfname, memAnchor);
 
    if (!m_metaData.empty() && getLanguage()==SrcLangExt::Slice)
    {
      ol.startMemberDocPrefixItem();
      ol.docify(m_metaData);
      ol.endMemberDocPrefixItem();
    }
 
    const ClassDef *cd=getClassDef();
    const NamespaceDef *nd=getNamespaceDef();
    if (!m_defTmpArgLists.empty() && lang==SrcLangExt::Cpp)
      // definition has explicit template parameter declarations
    {
      for (const ArgumentList &tal : m_defTmpArgLists)
      {
        if (!tal.empty())
        {
          ol.startMemberDocPrefixItem();
          _writeTemplatePrefix(ol,scopedContainer,tal);
          ol.endMemberDocPrefixItem();
        }
      }
    }
    else // definition gets it template parameters from its class
      // (since no definition was found)
    {
      if (cd && lang==SrcLangExt::Cpp && !isTemplateSpecialization())
      {
        for (const ArgumentList &tal : cd->getTemplateParameterLists())
        {
          if (!tal.empty())
          {
            ol.startMemberDocPrefixItem();
            _writeTemplatePrefix(ol,scopedContainer,tal,false);
            ol.endMemberDocPrefixItem();
          }
        }
      }
      if (m_tArgList.hasParameters() && lang==SrcLangExt::Cpp) // function template prefix
      {
        ol.startMemberDocPrefixItem();
        _writeTemplatePrefix(ol,scopedContainer,m_tArgList);
        ol.endMemberDocPrefixItem();
      }
    }
 
    if (!sl.empty())
    {
      ol.pushGeneratorState();
      ol.disableAll();
      ol.enable(OutputType::Html);
      ol.writeString("<table class=\"mlabels\">\n");
      ol.writeString("  <tr>\n");
      ol.writeString("  <td class=\"mlabels-left\">\n");
      ol.popGeneratorState();
      htmlEndLabelTable=true;
    }
 
    ol.startMemberDocName(isObjCMethod());
    if (cd && cd->isObjectiveC())
    {
      // strip scope name
      if (size_t ep = ldef.find("::"); ep!=DString::npos)
      {
        if (size_t sp=ldef.rfind(' ',ep); sp!=DString::npos)
        {
          ldef=ldef.left(sp+1)+ldef.mid(ep+2);
        } else {
          ldef=ldef.mid(ep+2);
        }
      }
      // strip keywords
      if (size_t dp = ldef.find(':'); dp!=DString::npos)
      {
        ldef=ldef.left(dp+1);
      }
      int dl=static_cast<int>(ldef.length());
      //printf("start >%s<\n",qPrint(ldef));
      int i=dl-1;
      while (i>=0 && (isId(ldef.at(i)) || ldef.at(i)==':')) i--;
      while (i>=0 && isspace(static_cast<uint8_t>(ldef.at(i)))) i--;
      if (i>0)
      {
        // insert branches around the type
        ldef="("+ldef.left(i+1)+")"+ldef.mid(i+1);
      }
      //printf("end   >%s< i=%d\n",qPrint(ldef),i);
      if (isStatic()) ldef.prepend("+ "); else ldef.prepend("- ");
    }
 
    if (optVhdl)
    {
      hasParameterList=VhdlDocGen::writeVHDLTypeDocumentation(this,scopedContainer,ol);
    }
    else if (lang==SrcLangExt::Slice)
    {
      // Eliminate the self-reference.
      size_t pos = ldef.rfind(' ');
      if (pos==DString::npos) pos=0;
      if (pos>0)
      {
        linkifyText(TextGeneratorOLImpl(ol),ldef.left(pos),options);
      }
      ol.docify(ldef.mid(pos));
      const Definition *scope = cd;
      if (scope==nullptr) scope = nd;
      hasParameterList=writeDefArgumentList(ol,scope,this);
    }
    else
    {
      linkifyText(TextGeneratorOLImpl(ol),substitute(ldef,"::",sep),options);
      const Definition *scope = cd;
      if (scope==nullptr) scope = nd;
      hasParameterList=writeDefArgumentList(ol,scope,this);
    }
 
    if (hasOneLineInitializer()) // add initializer
    {
      if (isTypeAlias())
      {
        ol.docify(" = ");
        DString init = m_initializer.simplifyWhiteSpace();
        linkifyText(TextGeneratorOLImpl(ol),init,options);
      }
      else if (!isDefine())
      {
        ol.docify(" ");
        DString init = m_initializer.simplifyWhiteSpace();
        linkifyText(TextGeneratorOLImpl(ol),init,options);
      }
      else
      {
        ol.writeNonBreakableSpace(3);
        linkifyText(TextGeneratorOLImpl(ol),m_initializer,options);
      }
    }
    if (!excpString().empty()) // add exception list
    {
      writeExceptionList(ol,cd,this);
      hasParameterList=true; // call endParameterList below
    }
  }
 
  ol.pushGeneratorState();
  ol.disable(OutputType::Html);
  if (!sl.empty())
  {
    ol.startLabels();
    size_t count=0;
    for (const auto &s : sl)
    {
      count++;
      ol.writeLabel(s,count==sl.size());
    }
    ol.endLabels();
  }
  ol.popGeneratorState();
 
  if (hasParameterList)
  {
    ol.endParameterList();
    ol.endMemberDoc(true);
  }
  else
  {
    ol.endMemberDocName();
    ol.endMemberDoc(false);
  }
 
  // for HTML write the labels here
  ol.pushGeneratorState();
  ol.disableAll();
  ol.enable(OutputType::Html);
  if (htmlEndLabelTable)
  {
    ol.writeString("  </td>\n");
    ol.writeString("  <td class=\"mlabels-right\">\n");
    ol.startLabels();
    size_t count=0;
    for (const auto &s : sl)
    {
      count++;
      ol.writeLabel(s,count==sl.size());
    }
    ol.endLabels();
    ol.writeString("  </td>\n");
    ol.writeString("  </tr>\n");
    ol.writeString("</table>\n");
  }
  ol.writeString("</div>");
  ol.popGeneratorState();
 
 
  ol.endDoxyAnchor(cfname,memAnchor);
  ol.startIndent();
 
  _writeGroupInclude(ol,inGroup);
 
  /* write multi-line initializer (if any) */
  if (hasMultiLineInitializer()) _writeMultiLineInitializer(ol,scopeName);
 
  /* write brief description */
  DString brief = briefDescription();
  if (!brief.empty() &&
      (Config_getBool(REPEAT_BRIEF) ||
       !Config_getBool(BRIEF_MEMBER_DESC)
      )
     )
  {
    ol.startParagraph();
    ol.generateDoc(briefFile(),
                   briefLine(),
                   scopedContainer,
                   this,
                   brief,
                   DocOptions()
                   .setSingleLine(true));
    ol.endParagraph();
  }
 
  /* write detailed description */
  DString detailed = documentation();
  if (!detailed.empty() ||
      !inbodyDocumentation().empty())
  {
    // write vhdl inline code with or without option INLINE_SOURCE
    if (optVhdl && VhdlDocGen::isMisc(this))
    {
      VhdlDocGen::writeSource(this,ol,cname);
      return;
    }
    else
    {
      ol.generateDoc(docFile(),
                     docLine(),
                     scopedContainer,
                     this,
                     detailed+"\n",
                     DocOptions()
                     .setIndexWords(true));
    }
 
    if (!inbodyDocumentation().empty())
    {
      ol.generateDoc(inbodyFile(),
                     inbodyLine(),
                     scopedContainer,
                     this,
                     inbodyDocumentation()+"\n",
                     DocOptions()
                     .setIndexWords(true));
    }
  }
  else if (!brief.empty() && (Config_getBool(REPEAT_BRIEF) || !Config_getBool(BRIEF_MEMBER_DESC)))
  {
    if (!inbodyDocumentation().empty())
    {
      ol.generateDoc(inbodyFile(),
                     inbodyLine(),
                     scopedContainer,
                     this,
                     inbodyDocumentation()+"\n",
                     DocOptions()
                     .setIndexWords(true));
    }
  }
 
 
  //printf("***** defArgList=%p name=%s docs=%s hasDocs=%d\n",
  //     defArgList,
  //     defArgList?defArgList->hasDocumentation():-1);
  const ArgumentList &docArgList = m_templateMaster ?
                                   m_templateMaster->argumentList() :
                                   m_defArgList;
  ol.generateDoc(docFile(),
                 docLine(),
                 scopedContainer,
                 this,         // memberDef
                 inlineArgListToDoc(docArgList),    // docStr
                 DocOptions()
                 .setIndexWords(true));
 
  const ArgumentList &docTemplateArgList = m_templateMaster ?
                                   m_templateMaster->templateArguments() :
                                   m_tArgList;
  ol.generateDoc(docFile(),
                 docLine(),
                 scopedContainer,
                 this,         // memberDef
                 inlineTemplateArgListToDoc(docTemplateArgList),    // docStr
                 DocOptions()
                 .setIndexWords(true));
 
  _writeEnumValues(ol,scopedContainer,cfname,ciname,cname);
  _writeReimplements(ol);
  _writeReimplementedBy(ol);
  _writeCategoryRelation(ol);
  _writeExamples(ol);
  _writeTypeConstraints(ol);
  DString scopeStr = getScopeString();
  writeSourceDef(ol);
  writeInlineCode(ol,scopeStr);
  if (hasReferencesRelation()) writeSourceRefs(ol,scopeStr);
  if (hasReferencedByRelation()) writeSourceReffedBy(ol,scopeStr);
  _writeCallGraph(ol);
  _writeCallerGraph(ol);
  if (hasRequirementRefs()) writeRequirementRefs(ol);
 
  ol.endIndent();
 
  // enable LaTeX again
  //if (Config_getBool(EXTRACT_ALL) && !hasDocs) ol.enable(OutputType::Latex);
  ol.popGeneratorState();
 
  warnIfUndocumentedParams();
}

◆ 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 4812 of file memberdef.cpp.

{
  int enumMemCount=0;
 
  uint32_t numVisibleEnumValues=0;
  for (const auto &fmd : m_enumFields)
  {
    if (fmd->isBriefSectionVisible()) numVisibleEnumValues++;
  }
  if (numVisibleEnumValues==0 && !isBriefSectionVisible())
  {
    return;
  }
 
  DString n = name();
  if (size_t i=n.rfind("::"); i!=DString::npos) n=n.mid(i+2); // strip scope (TODO: is this needed?)
  if (n[0]!='@') // not an anonymous enum
  {
    if (isLinkableInProject() || hasDocumentedEnumValues())
    {
      //_writeTagData(compoundType);
      writeLink(typeDecl,cd,nd,fd,gd,mod);
    }
    else
    {
      typeDecl.startBold();
      typeDecl.docify(n);
      typeDecl.endBold();
    }
    typeDecl.writeChar(' ');
  }
  if (!m_enumBaseType.empty())
  {
    typeDecl.writeChar(':');
    typeDecl.writeChar(' ');
    typeDecl.docify(m_enumBaseType);
    typeDecl.writeChar(' ');
  }
 
  uint32_t enumValuesPerLine = static_cast<uint32_t>(Config_getInt(ENUM_VALUES_PER_LINE));
  if (numVisibleEnumValues>0 && enumValuesPerLine>0)
  {
    typeDecl.docify("{ ");
 
    auto it = m_enumFields.begin();
    if (it!=m_enumFields.end())
    {
      const MemberDef *fmd=*it;
      bool fmdVisible = fmd->isBriefSectionVisible();
      bool first=true;
      while (fmd)
      {
        if (fmdVisible)
        {
          if (!first)
          {
            typeDecl.writeString(", ");
          }
          /* in html we start a new line after a number of items */
          if (numVisibleEnumValues>enumValuesPerLine
              && (enumMemCount%enumValuesPerLine)==0
             )
          {
            typeDecl.pushGeneratorState();
            typeDecl.disableAllBut(OutputType::Html);
            typeDecl.enable(OutputType::Latex);
            typeDecl.enable(OutputType::Docbook);
            typeDecl.lineBreak();
            typeDecl.disable(OutputType::Latex);
            typeDecl.disable(OutputType::Docbook);
            typeDecl.writeString("&#160;&#160;");
            typeDecl.popGeneratorState();
          }
 
          if (fmd->hasDocumentation()) // enum value has docs
          {
            fmd->writeLink(typeDecl,cd,nd,fd,gd,mod);
          }
          else // no docs for this enum value
          {
            typeDecl.startBold();
            typeDecl.docify(fmd->name());
            typeDecl.endBold();
          }
          if (fmd->hasOneLineInitializer()) // enum value has initializer
          {
            //typeDecl.writeString(" = ");
            typeDecl.writeString(" ");
            typeDecl.parseText(fmd->initializer());
          }
          first=false;
        }
 
        bool prevVisible = fmdVisible;
        ++it;
        if (it!=m_enumFields.end())
        {
          fmd=*it;
        }
        else
        {
          fmd=nullptr;
        }
        if (prevVisible)
        {
          typeDecl.disable(OutputType::Man);
          typeDecl.writeString("\n"); // to prevent too long lines in LaTeX
          typeDecl.enable(OutputType::Man);
          enumMemCount++;
        }
      }
      if (numVisibleEnumValues>enumValuesPerLine)
      {
        typeDecl.pushGeneratorState();
        typeDecl.disableAllBut(OutputType::Html);
        typeDecl.lineBreak();
        typeDecl.popGeneratorState();
      }
    }
    typeDecl.docify(" }");
  }
}

References Config_getInt, OutputList::disable(), OutputList::disableAllBut(), Docbook, OutputList::docify(), DString::empty(), OutputList::enable(), OutputList::endBold(), Definition::hasDocumentation(), hasDocumentedEnumValues(), MemberDef::hasOneLineInitializer(), Html, MemberDef::initializer(), MemberDef::isBriefSectionVisible(), isBriefSectionVisible(), isLinkableInProject(), Latex, OutputList::lineBreak(), m_enumBaseType, m_enumFields, Man, DString::mid(), Definition::name(), DefinitionMixin< MemberDefMutable >::name(), DString::npos, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), DString::rfind(), 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 1970 of file memberdef.cpp.

{
  SrcLangExt lang = getLanguage();
  bool hideScopeNames     = Config_getBool(HIDE_SCOPE_NAMES);
  DString sep = getLanguageSpecificSeparator(lang,true);
  DString n = name();
  const ClassDef *classDef = getClassDef();
  const NamespaceDef *nspace = getNamespaceDef();
  if (!hideScopeNames)
  {
    if (m_enumScope && m_livesInsideEnum && getGroupDef()!=nullptr)
    {
      n.prepend(m_enumScope->displayName()+sep);
    }
    if (classDef && (gd || mod) && !isRelated())
    {
      n.prepend(classDef->displayName()+sep);
    }
    else if (nspace && (gd || fd || mod))
    {
      n.prepend(nspace->displayName()+sep);
    }
  }
 
  if (isObjCMethod())
  {
    if (isStatic()) ol.docify("+ "); else ol.docify("- ");
  }
  if (!onlyText && (isLinkable() || hasDetailedDescription())) // write link
  {
    if (m_mtype==MemberType::EnumValue && getGroupDef()==nullptr &&          // enum value is not grouped
        getEnumScope() && getEnumScope()->getGroupDef()) // but its container is
    {
      const GroupDef *enumValGroup = getEnumScope()->getGroupDef();
      ol.writeObjectLink(enumValGroup->getReference(),
                         enumValGroup->getOutputFileBase(),
                         anchor(),n);
    }
    else
    {
      ol.writeObjectLink(getReference(),getOutputFileBase(),anchor(),n);
    }
  }
  else // write only text
  {
    ol.startBold();
    ol.docify(n);
    ol.endBold();
  }
}

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

Referenced by writeDeclaration(), and writeEnumDeclaration().

◆ writeMemberDocSimple()

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

overridevirtual

Implements MemberDefMutable.

Definition at line 4035 of file memberdef.cpp.

{
  Definition *scope  = getOuterScope();
  DString doxyName  = name();
  DString doxyArgs  = argsString();
  DString memAnchor = anchor();
  DString cfname    = getOutputFileBase();
  DString cname;
  if (scope) cname   = scope->name();
  if (doxyName.at(0)=='@')
  {
    doxyName="__unnamed__";
  }
 
  LinkifyTextOptions options;
  options.setScope(scope).setFileScope(getBodyDef()).setSelf(this);
 
  if (container && container->definitionType()==Definition::TypeClass &&
      !(toClassDef(container))->isJavaEnum())
  {
    ol.startInlineMemberType();
    ol.startDoxyAnchor(cfname,cname,memAnchor,doxyName,doxyArgs);
    ol.addLabel(cfname,memAnchor);
 
    bool written=false;
    const ClassDef *annoClassDef=getClassDefOfAnonymousType();
    if (annoClassDef)
    {
      static const reg::Ex ar(R"([\w@:]*@\d+[\w@:]*)"); // anonymous type marker(s) including scope
      reg::Match amatch;
      std::string stype = m_type.str();
      if (reg::search(stype,amatch,ar))
      {
        size_t ai = amatch.position();
        size_t al = amatch.length();
        ol.writeObjectLink(annoClassDef->getReference(),annoClassDef->getOutputFileBase(),
                           annoClassDef->anchor(),m_type.left(ai)+m_type.mid(ai+al));
        written=true;
      }
    }
    if (!written)
    {
      DString ts;
      if (isFunctionPtr())
      {
        ts = m_type + m_args;
      }
      else
      {
        ts = fieldType();
      }
      linkifyText(TextGeneratorOLImpl(ol),ts,options);
    }
    ol.endDoxyAnchor(cfname,memAnchor);
    ol.endInlineMemberType();
  }
 
  ol.startInlineMemberName();
  ol.docify(doxyName);
  if (isVariable() && !argsString().empty() && !isObjCMethod() && !isFunctionPtr())
  {
    linkifyText(TextGeneratorOLImpl(ol),argsString(),LinkifyTextOptions(options).setArgumentList(&m_defArgList));
  }
  if (!m_bitfields.empty()) // add bitfields
  {
    linkifyText(TextGeneratorOLImpl(ol),m_bitfields,options);
  }
  if (hasOneLineInitializer() && !isDefine())
  {
    ol.writeString(" ");
    linkifyText(TextGeneratorOLImpl(ol),m_initializer.simplifyWhiteSpace(),options);
  }
  ol.endInlineMemberName();
 
  ol.startInlineMemberDoc();
 
  DString brief           = briefDescription();
  DString detailed        = documentation();
 
  /* write brief description */
  if (!brief.empty())
  {
    ol.generateDoc(briefFile(),
                   briefLine(),
                   getOuterScope()?getOuterScope():container,this,
                   brief,
                   DocOptions()
                   .setSingleLine(true));
  }
 
  /* write detailed description */
  if (!detailed.empty())
  {
    if (!brief.empty())
    {
      ol.disable(OutputType::Html);
      ol.lineBreak();
      ol.enable(OutputType::Html);
    }
    ol.generateDoc(docFile(),
                   docLine(),
                   getOuterScope()?getOuterScope():container,this,
                   detailed+"\n",
                   DocOptions());
  }
 
  ol.endInlineMemberDoc();
}

References OutputList::addLabel(), Definition::anchor(), anchor(), argsString(), DString::at(), briefDescription(), DefinitionMixin< MemberDefMutable >::briefFile(), DefinitionMixin< MemberDefMutable >::briefLine(), Definition::definitionType(), OutputList::disable(), DefinitionMixin< MemberDefMutable >::docFile(), OutputList::docify(), DefinitionMixin< MemberDefMutable >::docLine(), documentation(), DString::empty(), OutputList::enable(), OutputList::endDoxyAnchor(), OutputList::endInlineMemberDoc(), OutputList::endInlineMemberName(), OutputList::endInlineMemberType(), fieldType(), OutputList::generateDoc(), DefinitionMixin< MemberDefMutable >::getBodyDef(), getClassDefOfAnonymousType(), DefinitionMixin< MemberDefMutable >::getOuterScope(), Definition::getOutputFileBase(), getOutputFileBase(), Definition::getReference(), hasOneLineInitializer(), Html, isDefine(), isFunctionPtr(), isObjCMethod(), isVariable(), DString::left(), reg::Match::length(), OutputList::lineBreak(), linkifyText(), m_args, m_bitfields, m_defArgList, m_initializer, m_type, DString::mid(), Definition::name(), DefinitionMixin< MemberDefMutable >::name(), reg::Match::position(), reg::search(), LinkifyTextOptions::setFileScope(), LinkifyTextOptions::setScope(), LinkifyTextOptions::setSelf(), DString::simplifyWhiteSpace(), OutputList::startDoxyAnchor(), OutputList::startInlineMemberDoc(), OutputList::startInlineMemberName(), OutputList::startInlineMemberType(), DString::str(), toClassDef(), Definition::TypeClass, OutputList::writeObjectLink(), and OutputList::writeString().

◆ writeTagFile()

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

overridevirtual

Implements MemberDefMutable.

Definition at line 4655 of file memberdef.cpp.

{
  if (!isLinkableInProject()) return;
  if (!showNamespaceMembers && getNamespaceDef()) return;
  tagFile << "    <member kind=\"";
  if (m_mtype == MemberType::Enumeration)
  {
    tagFile << "enumeration";
  }
  else
  {
    tagFile << to_string_lower(m_mtype);
  }
  if (m_prot!=Protection::Public)
  {
    tagFile << "\" protection=\"";
    if (m_prot==Protection::Protected)    tagFile << "protected";
    else if (m_prot==Protection::Package) tagFile << "package";
    else /* Private */                          tagFile << "private";
  }
  if (m_virt!=Specifier::Normal)
  {
    tagFile << "\" virtualness=\"";
    if (m_virt==Specifier::Virtual) tagFile << "virtual";
    else /* Pure */                       tagFile << "pure";
  }
  if (isStatic())
  {
    tagFile << "\" static=\"yes";
  }
  tagFile << "\">\n";
  if (typeString()!=DString("@"))
  {
    tagFile << "      <type>" << convertToXML(typeString()) << "</type>\n";
  }
  DString fn = getOutputFileBase();
  addHtmlExtensionIfMissing(fn);
  tagFile << "      <name>" << convertToXML(useQualifiedName ? qualifiedName() : name()) << "</name>\n";
  tagFile << "      <anchorfile>" << convertToXML(fn) << "</anchorfile>\n";
  tagFile << "      <anchor>" << convertToXML(anchor()) << "</anchor>\n";
  DString idStr = id();
  if (!idStr.empty())
  {
    tagFile << "      <clangid>" << convertToXML(idStr) << "</clangid>\n";
  }
  tagFile << "      <arglist>" << convertToXML(argsString()) << "</arglist>\n";
  if (isStrong())
  {
    for (const auto &fmd : m_enumFields)
    {
      if (!fmd->isReference())
      {
        tagFile << "      <enumvalue file=\"" << convertToXML(fn);
        tagFile << "\" anchor=\"" << convertToXML(fmd->anchor());
        idStr = fmd->id();
        if (!idStr.empty())
        {
          tagFile << "\" clangid=\"" << convertToXML(idStr);
        }
        tagFile  << "\">" << convertToXML(fmd->name()) << "</enumvalue>\n";
      }
    }
  }
  writeDocAnchorsToTagFile(tagFile);
  tagFile << "    </member>\n";
}

References addHtmlExtensionIfMissing(), anchor(), argsString(), convertToXML(), DString::empty(), getNamespaceDef(), getOutputFileBase(), DefinitionMixin< MemberDefMutable >::id(), isLinkableInProject(), isStatic(), isStrong(), m_enumFields, m_mtype, m_prot, m_virt, DefinitionMixin< MemberDefMutable >::name(), qualifiedName(), typeString(), and DefinitionMixin< MemberDefMutable >::writeDocAnchorsToTagFile().

Member Data Documentation

◆ m_anc

DString MemberDefImpl::m_anc

private

Definition at line 427 of file memberdef.cpp.

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

◆ m_annEnumType

const MemberDef* MemberDefImpl::m_annEnumType = nullptr

private

Definition at line 408 of file memberdef.cpp.

Referenced by deepCopy(), getAnonymousEnumType(), init(), and setAnonymousEnumType().

◆ m_annMemberForDecl

const MemberDef* MemberDefImpl::m_annMemberForDecl = nullptr

private

Definition at line 410 of file memberdef.cpp.

Referenced by anonymousMemberForDeclaration(), deepCopy(), init(), and setAnonymousMemberForDeclaration().

◆ m_annMemberForDetails

const MemberDef* MemberDefImpl::m_annMemberForDetails = nullptr

private

Definition at line 411 of file memberdef.cpp.

Referenced by anonymousMemberForDetails(), deepCopy(), init(), and setAnonymousMemberForDetails().

◆ m_anonymousType

const ClassDef* MemberDefImpl::m_anonymousType = nullptr

private

Definition at line 461 of file memberdef.cpp.

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

◆ m_args

DString MemberDefImpl::m_args

private

Definition at line 425 of file memberdef.cpp.

Referenced by argsString(), createTemplateInstanceMember(), deepCopy(), init(), setAnchor(), setArgsString(), and writeMemberDocSimple().

◆ m_bitfields

DString MemberDefImpl::m_bitfields

private

Definition at line 432 of file memberdef.cpp.

Referenced by _isAnonymousBitField(), bitfieldString(), deepCopy(), setBitfields(), writeDeclaration(), and writeMemberDocSimple().

◆ m_cachedResolvedType

DString MemberDefImpl::m_cachedResolvedType

private

Definition at line 479 of file memberdef.cpp.

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

◆ m_cachedTypedefTemplSpec

DString MemberDefImpl::m_cachedTypedefTemplSpec

private

Definition at line 478 of file memberdef.cpp.

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

◆ m_cachedTypedefValue

const ClassDef* MemberDefImpl::m_cachedTypedefValue = nullptr

private

Definition at line 477 of file memberdef.cpp.

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

◆ m_category

ClassDef* MemberDefImpl::m_category = nullptr

private

Definition at line 517 of file memberdef.cpp.

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

◆ m_categoryRelation

const MemberDef* MemberDefImpl::m_categoryRelation = nullptr

private

Definition at line 518 of file memberdef.cpp.

Referenced by _writeCategoryRelation(), categoryRelation(), deepCopy(), and setCategoryRelation().

◆ m_classDef

ClassDef* MemberDefImpl::m_classDef = nullptr

private

Definition at line 401 of file memberdef.cpp.

Referenced by deepCopy(), getClassDef(), getClassDef(), getClassDefMutable(), init(), moveTo(), setEnumClassScope(), and setMemberClass().

◆ m_decl

DString MemberDefImpl::m_decl

private

Definition at line 430 of file memberdef.cpp.

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

◆ m_declArgList

ArgumentList MemberDefImpl::m_declArgList

private

Definition at line 450 of file memberdef.cpp.

Referenced by copyArgumentNames(), declArgumentList(), deepCopy(), init(), invalidateCachedArgumentTypes(), moveDeclArgumentList(), and resolveUnnamedParameters().

◆ m_declColumn

size_t MemberDefImpl::m_declColumn = 1

private

Definition at line 521 of file memberdef.cpp.

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

◆ m_declFileName

DString MemberDefImpl::m_declFileName

private

Definition at line 519 of file memberdef.cpp.

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

◆ m_declLine

int MemberDefImpl::m_declLine = -1

private

Definition at line 520 of file memberdef.cpp.

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

◆ m_def

DString MemberDefImpl::m_def

private

Definition at line 426 of file memberdef.cpp.

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

◆ m_defArgList

ArgumentList MemberDefImpl::m_defArgList

private

Definition at line 449 of file memberdef.cpp.

Referenced by argumentList(), copyArgumentNames(), createTemplateInstanceMember(), deepCopy(), hasDetailedDescription(), hasDocumentation(), hasMultiLineInitializer(), hasOneLineInitializer(), init(), invalidateCachedArgumentTypes(), isBriefSectionVisible(), isDeleted(), moveArgumentList(), resolveUnnamedParameters(), writeDeclaration(), writeDocumentation(), and writeMemberDocSimple().

◆ m_defTmpArgLists

ArgumentLists MemberDefImpl::m_defTmpArgLists

private

Definition at line 456 of file memberdef.cpp.

Referenced by deepCopy(), definitionTemplateParameterLists(), setDefinitionTemplateParameterLists(), and writeDocumentation().

◆ m_detailedDescriptionCachedValue

bool MemberDefImpl::m_detailedDescriptionCachedValue = false

mutableprivate

Definition at line 503 of file memberdef.cpp.

Referenced by deepCopy(), and hasDetailedDescription().

◆ m_docEnumValues

bool MemberDefImpl::m_docEnumValues = false

private

Definition at line 500 of file memberdef.cpp.

Referenced by deepCopy(), hasDocumentation(), hasDocumentedEnumValues(), init(), and setDocumentedEnumValues().

◆ m_docProvider

const MemberDef* MemberDefImpl::m_docProvider = nullptr

private

Definition at line 482 of file memberdef.cpp.

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

◆ m_docsForDefinition

bool MemberDefImpl::m_docsForDefinition = false

private

Definition at line 514 of file memberdef.cpp.

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

◆ m_docTransferDone

bool MemberDefImpl::m_docTransferDone = false

private

Definition at line 441 of file memberdef.cpp.

Referenced by isDocTransferDone(), and setDocTransferDone().

◆ m_enumBaseType

DString MemberDefImpl::m_enumBaseType

private

Definition at line 438 of file memberdef.cpp.

Referenced by deepCopy(), displayDefinition(), enumBaseType(), setEnumBaseType(), writeDocumentation(), and writeEnumDeclaration().

◆ m_enumFields

MemberVector MemberDefImpl::m_enumFields

private

Definition at line 409 of file memberdef.cpp.

Referenced by deepCopy(), enumFieldList(), insertEnumField(), writeEnumDeclaration(), and writeTagFile().

◆ m_enumScope

const MemberDef* MemberDefImpl::m_enumScope = nullptr

private

Definition at line 406 of file memberdef.cpp.

Referenced by anchor(), deepCopy(), getEnumScope(), init(), isStrongEnumValue(), qualifiedName(), setEnumScope(), and writeLink().

◆ m_examples

ExampleList MemberDefImpl::m_examples

private

Definition at line 422 of file memberdef.cpp.

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

◆ m_exception

DString MemberDefImpl::m_exception

private

Definition at line 435 of file memberdef.cpp.

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

◆ m_explExt

bool MemberDefImpl::m_explExt = false

private

Definition at line 511 of file memberdef.cpp.

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

◆ m_explicitInherited

bool MemberDefImpl::m_explicitInherited = false

private

Definition at line 486 of file memberdef.cpp.

Referenced by getLabels(), and setExplicitInherited().

◆ m_explicitOutputFileBase

DString MemberDefImpl::m_explicitOutputFileBase

private

Definition at line 485 of file memberdef.cpp.

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

◆ m_extraTypeChars

DString MemberDefImpl::m_extraTypeChars

private

Definition at line 437 of file memberdef.cpp.

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

◆ m_fileDef

FileDef* MemberDefImpl::m_fileDef = nullptr

private

Definition at line 402 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 455 of file memberdef.cpp.

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

◆ m_group

GroupDef* MemberDefImpl::m_group = nullptr

private

Definition at line 470 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 467 of file memberdef.cpp.

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

◆ m_groupFileName

DString MemberDefImpl::m_groupFileName

private

Definition at line 472 of file memberdef.cpp.

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

◆ m_groupHasDocs

bool MemberDefImpl::m_groupHasDocs = false

private

Definition at line 513 of file memberdef.cpp.

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

◆ m_groupMember

MemberDef* MemberDefImpl::m_groupMember = nullptr

private

Definition at line 474 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 471 of file memberdef.cpp.

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

◆ m_groupStartLine

int MemberDefImpl::m_groupStartLine = 0

private

Definition at line 473 of file memberdef.cpp.

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

◆ m_grpId

int MemberDefImpl::m_grpId = 0

private

Definition at line 468 of file memberdef.cpp.

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

◆ m_hasCallerGraph

bool MemberDefImpl::m_hasCallerGraph = false

private

Definition at line 506 of file memberdef.cpp.

Referenced by _hasVisibleCallerGraph(), deepCopy(), hasCallerGraph(), init(), and overrideCallerGraph().

◆ m_hasCallGraph

bool MemberDefImpl::m_hasCallGraph = false

private

Definition at line 505 of file memberdef.cpp.

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

◆ m_hasDetailedDescriptionCached

bool MemberDefImpl::m_hasDetailedDescriptionCached = false

mutableprivate

Definition at line 502 of file memberdef.cpp.

Referenced by deepCopy(), and hasDetailedDescription().

◆ m_hasDocumentedParams

bool MemberDefImpl::m_hasDocumentedParams = false

mutableprivate

Definition at line 494 of file memberdef.cpp.

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

◆ m_hasDocumentedReturnType

bool MemberDefImpl::m_hasDocumentedReturnType = false

mutableprivate

Definition at line 495 of file memberdef.cpp.

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

◆ m_hasEnumValues

bool MemberDefImpl::m_hasEnumValues = false

private

Definition at line 510 of file memberdef.cpp.

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

◆ m_hasInlineSource

bool MemberDefImpl::m_hasInlineSource = false

private

Definition at line 509 of file memberdef.cpp.

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

◆ m_hasReferencedByRelation

bool MemberDefImpl::m_hasReferencedByRelation = false

private

Definition at line 507 of file memberdef.cpp.

Referenced by deepCopy(), hasReferencedByRelation(), init(), and overrideReferencedByRelation().

◆ m_hasReferencesRelation

bool MemberDefImpl::m_hasReferencesRelation = false

private

Definition at line 508 of file memberdef.cpp.

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

◆ m_implOnly

bool MemberDefImpl::m_implOnly = false

private

Definition at line 492 of file memberdef.cpp.

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

◆ m_incInfo

std::unique_ptr<IncludeInfo> MemberDefImpl::m_incInfo

private

Definition at line 420 of file memberdef.cpp.

Referenced by _writeGroupInclude(), deepCopy(), hasDetailedDescription(), and setIncludeFile().

◆ m_initializer

DString MemberDefImpl::m_initializer

private

Definition at line 436 of file memberdef.cpp.

Referenced by _writeMultiLineInitializer(), deepCopy(), hasMultiLineInitializer(), hasOneLineInitializer(), initializer(), setAnchor(), setInitializer(), writeDeclaration(), writeDocumentation(), and writeMemberDocSimple().

◆ m_initLines

int MemberDefImpl::m_initLines = 0

private

Definition at line 440 of file memberdef.cpp.

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

◆ m_isConstructorCached

uint8_t MemberDefImpl::m_isConstructorCached

private

Definition at line 398 of file memberdef.cpp.

Referenced by _computeIsConstructor(), isConstructor(), MemberDefImpl(), moveTo(), setEnumClassScope(), setFileDef(), and setMemberClass().

◆ m_isDestructorCached

uint8_t MemberDefImpl::m_isDestructorCached

private

Definition at line 399 of file memberdef.cpp.

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

◆ m_isDMember

bool MemberDefImpl::m_isDMember = false

private

Definition at line 496 of file memberdef.cpp.

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

◆ m_isLinkableCached

uint8_t MemberDefImpl::m_isLinkableCached

private

Definition at line 397 of file memberdef.cpp.

Referenced by _computeLinkableInProject(), isLinkableInProject(), makeForeign(), makeRelated(), MemberDefImpl(), moveTo(), setBriefDescription(), setDocumentation(), setEnumClassScope(), setEnumScope(), setFileDef(), setGroupDef(), setHidden(), setInbodyDocumentation(), setMemberClass(), setMemberType(), setProtection(), and setTemplateMaster().

◆ m_isTypedefValCached

bool MemberDefImpl::m_isTypedefValCached = false

private

Definition at line 476 of file memberdef.cpp.

Referenced by cacheTypedefVal(), deepCopy(), init(), invalidateTypedefValCache(), and isTypedefValCached().

◆ m_livesInsideEnum

bool MemberDefImpl::m_livesInsideEnum = false

private

Definition at line 407 of file memberdef.cpp.

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

◆ m_maxInitLines

int MemberDefImpl::m_maxInitLines = 0

private

Definition at line 446 of file memberdef.cpp.

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

◆ m_memberGroup

MemberGroup* MemberDefImpl::m_memberGroup = nullptr

private

Definition at line 469 of file memberdef.cpp.

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

◆ m_memDec

MemberDef* MemberDefImpl::m_memDec = nullptr

private

Definition at line 417 of file memberdef.cpp.

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

◆ m_memDef

MemberDef* MemberDefImpl::m_memDef = nullptr

private

Definition at line 416 of file memberdef.cpp.

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

◆ m_memSpec

TypeSpecifier MemberDefImpl::m_memSpec

private

Definition at line 443 of file memberdef.cpp.

Referenced by deepCopy(), getLabels(), getMemberSpecifiers(), init(), isAbstract(), isAddable(), isAssign(), isAttribute(), isBound(), isConstEval(), isConstExpr(), isConstInit(), isConstrained(), isCopy(), isDefault(), isDelete(), isEnumStruct(), isExplicit(), isFinal(), isGettable(), isInitonly(), isInline(), isMaybeAmbiguous(), isMaybeDefault(), isMaybeVoid(), isMutable(), isNew(), isNoDiscard(), isNoExcept(), isNonAtomic(), isOptional(), isOverride(), isPrivateGettable(), isPrivateSettable(), isProtectedGettable(), isProtectedSettable(), isPublished(), isRaisable(), isReadable(), isReadonly(), isRemovable(), isRequired(), isRetain(), isSealed(), isSettable(), isSliceLocal(), isStrong(), isThreadLocal(), isTransient(), isTypeAlias(), isUNOProperty(), isUnretained(), isWeak(), isWritable(), mergeMemberSpecifiers(), setAnchor(), and setMemberSpecifiers().

◆ m_metaData

DString MemberDefImpl::m_metaData

private

Definition at line 459 of file memberdef.cpp.

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

◆ m_moduleDef

ModuleDef* MemberDefImpl::m_moduleDef = nullptr

private

Definition at line 404 of file memberdef.cpp.

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

◆ m_mtype

MemberType MemberDefImpl::m_mtype = MemberType::Define

private

◆ m_nspace

NamespaceDef* MemberDefImpl::m_nspace = nullptr

private

Definition at line 403 of file memberdef.cpp.

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

◆ m_numberOfFlowKW

int MemberDefImpl::m_numberOfFlowKW = 0

private

Definition at line 522 of file memberdef.cpp.

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

◆ m_prot

Protection MemberDefImpl::m_prot = Protection::Public

private

Definition at line 429 of file memberdef.cpp.

Referenced by _computeLinkableInProject(), createTemplateInstanceMember(), deepCopy(), hasDetailedDescription(), init(), isBriefSectionVisible(), protection(), setProtection(), warnIfUndocumented(), writeDeclaration(), and writeTagFile().

◆ m_proto

bool MemberDefImpl::m_proto = false

private

Definition at line 499 of file memberdef.cpp.

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

◆ m_qualifiers

StringVector MemberDefImpl::m_qualifiers

private

Definition at line 489 of file memberdef.cpp.

Referenced by addQualifiers(), deepCopy(), getLabels(), getQualifiers(), and hasDetailedDescription().

◆ m_read

DString MemberDefImpl::m_read

private

Definition at line 433 of file memberdef.cpp.

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

◆ m_redefineCount

int MemberDefImpl::m_redefineCount = 0

private

Definition at line 523 of file memberdef.cpp.

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

◆ m_redefinedBy

MemberVector MemberDefImpl::m_redefinedBy

private

Definition at line 414 of file memberdef.cpp.

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

◆ m_redefines

MemberDef* MemberDefImpl::m_redefines = nullptr

private

Definition at line 413 of file memberdef.cpp.

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

◆ m_related

Relationship MemberDefImpl::m_related = Relationship::Member

private

Definition at line 497 of file memberdef.cpp.

Referenced by createTemplateInstanceMember(), deepCopy(), init(), isForeign(), isRelated(), makeForeign(), and makeRelated().

◆ m_relatedAlso

ClassDef* MemberDefImpl::m_relatedAlso = nullptr

private

Definition at line 418 of file memberdef.cpp.

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

◆ m_requiresClause

DString MemberDefImpl::m_requiresClause

private

Definition at line 439 of file memberdef.cpp.

Referenced by _writeTemplatePrefix(), deepCopy(), requiresClause(), setAnchor(), and setRequiresClause().

◆ m_sectionMap

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

private

Definition at line 465 of file memberdef.cpp.

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

◆ m_stat

bool MemberDefImpl::m_stat = false

private

Definition at line 498 of file memberdef.cpp.

Referenced by _computeLinkableInProject(), createTemplateInstanceMember(), deepCopy(), init(), and isStatic().

◆ m_tArgList

ArgumentList MemberDefImpl::m_tArgList

private

Definition at line 452 of file memberdef.cpp.

Referenced by deepCopy(), hasDetailedDescription(), hasDocumentation(), init(), setAnchor(), templateArguments(), writeDeclaration(), and writeDocumentation().

◆ m_templateMaster

const MemberDef* MemberDefImpl::m_templateMaster = nullptr

private

Definition at line 454 of file memberdef.cpp.

Referenced by anchor(), briefDescription(), deepCopy(), documentation(), hasDetailedDescription(), hasUserDocumentation(), init(), insertReimplementedBy(), isLinkable(), isReference(), setTemplateMaster(), templateMaster(), and writeDocumentation().

◆ m_tspec

bool MemberDefImpl::m_tspec = false

private

Definition at line 512 of file memberdef.cpp.

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

◆ m_type

DString MemberDefImpl::m_type

private

Definition at line 424 of file memberdef.cpp.

Referenced by createTemplateInstanceMember(), deepCopy(), fieldType(), getDeclType(), init(), isFriendClass(), isFriendToHide(), setType(), typeString(), writeDeclaration(), and writeMemberDocSimple().

◆ m_typeConstraints

ArgumentList MemberDefImpl::m_typeConstraints

private

Definition at line 453 of file memberdef.cpp.

Referenced by _writeTypeConstraints(), deepCopy(), hasDetailedDescription(), setTypeConstraints(), and typeConstraints().

◆ m_userInitLines

int MemberDefImpl::m_userInitLines = 0

private

Definition at line 447 of file memberdef.cpp.

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

◆ m_vhdlSpec

VhdlSpecifier MemberDefImpl::m_vhdlSpec

private

Definition at line 444 of file memberdef.cpp.

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

◆ m_virt

Specifier MemberDefImpl::m_virt = Specifier::Normal

private

Definition at line 428 of file memberdef.cpp.

Referenced by _computeLinkableInProject(), _writeReimplementedBy(), createTemplateInstanceMember(), deepCopy(), hasDetailedDescription(), init(), isBriefSectionVisible(), virtualness(), writeDeclaration(), and writeTagFile().

◆ m_write

DString MemberDefImpl::m_write

private

Definition at line 434 of file memberdef.cpp.

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

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

src/memberdef.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MemberDefImpl()

◆ ~MemberDefImpl()

Member Function Documentation

◆ _computeIsConstructor()

◆ _computeIsDestructor()

◆ _computeLinkableInProject()

◆ _countReimplementedBy()

◆ _hasVisibleCallerGraph()

◆ _hasVisibleCallGraph()

◆ _isAnonymousBitField()

◆ _isReimplements()

◆ _writeCallerGraph()

◆ _writeCallGraph()

◆ _writeCategoryRelation()

◆ _writeEnumValues()

◆ _writeExamples()

◆ _writeGroupInclude()

◆ _writeMultiLineInitializer()

◆ _writeReimplementedBy()

◆ _writeReimplements()

◆ _writeTagData()

◆ _writeTemplatePrefix()

◆ _writeTypeConstraints()

◆ addExample()

◆ addListReference()

◆ addQualifiers()

◆ addRequirementReferences()

◆ anchor()

◆ anonymousMemberForDeclaration()

◆ anonymousMemberForDetails()

◆ argsString()

◆ argumentList()

◆ bitfieldString()

◆ briefDescription()

◆ cacheTypedefVal()

◆ category()

◆ categoryRelation()

◆ codeSymbolType()

◆ copyArgumentNames()

◆ createTemplateInstanceMember()

◆ declaration()

◆ declArgumentList()

◆ deepCopy()

◆ definition()

◆ definitionTemplateParameterLists()

◆ definitionType()

◆ detectUndocumentedParams()

◆ displayDefinition()

◆ displayName()

◆ documentation()

◆ enumBaseType()

◆ enumFieldList()

◆ excpString()

◆ extraTypeChars()

◆ fieldType()

◆ findSectionsInDocumentation()

◆ formalTemplateArguments()

◆ getAnonymousEnumType()

◆ getCachedResolvedTypedef()

◆ getCachedTypedefTemplSpec()

◆ getCachedTypedefVal()

◆ getClassDef() [1/2]

◆ getClassDef() [2/2]

◆ getClassDefMutable()

◆ getClassDefOfAnonymousType()

◆ getDeclColumn()

◆ getDeclFileName()

◆ getDeclLine()

◆ getDeclType()

◆ getEnumScope()

◆ getExamples()

◆ getFileDef() [1/2]

◆ getFileDef() [2/2]

◆ getGroupAlias()