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

Public Member Functions

 ConceptDefAliasImpl (const Definition *newScope, const ConceptDef *cd)
 
 ~ConceptDefAliasImpl () override
 
const ConceptDefgetCdAlias () const
 
DefType definitionType () const override
 
CodeSymbolType codeSymbolType () const override
 
QCString getOutputFileBase () const override
 
QCString getReference () const override
 
bool isReference () const override
 
bool hasDetailedDescription () const override
 
QCString displayName (bool includeScope=true) const override
 
const IncludeInfoincludeInfo () const override
 
ArgumentList getTemplateParameterList () const override
 
QCString anchor () const override
 
bool isLinkableInProject () const override
 
bool isLinkable () const override
 
QCString initializer () const override
 
const NamespaceDefgetNamespaceDef () const override
 
const FileDefgetFileDef () const override
 
const ModuleDefgetModuleDef () const override
 
QCString title () const override
 
void writeDeclarationLink (OutputList &ol, bool &found, const QCString &header, bool localNames) const override
 
int groupId () 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 QCStringname () const override
 
bool isAnonymous () const override
 
const QCStringlocalName () const override
 
QCString qualifiedName () const override
 
QCString symbolName () const override
 
QCString getSourceFileBase () const override
 
QCString getSourceAnchor () const override
 
QCString documentation () const override
 
int docLine () const override
 
QCString docFile () const override
 
QCString briefDescription (bool abbreviate=FALSE) const override
 
QCString briefDescriptionAsTooltip () const override
 
int briefLine () const override
 
QCString inbodyDocumentation () const override
 
QCString inbodyFile () const override
 
int inbodyLine () const override
 
QCString briefFile () const override
 
QCString getDefFileName () const override
 
QCString getDefFileExtension () const override
 
int getDefLine () const override
 
int getDefColumn () const override
 
bool hasDocumentation () const override
 
bool hasUserDocumentation () const override
 
bool isVisibleInProject () const override
 
bool isVisible () const override
 
bool isHidden () const override
 
bool isArtificial () const override
 
bool isExported () const override
 
QCString getReference () const override
 
bool isReference () const override
 
QCString externalReference (const QCString &relPath) const override
 
int getStartDefLine () const override
 
int getStartBodyLine () const override
 
int getEndBodyLine () const override
 
const FileDefgetBodyDef () const override
 
SrcLangExt getLanguage () const override
 
const GroupListpartOfGroups () const override
 
bool isLinkableViaGroup () const override
 
const RefItemVectorxrefListItems () const override
 
const DefinitionfindInnerCompound (const QCString &name) const override
 
DefinitiongetOuterScope () const override
 
const MemberVectorgetReferencesMembers () const override
 
const MemberVectorgetReferencedByMembers () const override
 
bool hasSections () const override
 
bool hasSources () const override
 
bool hasBriefDescription () const override
 
QCString id () const override
 
const SectionRefsgetSectionRefs () const override
 
QCString navigationPathAsString () const override
 
QCString pathFragment () const override
 
- Public Member Functions inherited from ConceptDef
- Public Member Functions inherited from Definition

Additional Inherited Members

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

Detailed Description

Definition at line 99 of file conceptdef.cpp.

Constructor & Destructor Documentation

◆ ConceptDefAliasImpl()

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

◆ ~ConceptDefAliasImpl()

ConceptDefAliasImpl::~ConceptDefAliasImpl ( )
inlineoverride

Member Function Documentation

◆ anchor()

QCString ConceptDefAliasImpl::anchor ( ) const
inlineoverridevirtual

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

Implements Definition.

Definition at line 126 of file conceptdef.cpp.

127 { return getCdAlias()->anchor(); }
const ConceptDef * getCdAlias() const
virtual QCString anchor() const =0

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

◆ codeSymbolType()

CodeSymbolType ConceptDefAliasImpl::codeSymbolType ( ) const
inlineoverridevirtual

Used for syntax highlighting symbol class

Implements Definition.

Definition at line 110 of file conceptdef.cpp.

111 { return getCdAlias()->codeSymbolType(); }
virtual CodeSymbolType codeSymbolType() const =0

References Definition::codeSymbolType(), 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 109 of file conceptdef.cpp.

109{ return TypeConcept; }

References Definition::TypeConcept.

◆ displayName()

QCString ConceptDefAliasImpl::displayName ( bool includeScope = true) const
inlineoverridevirtual

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

Implements Definition.

Definition at line 120 of file conceptdef.cpp.

121 { return getCdAlias()->displayName(includeScope); }
virtual QCString displayName(bool includeScope=TRUE) const =0

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

◆ getCdAlias()

◆ getFileDef()

const FileDef * ConceptDefAliasImpl::getFileDef ( ) const
inlineoverridevirtual

Implements ConceptDef.

Definition at line 136 of file conceptdef.cpp.

137 { return getCdAlias()->getFileDef(); }
virtual const FileDef * getFileDef() const =0

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

◆ getModuleDef()

const ModuleDef * ConceptDefAliasImpl::getModuleDef ( ) const
inlineoverridevirtual

Implements ConceptDef.

Definition at line 138 of file conceptdef.cpp.

139 { return getCdAlias()->getModuleDef(); }
virtual const ModuleDef * getModuleDef() const =0

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

◆ getNamespaceDef()

const NamespaceDef * ConceptDefAliasImpl::getNamespaceDef ( ) const
inlineoverridevirtual

Implements ConceptDef.

Definition at line 134 of file conceptdef.cpp.

135 { return getCdAlias()->getNamespaceDef(); }
virtual const NamespaceDef * getNamespaceDef() const =0

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

◆ getOutputFileBase()

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

113 { return getCdAlias()->getOutputFileBase(); }
virtual QCString getOutputFileBase() const =0

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

◆ getReference()

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

115 { return getCdAlias()->getReference(); }
virtual QCString getReference() const =0

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

◆ getTemplateParameterList()

ArgumentList ConceptDefAliasImpl::getTemplateParameterList ( ) const
inlineoverridevirtual

Implements ConceptDef.

Definition at line 124 of file conceptdef.cpp.

125 { return getCdAlias()->getTemplateParameterList(); }
virtual ArgumentList getTemplateParameterList() const =0

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

◆ groupId()

int ConceptDefAliasImpl::groupId ( ) const
inlineoverridevirtual

Implements ConceptDef.

Definition at line 145 of file conceptdef.cpp.

146 { return getCdAlias()->groupId(); }
virtual int groupId() const =0

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

◆ hasDetailedDescription()

bool ConceptDefAliasImpl::hasDetailedDescription ( ) const
inlineoverridevirtual

Implements ConceptDef.

Definition at line 118 of file conceptdef.cpp.

119 { return getCdAlias()->hasDetailedDescription(); }
virtual bool hasDetailedDescription() const =0

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

◆ includeInfo()

const IncludeInfo * ConceptDefAliasImpl::includeInfo ( ) const
inlineoverridevirtual

Implements ConceptDef.

Definition at line 122 of file conceptdef.cpp.

123 { return getCdAlias()->includeInfo(); }
virtual const IncludeInfo * includeInfo() const =0

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

◆ initializer()

QCString ConceptDefAliasImpl::initializer ( ) const
inlineoverridevirtual

Implements ConceptDef.

Definition at line 132 of file conceptdef.cpp.

133 { return getCdAlias()->initializer(); }
virtual QCString initializer() const =0

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

131 { return getCdAlias()->isLinkable(); }
virtual bool isLinkable() const =0

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

129 { return getCdAlias()->isLinkableInProject(); }
virtual bool isLinkableInProject() const =0

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

117 { return getCdAlias()->isReference(); }
virtual bool isReference() const =0

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

◆ title()

QCString ConceptDefAliasImpl::title ( ) const
inlineoverridevirtual

Implements ConceptDef.

Definition at line 140 of file conceptdef.cpp.

141 { return getCdAlias()->title(); }
virtual QCString title() const =0

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

◆ writeDeclarationLink()

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

Implements ConceptDef.

Definition at line 142 of file conceptdef.cpp.

144 { getCdAlias()->writeDeclarationLink(ol,found,header,localNames); }
virtual void writeDeclarationLink(OutputList &ol, bool &found, const QCString &header, bool localNames) const =0
bool found
Definition util.cpp:984

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


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