#include <src/definitionimpl.h>

Inheritance diagram for DefinitionMixin< Base >:

Collaboration diagram for DefinitionMixin< Base >:

Public Member Functions
	DefinitionMixin (const DString &defFileName, int defLine, size_t defColumn, const DString &name, const char b=nullptr, const char d=nullptr, bool isSymbol=true)
	DefinitionMixin (const DefinitionMixin &other)
DefinitionMixin &	operator= (const DefinitionMixin &other)
	DefinitionMixin (DefinitionMixin &&)=delete
DefinitionMixin &	operator= (DefinitionMixin &&)=delete
	~DefinitionMixin () override=default
bool	isAlias () const override
const DString &	name () const override
bool	isAnonymous () const override
const DString &	localName () const override
DString	qualifiedName () const override
DString	symbolName () const override
DString	getSourceFileBase () const override
DString	getSourceAnchor () const override
DString	documentation () const override
int	docLine () const override
DString	docFile () const override
DString	briefDescription (bool abbreviate=false) 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	hasDocumentation () const override
bool	hasUserDocumentation () const override
bool	isVisibleInProject () const override
bool	isVisible () const override
bool	isHidden () const override
bool	isArtificial () const override
bool	isExported () const override
DString	getReference () const override
bool	isReference () 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	setDocumentation (const DString &doc, const DString &docFile, int docLine, bool stripWhiteSpace=true) override
void	setBriefDescription (const DString &brief, const DString &briefFile, int briefLine) override
void	setInbodyDocumentation (const DString &doc, const DString &docFile, int docLine) 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	setHidden (bool b) 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
Definition *	toDefinition_ () override
DefinitionMutable *	toDefinitionMutable_ () override
const DefinitionImpl *	toDefinitionImpl_ () const override

Private Attributes
DefinitionImpl	m_impl

Detailed Description

template<class Base>
class DefinitionMixin< Base >

Definition at line 150 of file definitionimpl.h.

Constructor & Destructor Documentation

◆ DefinitionMixin() [1/3]

template<class Base>

DefinitionMixin< Base >::DefinitionMixin	(	const DString &	defFileName,
		int	defLine,
		size_t	defColumn,
		const DString &	name,
		const char *	b = nullptr,
		const char *	d = nullptr,
		bool	isSymbol = true )

inline

Create a new definition

Definition at line 154 of file definitionimpl.h.

157 : m_impl(this,defFileName,defLine,defColumn,name,b,d,isSymbol) {}

DefinitionMixin

Definition definitionimpl.h:151

DefinitionMixin::name

const DString & name() const override

Definition definitionimpl.h:167

DefinitionMixin::m_impl

DefinitionImpl m_impl

Definition definitionimpl.h:310

References m_impl, and name().

Referenced by DefinitionMixin(), DefinitionMixin(), operator=(), and operator=().

◆ DefinitionMixin() [2/3]

template<class Base>

DefinitionMixin< Base >::DefinitionMixin ( const DefinitionMixin< Base > & other )

inline

Definition at line 158 of file definitionimpl.h.

158: Base(other), m_impl(other.m_impl) {}

References DefinitionMixin(), and m_impl.

◆ DefinitionMixin() [3/3]

template<class Base>

DefinitionMixin< Base >::DefinitionMixin ( DefinitionMixin< Base > && )

delete

References DefinitionMixin().

◆ ~DefinitionMixin()

template<class Base>

DefinitionMixin< Base >::~DefinitionMixin ( )

overridedefault

Member Function Documentation

◆ _setSymbolName()

template<class Base>

void DefinitionMixin< Base >::_setSymbolName ( const DString & name )

inlineoverride

Definition at line 300 of file definitionimpl.h.

301 { m_impl._setSymbolName(name); }

References DefinitionImpl::_setSymbolName(), m_impl, and name().

◆ _symbolName()

template<class Base>

DString DefinitionMixin< Base >::_symbolName ( ) const

inlineoverride

Definition at line 302 of file definitionimpl.h.

303 { return m_impl._symbolName(); }

References DefinitionImpl::_symbolName(), and m_impl.

◆ addInnerCompound()

template<class Base>

void DefinitionMixin< Base >::addInnerCompound ( Definition * def )

inlineoverride

Reimplemented in NamespaceDefImpl, and PageDefImpl.

Definition at line 250 of file definitionimpl.h.

251 { m_impl.addInnerCompound(def); }

References DefinitionImpl::addInnerCompound(), and m_impl.

◆ addSectionsToDefinition()

template<class Base>

void DefinitionMixin< Base >::addSectionsToDefinition ( const std::vector< const SectionInfo * > & anchorList )

inlineoverride

Definition at line 230 of file definitionimpl.h.

231 { m_impl.addSectionsToDefinition(anchorList); }

References DefinitionImpl::addSectionsToDefinition(), and m_impl.

◆ addSourceReferencedBy()

template<class Base>

void DefinitionMixin< Base >::addSourceReferencedBy	(	MemberDef *	md,
		const DString &	sourceRefName )

inlineoverride

Definition at line 236 of file definitionimpl.h.

237 { m_impl.addSourceReferencedBy(md,sourceRefName); }

References DefinitionImpl::addSourceReferencedBy(), and m_impl.

◆ addSourceReferences()

template<class Base>

void DefinitionMixin< Base >::addSourceReferences	(	MemberDef *	md,
		const DString &	sourceRefName )

inlineoverride

Definition at line 238 of file definitionimpl.h.

239 { m_impl.addSourceReferences(md,sourceRefName); }

References DefinitionImpl::addSourceReferences(), and m_impl.

◆ briefDescription()

template<class Base>

DString DefinitionMixin< Base >::briefDescription ( bool abbreviate = false ) const

inlineoverride

Reimplemented in MemberDefImpl.

Definition at line 177 of file definitionimpl.h.

177{ return m_impl.briefDescription(abbreviate); }

References DefinitionImpl::briefDescription(), and m_impl.

Referenced by MemberDefImpl::briefDescription().

◆ briefDescriptionAsTooltip()

template<class Base>

DString DefinitionMixin< Base >::briefDescriptionAsTooltip ( ) const

inlineoverride

Definition at line 178 of file definitionimpl.h.

178{ return m_impl.briefDescriptionAsTooltip(); }

References DefinitionImpl::briefDescriptionAsTooltip(), and m_impl.

◆ briefFile()

template<class Base>

DString DefinitionMixin< Base >::briefFile ( ) const

inlineoverride

Definition at line 183 of file definitionimpl.h.

183{ return m_impl.briefFile(); }

References DefinitionImpl::briefFile(), and m_impl.

Referenced by setBriefDescription().

◆ briefLine()

template<class Base>

int DefinitionMixin< Base >::briefLine ( ) const

inlineoverride

Definition at line 179 of file definitionimpl.h.

179{ return m_impl.briefLine(); }

References DefinitionImpl::briefLine(), and m_impl.

Referenced by setBriefDescription().

◆ computeTooltip()

template<class Base>

void DefinitionMixin< Base >::computeTooltip ( )

inlineoverride

Definition at line 298 of file definitionimpl.h.

299 { m_impl.computeTooltip(); }

References DefinitionImpl::computeTooltip(), and m_impl.

◆ docFile()

template<class Base>

DString DefinitionMixin< Base >::docFile ( ) const

inlineoverride

Definition at line 176 of file definitionimpl.h.

176{ return m_impl.docFile(); }

References DefinitionImpl::docFile(), and m_impl.

Referenced by setDocumentation(), and setInbodyDocumentation().

◆ docLine()

template<class Base>

int DefinitionMixin< Base >::docLine ( ) const

inlineoverride

Definition at line 175 of file definitionimpl.h.

175{ return m_impl.docLine(); }

References DefinitionImpl::docLine(), and m_impl.

Referenced by setDocumentation(), and setInbodyDocumentation().

◆ documentation()

template<class Base>

DString DefinitionMixin< Base >::documentation ( ) const

inlineoverride

Reimplemented in MemberDefImpl.

Definition at line 174 of file definitionimpl.h.

174{ return m_impl.documentation(); }

References DefinitionImpl::documentation(), and m_impl.

Referenced by MemberDefImpl::documentation().

◆ externalReference()

template<class Base>

DString DefinitionMixin< Base >::externalReference ( const DString & relPath ) const

inlineoverride

Definition at line 197 of file definitionimpl.h.

197{ return m_impl.externalReference(relPath); }

References DefinitionImpl::externalReference(), and m_impl.

◆ findInnerCompound()

template<class Base>

const Definition * DefinitionMixin< Base >::findInnerCompound ( const DString & name ) const

inlineoverride

Reimplemented in NamespaceDefImpl.

Definition at line 207 of file definitionimpl.h.

207{ return m_impl.findInnerCompound(name); }

References DefinitionImpl::findInnerCompound(), m_impl, and name().

◆ getBodyDef()

template<class Base>

const FileDef * DefinitionMixin< Base >::getBodyDef ( ) const

inlineoverride

Definition at line 201 of file definitionimpl.h.

201{ return m_impl.getBodyDef(); }

References DefinitionImpl::getBodyDef(), and m_impl.

◆ getDefColumn()

template<class Base>

size_t DefinitionMixin< Base >::getDefColumn ( ) const

inlineoverride

Definition at line 187 of file definitionimpl.h.

187{ return m_impl.getDefColumn(); }

References DefinitionImpl::getDefColumn(), and m_impl.

◆ getDefFileExtension()

template<class Base>

DString DefinitionMixin< Base >::getDefFileExtension ( ) const

inlineoverride

Definition at line 185 of file definitionimpl.h.

185{ return m_impl.getDefFileExtension(); }

References DefinitionImpl::getDefFileExtension(), and m_impl.

◆ getDefFileName()

template<class Base>

DString DefinitionMixin< Base >::getDefFileName ( ) const

inlineoverride

Definition at line 184 of file definitionimpl.h.

184{ return m_impl.getDefFileName(); }

References DefinitionImpl::getDefFileName(), and m_impl.

Referenced by ModuleDefImpl::mergeSymbolsFrom().

◆ getDefLine()

template<class Base>

int DefinitionMixin< Base >::getDefLine ( ) const

inlineoverride

Definition at line 186 of file definitionimpl.h.

186{ return m_impl.getDefLine(); }

References DefinitionImpl::getDefLine(), and m_impl.

Referenced by ModuleDefImpl::mergeSymbolsFrom().

◆ getEndBodyLine()

template<class Base>

int DefinitionMixin< Base >::getEndBodyLine ( ) const

inlineoverride

Definition at line 200 of file definitionimpl.h.

200{ return m_impl.getEndBodyLine(); }

References DefinitionImpl::getEndBodyLine(), and m_impl.

◆ getLanguage()

template<class Base>

SrcLangExt DefinitionMixin< Base >::getLanguage ( ) const

inlineoverride

Definition at line 202 of file definitionimpl.h.

202{ return m_impl.getLanguage(); }

References DefinitionImpl::getLanguage(), and m_impl.

◆ getOuterScope()

template<class Base>

Definition * DefinitionMixin< Base >::getOuterScope ( ) const

inlineoverride

Definition at line 208 of file definitionimpl.h.

208{ return m_impl.getOuterScope(); }

References DefinitionImpl::getOuterScope(), and m_impl.

◆ getReference()

template<class Base>

DString DefinitionMixin< Base >::getReference ( ) const

inlineoverride

Reimplemented in MemberDefImpl.

Definition at line 195 of file definitionimpl.h.

195{ return m_impl.getReference(); }

References DefinitionImpl::getReference(), and m_impl.

Referenced by ClassDefImpl::getReference(), and MemberDefImpl::getReference().

◆ getReferencedByMembers()

template<class Base>

const MemberVector & DefinitionMixin< Base >::getReferencedByMembers ( ) const

inlineoverride

Definition at line 210 of file definitionimpl.h.

210{ return m_impl.getReferencedByMembers(); }

References DefinitionImpl::getReferencedByMembers(), and m_impl.

◆ getReferencesMembers()

template<class Base>

const MemberVector & DefinitionMixin< Base >::getReferencesMembers ( ) const

inlineoverride

Definition at line 209 of file definitionimpl.h.

209{ return m_impl.getReferencesMembers(); }

References DefinitionImpl::getReferencesMembers(), and m_impl.

◆ getSectionRefs()

template<class Base>

const SectionRefs & DefinitionMixin< Base >::getSectionRefs ( ) const

inlineoverride

Definition at line 215 of file definitionimpl.h.

215{ return m_impl.getSectionRefs(); }

References DefinitionImpl::getSectionRefs(), and m_impl.

◆ getSourceAnchor()

template<class Base>

DString DefinitionMixin< Base >::getSourceAnchor ( ) const

inlineoverride

Definition at line 173 of file definitionimpl.h.

173{ return m_impl.getSourceAnchor(); }

References DefinitionImpl::getSourceAnchor(), and m_impl.

◆ getSourceFileBase()

template<class Base>

DString DefinitionMixin< Base >::getSourceFileBase ( ) const

inlineoverride

Reimplemented in FileDefImpl.

Definition at line 172 of file definitionimpl.h.

172{ return m_impl.getSourceFileBase(); }

References DefinitionImpl::getSourceFileBase(), and m_impl.

Referenced by ClassDefImpl::getSourceFileBase().

◆ getStartBodyLine()

template<class Base>

int DefinitionMixin< Base >::getStartBodyLine ( ) const

inlineoverride

Definition at line 199 of file definitionimpl.h.

199{ return m_impl.getStartBodyLine(); }

References DefinitionImpl::getStartBodyLine(), and m_impl.

◆ getStartDefLine()

template<class Base>

int DefinitionMixin< Base >::getStartDefLine ( ) const

inlineoverride

Definition at line 198 of file definitionimpl.h.

198{ return m_impl.getStartDefLine(); }

References DefinitionImpl::getStartDefLine(), and m_impl.

◆ hasBriefDescription()

template<class Base>

bool DefinitionMixin< Base >::hasBriefDescription ( ) const

inlineoverride

Definition at line 213 of file definitionimpl.h.

213{ return m_impl.hasBriefDescription(); }

References DefinitionImpl::hasBriefDescription(), and m_impl.

◆ hasDocumentation()

template<class Base>

bool DefinitionMixin< Base >::hasDocumentation ( ) const

inlineoverride

Reimplemented in MemberDefImpl.

Definition at line 188 of file definitionimpl.h.

188{ return m_impl.hasDocumentation(); }

References DefinitionImpl::hasDocumentation(), and m_impl.

Referenced by ClassDefImpl::hasDocumentation(), and MemberDefImpl::hasDocumentation().

◆ hasRequirementRefs()

template<class Base>

bool DefinitionMixin< Base >::hasRequirementRefs ( ) const

inlineoverride

Definition at line 274 of file definitionimpl.h.

275 { return m_impl.hasRequirementRefs(); }

References DefinitionImpl::hasRequirementRefs(), and m_impl.

◆ hasSections()

template<class Base>

bool DefinitionMixin< Base >::hasSections ( ) const

inlineoverride

Definition at line 211 of file definitionimpl.h.

211{ return m_impl.hasSections(); }

References DefinitionImpl::hasSections(), and m_impl.

◆ hasSourceReffedBy()

template<class Base>

bool DefinitionMixin< Base >::hasSourceReffedBy ( ) const

inlineoverride

Definition at line 268 of file definitionimpl.h.

269 { return m_impl.hasSourceReffedBy(); }

References DefinitionImpl::hasSourceReffedBy(), and m_impl.

◆ hasSourceRefs()

template<class Base>

bool DefinitionMixin< Base >::hasSourceRefs ( ) const

inlineoverride

Definition at line 266 of file definitionimpl.h.

267 { return m_impl.hasSourceRefs(); }

References DefinitionImpl::hasSourceRefs(), and m_impl.

◆ hasSources()

template<class Base>

bool DefinitionMixin< Base >::hasSources ( ) const

inlineoverride

Definition at line 212 of file definitionimpl.h.

212{ return m_impl.hasSources(); }

References DefinitionImpl::hasSources(), and m_impl.

◆ hasUserDocumentation()

template<class Base>

bool DefinitionMixin< Base >::hasUserDocumentation ( ) const

inlineoverride

Reimplemented in MemberDefImpl.

Definition at line 189 of file definitionimpl.h.

189{ return m_impl.hasUserDocumentation(); }

References DefinitionImpl::hasUserDocumentation(), and m_impl.

Referenced by MemberDefImpl::hasUserDocumentation().

◆ id()

template<class Base>

DString DefinitionMixin< Base >::id ( ) const

inlineoverride

Definition at line 214 of file definitionimpl.h.

214{ return m_impl.id(); }

References DefinitionImpl::id(), and m_impl.

◆ inbodyDocumentation()

template<class Base>

DString DefinitionMixin< Base >::inbodyDocumentation ( ) const

inlineoverride

Definition at line 180 of file definitionimpl.h.

180{ return m_impl.inbodyDocumentation(); }

References DefinitionImpl::inbodyDocumentation(), and m_impl.

◆ inbodyFile()

template<class Base>

DString DefinitionMixin< Base >::inbodyFile ( ) const

inlineoverride

Definition at line 181 of file definitionimpl.h.

181{ return m_impl.inbodyFile(); }

References DefinitionImpl::inbodyFile(), and m_impl.

◆ inbodyLine()

template<class Base>

int DefinitionMixin< Base >::inbodyLine ( ) const

inlineoverride

Definition at line 182 of file definitionimpl.h.

182{ return m_impl.inbodyLine(); }

References DefinitionImpl::inbodyLine(), and m_impl.

◆ isAlias()

template<class Base>

bool DefinitionMixin< Base >::isAlias ( ) const

inlineoverride

Definition at line 164 of file definitionimpl.h.

164{ return false; }

◆ isAnonymous()

template<class Base>

bool DefinitionMixin< Base >::isAnonymous ( ) const

inlineoverride

Definition at line 168 of file definitionimpl.h.

168{ return m_impl.isAnonymous(); }

References DefinitionImpl::isAnonymous(), and m_impl.

◆ isArtificial()

template<class Base>

bool DefinitionMixin< Base >::isArtificial ( ) const

inlineoverride

Definition at line 193 of file definitionimpl.h.

193{ return m_impl.isArtificial(); }

References DefinitionImpl::isArtificial(), and m_impl.

◆ isExported()

template<class Base>

bool DefinitionMixin< Base >::isExported ( ) const

inlineoverride

Definition at line 194 of file definitionimpl.h.

194{ return m_impl.isExported(); }

References DefinitionImpl::isExported(), and m_impl.

◆ isHidden()

template<class Base>

bool DefinitionMixin< Base >::isHidden ( ) const

inlineoverride

Definition at line 192 of file definitionimpl.h.

192{ return m_impl.isHidden(); }

References DefinitionImpl::isHidden(), and m_impl.

◆ isLinkableViaGroup()

template<class Base>

bool DefinitionMixin< Base >::isLinkableViaGroup ( ) const

inlineoverride

Definition at line 204 of file definitionimpl.h.

204{ return m_impl.isLinkableViaGroup(); }

References DefinitionImpl::isLinkableViaGroup(), and m_impl.

◆ isReference()

template<class Base>

bool DefinitionMixin< Base >::isReference ( ) const

inlineoverride

Reimplemented in MemberDefImpl.

Definition at line 196 of file definitionimpl.h.

196{ return m_impl.isReference(); }

References DefinitionImpl::isReference(), and m_impl.

Referenced by ClassDefImpl::isReference(), and MemberDefImpl::isReference().

◆ isVisible()

template<class Base>

bool DefinitionMixin< Base >::isVisible ( ) const

inlineoverride

Definition at line 191 of file definitionimpl.h.

191{ return m_impl.isVisible(); }

References DefinitionImpl::isVisible(), and m_impl.

◆ isVisibleInProject()

template<class Base>

bool DefinitionMixin< Base >::isVisibleInProject ( ) const

inlineoverride

Definition at line 190 of file definitionimpl.h.

190{ return m_impl.isVisibleInProject(); }

References DefinitionImpl::isVisibleInProject(), and m_impl.

◆ localName()

template<class Base>

const DString & DefinitionMixin< Base >::localName ( ) const

inlineoverride

Definition at line 169 of file definitionimpl.h.

169{ return m_impl.localName(); }

References DefinitionImpl::localName(), and m_impl.

◆ makePartOfGroup()

template<class Base>

void DefinitionMixin< Base >::makePartOfGroup ( GroupDef * gd )

inlineoverride

Definition at line 278 of file definitionimpl.h.

279 { m_impl.makePartOfGroup(gd); }

References m_impl, and DefinitionImpl::makePartOfGroup().

◆ mergeReferencedBy()

template<class Base>

void DefinitionMixin< Base >::mergeReferencedBy ( const Definition * other )

inlineoverride

Definition at line 248 of file definitionimpl.h.

249 { m_impl.mergeReferencedBy(other); }

References m_impl, and DefinitionImpl::mergeReferencedBy().

◆ mergeReferences()

template<class Base>

void DefinitionMixin< Base >::mergeReferences ( const Definition * other )

inlineoverride

Definition at line 246 of file definitionimpl.h.

247 { m_impl.mergeReferences(other); }

References m_impl, and DefinitionImpl::mergeReferences().

◆ mergeRefItems()

template<class Base>

void DefinitionMixin< Base >::mergeRefItems ( Definition * def )

inlineoverride

Definition at line 244 of file definitionimpl.h.

245 { m_impl.mergeRefItems(def); }

References m_impl, and DefinitionImpl::mergeRefItems().

◆ name()

template<class Base>

const DString & DefinitionMixin< Base >::name ( ) const

inlineoverride

Reimplemented in FileDefImpl.

Definition at line 167 of file definitionimpl.h.

167{ return m_impl.name(); }

References m_impl, and DefinitionImpl::name().

Referenced by _setSymbolName(), DefinitionMixin(), GroupDefImpl::displayName(), MemberDefImpl::displayName(), PageDefImpl::displayName(), FileDefImpl::FileDefImpl(), findInnerCompound(), FileDefImpl::name(), setId(), setLocalName(), and setName().

◆ navigationPathAsString()

template<class Base>

DString DefinitionMixin< Base >::navigationPathAsString ( ) const

inlineoverride

Definition at line 282 of file definitionimpl.h.

283 { return m_impl.navigationPathAsString(); }

References m_impl, and DefinitionImpl::navigationPathAsString().

◆ operator=() [1/2]

template<class Base>

DefinitionMixin & DefinitionMixin< Base >::operator= ( const DefinitionMixin< Base > & other )

inline

Definition at line 159 of file definitionimpl.h.

159{ if (this!=&other) { m_impl = other.m_impl; }; return *this; }

References DefinitionMixin(), and m_impl.

◆ operator=() [2/2]

template<class Base>

DefinitionMixin & DefinitionMixin< Base >::operator= ( DefinitionMixin< Base > && )

delete

References DefinitionMixin().

◆ partOfGroups()

template<class Base>

const GroupList & DefinitionMixin< Base >::partOfGroups ( ) const

inlineoverride

Definition at line 203 of file definitionimpl.h.

203{ return m_impl.partOfGroups(); }

References m_impl, and DefinitionImpl::partOfGroups().

◆ pathFragment()

template<class Base>

DString DefinitionMixin< Base >::pathFragment ( ) const

inlineoverride

Definition at line 290 of file definitionimpl.h.

291 { return m_impl.pathFragment(); }

References m_impl, and DefinitionImpl::pathFragment().

◆ qualifiedName()

template<class Base>

DString DefinitionMixin< Base >::qualifiedName ( ) const

inlineoverride

Reimplemented in MemberDefImpl, and ModuleDefImpl.

Definition at line 170 of file definitionimpl.h.

170{ return m_impl.qualifiedName(); }

References m_impl, and DefinitionImpl::qualifiedName().

Referenced by MemberDefImpl::qualifiedName().

◆ requirementReferences()

template<class Base>

const RequirementRefs & DefinitionMixin< Base >::requirementReferences ( ) const

inlineoverride

Definition at line 206 of file definitionimpl.h.

206{ return m_impl.requirementReferences(); }

References m_impl, and DefinitionImpl::requirementReferences().

◆ setArtificial()

template<class Base>

void DefinitionMixin< Base >::setArtificial ( bool b )

inlineoverride

Definition at line 256 of file definitionimpl.h.

257 { m_impl.setArtificial(b); }

References m_impl, and DefinitionImpl::setArtificial().

◆ setBodyDef()

template<class Base>

void DefinitionMixin< Base >::setBodyDef ( const FileDef * fd )

inlineoverride

Definition at line 234 of file definitionimpl.h.

235 { m_impl.setBodyDef(fd); }

References m_impl, and DefinitionImpl::setBodyDef().

◆ setBodySegment()

template<class Base>

void DefinitionMixin< Base >::setBodySegment	(	int	defLine,
		int	bls,
		int	ble )

inlineoverride

Definition at line 232 of file definitionimpl.h.

233 { m_impl.setBodySegment(defLine,bls,ble); }

References m_impl, and DefinitionImpl::setBodySegment().

◆ setBriefDescription()

template<class Base>

void DefinitionMixin< Base >::setBriefDescription	(	const DString &	brief,
		const DString &	briefFile,
		int	briefLine )

inlineoverride

Reimplemented in MemberDefImpl.

Definition at line 224 of file definitionimpl.h.

225 { m_impl.setBriefDescription(brief,briefFile,briefLine); }

DefinitionMixin::briefFile

DString briefFile() const override

Definition definitionimpl.h:183

DefinitionMixin::briefLine

int briefLine() const override

Definition definitionimpl.h:179

References briefFile(), briefLine(), m_impl, and DefinitionImpl::setBriefDescription().

Referenced by MemberDefImpl::setBriefDescription().

◆ setDefFile()

template<class Base>

void DefinitionMixin< Base >::setDefFile	(	const DString &	df,
		int	defLine,
		size_t	defColumn )

inlineoverride

Definition at line 220 of file definitionimpl.h.

221 { m_impl.setDefFile(df,defLine,defColumn); }

References m_impl, and DefinitionImpl::setDefFile().

◆ setDocumentation()

template<class Base>

void DefinitionMixin< Base >::setDocumentation	(	const DString &	doc,
		const DString &	docFile,
		int	docLine,
		bool	stripWhiteSpace = true )

inlineoverride

Reimplemented in MemberDefImpl.

Definition at line 222 of file definitionimpl.h.

223 { m_impl.setDocumentation(doc,docFile,docLine,stripWhiteSpace); }

DefinitionMixin::docFile

DString docFile() const override

Definition definitionimpl.h:176

DefinitionMixin::docLine

int docLine() const override

Definition definitionimpl.h:175

References docFile(), docLine(), m_impl, DefinitionImpl::setDocumentation(), and stripWhiteSpace().

Referenced by MemberDefImpl::setDocumentation().

◆ setExported()

template<class Base>

void DefinitionMixin< Base >::setExported ( bool b )

inlineoverride

Definition at line 258 of file definitionimpl.h.

259 { m_impl.setExported(b); }

References m_impl, and DefinitionImpl::setExported().

◆ setHidden()

template<class Base>

void DefinitionMixin< Base >::setHidden ( bool b )

inlineoverride

Reimplemented in MemberDefImpl.

Definition at line 254 of file definitionimpl.h.

255 { m_impl.setHidden(b); }

References m_impl, and DefinitionImpl::setHidden().

Referenced by MemberDefImpl::setHidden().

◆ setId()

template<class Base>

void DefinitionMixin< Base >::setId ( const DString & name )

inlineoverride

Definition at line 219 of file definitionimpl.h.

219{ m_impl.setId(name); }

References m_impl, name(), and DefinitionImpl::setId().

Referenced by ModuleManager::addTagInfo().

◆ setInbodyDocumentation()

template<class Base>

void DefinitionMixin< Base >::setInbodyDocumentation	(	const DString &	doc,
		const DString &	docFile,
		int	docLine )

inlineoverride

Reimplemented in MemberDefImpl.

Definition at line 226 of file definitionimpl.h.

227 { m_impl.setInbodyDocumentation(doc,docFile,docLine); }

References docFile(), docLine(), m_impl, and DefinitionImpl::setInbodyDocumentation().

Referenced by MemberDefImpl::setInbodyDocumentation().

◆ setLanguage()

template<class Base>

void DefinitionMixin< Base >::setLanguage ( SrcLangExt lang )

inlineoverride

Definition at line 260 of file definitionimpl.h.

261 { m_impl.setLanguage(lang); }

References m_impl, and DefinitionImpl::setLanguage().

◆ setLocalName()

template<class Base>

void DefinitionMixin< Base >::setLocalName ( const DString & name )

inlineoverride

Definition at line 294 of file definitionimpl.h.

295 { m_impl.setLocalName(name); }

References m_impl, name(), and DefinitionImpl::setLocalName().

◆ setName()

template<class Base>

void DefinitionMixin< Base >::setName ( const DString & name )

inlineoverride

Reimplemented in NamespaceDefImpl.

Definition at line 218 of file definitionimpl.h.

218{ m_impl.setName(name); }

References m_impl, name(), and DefinitionImpl::setName().

Referenced by NamespaceDefImpl::setName().

◆ setOuterScope()

template<class Base>

void DefinitionMixin< Base >::setOuterScope ( Definition * def )

inlineoverride

Definition at line 252 of file definitionimpl.h.

253 { m_impl.setOuterScope(def); }

References m_impl, and DefinitionImpl::setOuterScope().

◆ setReference()

template<class Base>

void DefinitionMixin< Base >::setReference ( const DString & r )

inlineoverride

Definition at line 228 of file definitionimpl.h.

229 { m_impl.setReference(r); }

References m_impl, and DefinitionImpl::setReference().

Referenced by ModuleManager::addTagInfo().

◆ setRefItems()

template<class Base>

void DefinitionMixin< Base >::setRefItems ( const RefItemVector & sli )

inlineoverride

Definition at line 240 of file definitionimpl.h.

241 { m_impl.setRefItems(sli); }

References m_impl, and DefinitionImpl::setRefItems().

◆ setRequirementReferences()

template<class Base>

void DefinitionMixin< Base >::setRequirementReferences ( const RequirementRefs & rqli )

inlineoverride

Definition at line 242 of file definitionimpl.h.

243 { m_impl.setRequirementReferences(rqli); }

References m_impl, and DefinitionImpl::setRequirementReferences().

◆ symbolName()

template<class Base>

DString DefinitionMixin< Base >::symbolName ( ) const

inlineoverride

Definition at line 171 of file definitionimpl.h.

171{ return m_impl.symbolName(); }

References m_impl, and DefinitionImpl::symbolName().

◆ toDefinition_()

template<class Base>

Definition * DefinitionMixin< Base >::toDefinition_ ( )

inlineoverrideprivate

Definition at line 306 of file definitionimpl.h.

306{ return this; }

◆ toDefinitionImpl_()

template<class Base>

const DefinitionImpl * DefinitionMixin< Base >::toDefinitionImpl_ ( ) const

inlineoverrideprivate

Definition at line 308 of file definitionimpl.h.

308{ return &m_impl; }

References m_impl.

◆ toDefinitionMutable_()

template<class Base>

DefinitionMutable * DefinitionMixin< Base >::toDefinitionMutable_ ( )

inlineoverrideprivate

Definition at line 307 of file definitionimpl.h.

307{ return this; }

◆ writeDocAnchorsToTagFile()

template<class Base>

void DefinitionMixin< Base >::writeDocAnchorsToTagFile ( TextStream & fs ) const

inlineoverride

Definition at line 292 of file definitionimpl.h.

293 { m_impl.writeDocAnchorsToTagFile(fs); }

References m_impl, and DefinitionImpl::writeDocAnchorsToTagFile().

◆ writeInlineCode()

template<class Base>

void DefinitionMixin< Base >::writeInlineCode	(	OutputList &	ol,
		const DString &	scopeName ) const

inlineoverride

Definition at line 264 of file definitionimpl.h.

265 { m_impl.writeInlineCode(ol,scopeName); }

References m_impl, and DefinitionImpl::writeInlineCode().

◆ writeNavigationPath()

template<class Base>

void DefinitionMixin< Base >::writeNavigationPath ( OutputList & ol ) const

inlineoverride

Definition at line 280 of file definitionimpl.h.

281 { m_impl.writeNavigationPath(ol); }

References m_impl, and DefinitionImpl::writeNavigationPath().

◆ writePageNavigation()

template<class Base>

void DefinitionMixin< Base >::writePageNavigation ( OutputList & ol ) const

inlineoverride

Reimplemented in DirDefImpl, FileDefImpl, GroupDefImpl, ModuleDefImpl, NamespaceDefImpl, and PageDefImpl.

Definition at line 288 of file definitionimpl.h.

289 { m_impl.writePageNavigation(ol); }

References m_impl, and DefinitionImpl::writePageNavigation().

◆ writeQuickMemberLinks()

template<class Base>

void DefinitionMixin< Base >::writeQuickMemberLinks	(	OutputList &	ol,
		const MemberDef *	md ) const

inlineoverride

Reimplemented in FileDefImpl, GroupDefImpl, and NamespaceDefImpl.

Definition at line 284 of file definitionimpl.h.

285 { m_impl.writeQuickMemberLinks(ol,md); }

References m_impl, and DefinitionImpl::writeQuickMemberLinks().

◆ writeRequirementRefs()

template<class Base>

void DefinitionMixin< Base >::writeRequirementRefs ( OutputList & ol ) const

inlineoverride

Definition at line 276 of file definitionimpl.h.

277 { m_impl.writeRequirementRefs(ol); }

References m_impl, and DefinitionImpl::writeRequirementRefs().

◆ writeSourceDef()

template<class Base>

void DefinitionMixin< Base >::writeSourceDef ( OutputList & ol ) const

inlineoverride

Definition at line 262 of file definitionimpl.h.

263 { m_impl.writeSourceDef(ol); }

References m_impl, and DefinitionImpl::writeSourceDef().

◆ writeSourceReffedBy()

template<class Base>

void DefinitionMixin< Base >::writeSourceReffedBy	(	OutputList &	ol,
		const DString &	scopeName ) const

inlineoverride

Definition at line 272 of file definitionimpl.h.

273 { m_impl.writeSourceReffedBy(ol,scopeName); }

References m_impl, and DefinitionImpl::writeSourceReffedBy().

◆ writeSourceRefs()

template<class Base>

void DefinitionMixin< Base >::writeSourceRefs	(	OutputList &	ol,
		const DString &	scopeName ) const

inlineoverride

Definition at line 270 of file definitionimpl.h.

271 { m_impl.writeSourceRefs(ol,scopeName); }

References m_impl, and DefinitionImpl::writeSourceRefs().

◆ writeSummaryLinks()

template<class Base>

void DefinitionMixin< Base >::writeSummaryLinks ( OutputList & ol ) const

inlineoverride

Reimplemented in FileDefImpl, GroupDefImpl, ModuleDefImpl, and NamespaceDefImpl.

Definition at line 286 of file definitionimpl.h.

287 { m_impl.writeSummaryLinks(ol); }

References m_impl, and DefinitionImpl::writeSummaryLinks().

◆ writeToc()

template<class Base>

void DefinitionMixin< Base >::writeToc	(	OutputList &	ol,
		const LocalToc &	lt ) const

inlineoverride

Definition at line 296 of file definitionimpl.h.

297 { m_impl.writeToc(ol,lt); }

References m_impl, and DefinitionImpl::writeToc().

◆ xrefListItems()

template<class Base>

const RefItemVector & DefinitionMixin< Base >::xrefListItems ( ) const

inlineoverride

Definition at line 205 of file definitionimpl.h.

205{ return m_impl.xrefListItems(); }

References m_impl, and DefinitionImpl::xrefListItems().

Member Data Documentation

◆ m_impl

template<class Base>

DefinitionImpl DefinitionMixin< Base >::m_impl

private

Definition at line 310 of file definitionimpl.h.

Referenced by _setSymbolName(), _symbolName(), addInnerCompound(), addSectionsToDefinition(), addSourceReferencedBy(), addSourceReferences(), briefDescription(), briefDescriptionAsTooltip(), briefFile(), briefLine(), computeTooltip(), DefinitionMixin(), DefinitionMixin(), docFile(), docLine(), documentation(), externalReference(), findInnerCompound(), getBodyDef(), getDefColumn(), getDefFileExtension(), getDefFileName(), getDefLine(), getEndBodyLine(), getLanguage(), getOuterScope(), getReference(), getReferencedByMembers(), getReferencesMembers(), getSectionRefs(), getSourceAnchor(), getSourceFileBase(), getStartBodyLine(), getStartDefLine(), hasBriefDescription(), hasDocumentation(), hasRequirementRefs(), hasSections(), hasSourceReffedBy(), hasSourceRefs(), hasSources(), hasUserDocumentation(), id(), inbodyDocumentation(), inbodyFile(), inbodyLine(), isAnonymous(), isArtificial(), isExported(), isHidden(), isLinkableViaGroup(), isReference(), isVisible(), isVisibleInProject(), localName(), makePartOfGroup(), mergeReferencedBy(), mergeReferences(), mergeRefItems(), name(), navigationPathAsString(), operator=(), partOfGroups(), pathFragment(), qualifiedName(), requirementReferences(), setArtificial(), setBodyDef(), setBodySegment(), setBriefDescription(), setDefFile(), setDocumentation(), setExported(), setHidden(), setId(), setInbodyDocumentation(), setLanguage(), setLocalName(), setName(), setOuterScope(), setReference(), setRefItems(), setRequirementReferences(), symbolName(), toDefinitionImpl_(), writeDocAnchorsToTagFile(), writeInlineCode(), writeNavigationPath(), writePageNavigation(), writeQuickMemberLinks(), writeRequirementRefs(), writeSourceDef(), writeSourceReffedBy(), writeSourceRefs(), writeSummaryLinks(), writeToc(), and xrefListItems().

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

src/definitionimpl.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DefinitionMixin() [1/3]

◆ DefinitionMixin() [2/3]

◆ DefinitionMixin() [3/3]

◆ ~DefinitionMixin()

Member Function Documentation

◆ _setSymbolName()

◆ _symbolName()

◆ addInnerCompound()

◆ addSectionsToDefinition()

◆ addSourceReferencedBy()

◆ addSourceReferences()

◆ briefDescription()

◆ briefDescriptionAsTooltip()

◆ briefFile()

◆ briefLine()

◆ computeTooltip()

◆ docFile()

◆ docLine()

◆ documentation()

◆ externalReference()

◆ findInnerCompound()

◆ getBodyDef()

◆ getDefColumn()

◆ getDefFileExtension()

◆ getDefFileName()

◆ getDefLine()

◆ getEndBodyLine()

◆ getLanguage()

◆ getOuterScope()

◆ getReference()

◆ getReferencedByMembers()

◆ getReferencesMembers()

◆ getSectionRefs()

◆ getSourceAnchor()

◆ getSourceFileBase()

◆ getStartBodyLine()

◆ getStartDefLine()

◆ hasBriefDescription()

◆ hasDocumentation()

◆ hasRequirementRefs()

◆ hasSections()

◆ hasSourceReffedBy()

◆ hasSourceRefs()

◆ hasSources()

◆ hasUserDocumentation()

◆ id()

◆ inbodyDocumentation()

◆ inbodyFile()

◆ inbodyLine()

◆ isAlias()

◆ isAnonymous()

◆ isArtificial()

◆ isExported()

◆ isHidden()

◆ isLinkableViaGroup()

◆ isReference()

◆ isVisible()

◆ isVisibleInProject()

◆ localName()

◆ makePartOfGroup()

◆ mergeReferencedBy()

◆ mergeReferences()

◆ mergeRefItems()

◆ name()

◆ navigationPathAsString()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ partOfGroups()

◆ pathFragment()

◆ qualifiedName()

◆ requirementReferences()

◆ setArtificial()

◆ setBodyDef()

◆ setBodySegment()

◆ setBriefDescription()