ConceptDefAliasImpl Class Reference

Inheritance diagram for ConceptDefAliasImpl:

Collaboration diagram for ConceptDefAliasImpl:

Public Member Functions
	ConceptDefAliasImpl (const Definition *newScope, const ConceptDef *cd)
	~ConceptDefAliasImpl () override
const ConceptDef *	getCdAlias () const
DefType	definitionType () const override
CodeSymbolType	codeSymbolType () const override
DString	getOutputFileBase () const override
DString	getReference () const override
bool	isReference () const override
bool	hasDetailedDescription () const override
DString	displayName (bool includeScope=true) const override
const IncludeInfo *	includeInfo () const override
ArgumentList	getTemplateParameterList () const override
DString	anchor () const override
bool	isLinkableInProject () const override
bool	isLinkable () const override
DString	initializer () const override
const NamespaceDef *	getNamespaceDef () const override
const FileDef *	getFileDef () const override
const ModuleDef *	getModuleDef () const override
DString	title () const override
void	writeDeclarationLink (OutputList &ol, bool &found, const DString &header, bool localNames) const override
int	groupId () const override
Parts	conceptParts () const override
Public Member Functions inherited from DefinitionAliasMixin< ConceptDef >
	DefinitionAliasMixin (const Definition *scope, const Definition *alias)
	~DefinitionAliasMixin () override=default
void	init ()
void	deinit ()
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
DString	navigationPathAsString () const override
DString	pathFragment () const override

Additional Inherited Members
Public Types inherited from ConceptDef
enum class	PartType { Code , Doc }
using	Parts = std::vector<Part>
Public Types inherited from Definition
enum	DefType {   TypeClass = 0 , TypeFile = 1 , TypeNamespace = 2 , TypeModule = 3 ,   TypeMember = 4 , TypeGroup = 5 , TypePackage = 6 , TypePage = 7 ,   TypeDir = 8 , TypeConcept = 9 }
Protected Member Functions inherited from DefinitionAliasMixin< ConceptDef >
const Definition *	getAlias () const
const Definition *	getScope () const

Detailed Description

Definition at line 105 of file conceptdef.cpp.

Constructor & Destructor Documentation

ConceptDefAliasImpl()

ConceptDefAliasImpl::ConceptDefAliasImpl ( const Definition * newScope, const ConceptDef * cd )

inline

Definition at line 108 of file conceptdef.cpp.

      : DefinitionAliasMixin(newScope,cd) { init(); }

References DefinitionAliasMixin< ConceptDef >::DefinitionAliasMixin(), and DefinitionAliasMixin< ConceptDef >::init().

~ConceptDefAliasImpl()

ConceptDefAliasImpl::~ConceptDefAliasImpl ( )

inlineoverride

Definition at line 110 of file conceptdef.cpp.

{ deinit(); }

References DefinitionAliasMixin< ConceptDef >::deinit().

Member Function Documentation

anchor()

DString ConceptDefAliasImpl::anchor ( ) const

inlineoverridevirtual

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

Implements Definition.

Definition at line 132 of file conceptdef.cpp.

    { return getCdAlias()->anchor(); }

References Definition::anchor(), and getCdAlias().

codeSymbolType()

CodeSymbolType ConceptDefAliasImpl::codeSymbolType ( ) const

inlineoverridevirtual

Used for syntax highlighting symbol class

Implements Definition.

Definition at line 116 of file conceptdef.cpp.

    { return getCdAlias()->codeSymbolType(); }

References Definition::codeSymbolType(), and getCdAlias().

conceptParts()

Parts ConceptDefAliasImpl::conceptParts ( ) const

inlineoverridevirtual

Implements ConceptDef.

Definition at line 153 of file conceptdef.cpp.

    { return getCdAlias()->conceptParts(); }

References ConceptDef::conceptParts(), and getCdAlias().

definitionType()

DefType ConceptDefAliasImpl::definitionType ( ) const

inlineoverridevirtual

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

Implements Definition.

Definition at line 115 of file conceptdef.cpp.

{ return TypeConcept; }

References Definition::TypeConcept.

displayName()

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

inlineoverridevirtual

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

Implements Definition.

Definition at line 126 of file conceptdef.cpp.

    { return getCdAlias()->displayName(includeScope); }

References Definition::displayName(), and getCdAlias().

getCdAlias()

const ConceptDef * ConceptDefAliasImpl::getCdAlias ( ) const

inline

Definition at line 113 of file conceptdef.cpp.

{ return toConceptDef(getAlias()); }

References DefinitionAliasMixin< ConceptDef >::getAlias(), getCdAlias(), and toConceptDef().

Referenced by anchor(), codeSymbolType(), conceptParts(), displayName(), getCdAlias(), getFileDef(), getModuleDef(), getNamespaceDef(), getOutputFileBase(), getReference(), getTemplateParameterList(), groupId(), hasDetailedDescription(), includeInfo(), initializer(), isLinkable(), isLinkableInProject(), isReference(), title(), and writeDeclarationLink().

getFileDef()

const FileDef * ConceptDefAliasImpl::getFileDef ( ) const

inlineoverridevirtual

Implements ConceptDef.

Definition at line 142 of file conceptdef.cpp.

    { return getCdAlias()->getFileDef(); }

References getCdAlias(), and ConceptDef::getFileDef().

getModuleDef()

const ModuleDef * ConceptDefAliasImpl::getModuleDef ( ) const

inlineoverridevirtual

Implements ConceptDef.

Definition at line 144 of file conceptdef.cpp.

    { return getCdAlias()->getModuleDef(); }

References getCdAlias(), and ConceptDef::getModuleDef().

getNamespaceDef()

const NamespaceDef * ConceptDefAliasImpl::getNamespaceDef ( ) const

inlineoverridevirtual

Implements ConceptDef.

Definition at line 140 of file conceptdef.cpp.

    { return getCdAlias()->getNamespaceDef(); }

References getCdAlias(), and ConceptDef::getNamespaceDef().

getOutputFileBase()

DString ConceptDefAliasImpl::getOutputFileBase ( ) const

inlineoverridevirtual

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

Implements Definition.

Definition at line 118 of file conceptdef.cpp.

    { return getCdAlias()->getOutputFileBase(); }

References getCdAlias(), and Definition::getOutputFileBase().

getReference()

DString ConceptDefAliasImpl::getReference ( ) const

inlineoverridevirtual

If this definition was imported via a tag file, this function returns the tagfile for the external project. This can be translated into an external link target via Doxygen::tagDestinationDict

Implements Definition.

Definition at line 120 of file conceptdef.cpp.

    { return getCdAlias()->getReference(); }

References getCdAlias(), and Definition::getReference().

getTemplateParameterList()

ArgumentList ConceptDefAliasImpl::getTemplateParameterList ( ) const

inlineoverridevirtual

Implements ConceptDef.

Definition at line 130 of file conceptdef.cpp.

    { return getCdAlias()->getTemplateParameterList(); }

References getCdAlias(), and ConceptDef::getTemplateParameterList().

groupId()

int ConceptDefAliasImpl::groupId ( ) const

inlineoverridevirtual

Implements ConceptDef.

Definition at line 151 of file conceptdef.cpp.

    { return getCdAlias()->groupId(); }

References getCdAlias(), and ConceptDef::groupId().

hasDetailedDescription()

bool ConceptDefAliasImpl::hasDetailedDescription ( ) const

inlineoverridevirtual

Implements ConceptDef.

Definition at line 124 of file conceptdef.cpp.

    { return getCdAlias()->hasDetailedDescription(); }

References getCdAlias(), and ConceptDef::hasDetailedDescription().

includeInfo()

const IncludeInfo * ConceptDefAliasImpl::includeInfo ( ) const

inlineoverridevirtual

Implements ConceptDef.

Definition at line 128 of file conceptdef.cpp.

    { return getCdAlias()->includeInfo(); }

References getCdAlias(), and ConceptDef::includeInfo().

initializer()

DString ConceptDefAliasImpl::initializer ( ) const

inlineoverridevirtual

Implements ConceptDef.

Definition at line 138 of file conceptdef.cpp.

    { return getCdAlias()->initializer(); }

References getCdAlias(), and ConceptDef::initializer().

isLinkable()

bool ConceptDefAliasImpl::isLinkable ( ) const

inlineoverridevirtual

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 136 of file conceptdef.cpp.

    { return getCdAlias()->isLinkable(); }

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

isLinkableInProject()

bool ConceptDefAliasImpl::isLinkableInProject ( ) const

inlineoverridevirtual

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

Implements Definition.

Definition at line 134 of file conceptdef.cpp.

    { return getCdAlias()->isLinkableInProject(); }

References getCdAlias(), and Definition::isLinkableInProject().

isReference()

bool ConceptDefAliasImpl::isReference ( ) const

inlineoverridevirtual

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

Implements Definition.

Definition at line 122 of file conceptdef.cpp.

    { return getCdAlias()->isReference(); }

References getCdAlias(), and Definition::isReference().

title()

DString ConceptDefAliasImpl::title ( ) const

inlineoverridevirtual

Implements ConceptDef.

Definition at line 146 of file conceptdef.cpp.

    { return getCdAlias()->title(); }

References getCdAlias(), and ConceptDef::title().

writeDeclarationLink()

void ConceptDefAliasImpl::writeDeclarationLink ( OutputList & ol, bool & found, const DString & header, bool localNames ) const

inlineoverridevirtual

Implements ConceptDef.

Definition at line 148 of file conceptdef.cpp.

    { getCdAlias()->writeDeclarationLink(ol,found,header,localNames); }

References getCdAlias(), and ConceptDef::writeDeclarationLink().

---

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

• src/conceptdef.cpp