Public Member Functions | List of all members
ConceptDefAliasImpl Class Reference
Inheritance diagram for ConceptDefAliasImpl:
Inheritance graph
Collaboration diagram for ConceptDefAliasImpl:
Collaboration graph

Public Member Functions

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

Additional Inherited Members

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

Member Function Documentation

◆ anchor()

virtual QCString ConceptDefAliasImpl::anchor ( ) const

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

Implements ConceptDef.

◆ codeSymbolType()

virtual CodeSymbolType ConceptDefAliasImpl::codeSymbolType ( ) const

Used for syntax highlighting symbol class

Implements Definition.

◆ definitionType()

virtual DefType ConceptDefAliasImpl::definitionType ( ) const

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

Implements ConceptDef.

◆ displayName()

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

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

Implements ConceptDef.

◆ getOutputFileBase()

virtual QCString ConceptDefAliasImpl::getOutputFileBase ( ) const

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

Implements ConceptDef.

◆ getReference()

virtual QCString ConceptDefAliasImpl::getReference ( ) const

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 DefinitionAliasMixin< ConceptDef >.

◆ isLinkable()

virtual bool ConceptDefAliasImpl::isLinkable ( ) const

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

◆ isLinkableInProject()

virtual bool ConceptDefAliasImpl::isLinkableInProject ( ) const

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

Implements ConceptDef.

◆ isReference()

virtual bool ConceptDefAliasImpl::isReference ( ) const

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

Reimplemented from DefinitionAliasMixin< ConceptDef >.

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