doxygen
Public Member Functions | List of all members
MemberDefAliasImpl Class Reference
Inheritance diagram for MemberDefAliasImpl:
Inheritance graph
[legend]
Collaboration diagram for MemberDefAliasImpl:
Collaboration graph
[legend]

Public Member Functions

 MemberDefAliasImpl (const Definition *newScope, const MemberDef *md)
 
DefType definitionType () const override
 
const MemberDef * getMdAlias () const
 
MemberDef * getMdAlias ()
 
MemberDef * resolveAlias () override
 
const MemberDef * resolveAlias () const override
 
std::unique_ptr< MemberDef > deepCopy () const override
 
void moveTo (Definition *) override
 
const QCString & name () const override
 
CodeSymbolType codeSymbolType () const override
 
QCString getOutputFileBase () const override
 
QCString getReference () const override
 
QCString anchor () const override
 
QCString declaration () const override
 
QCString definition () const override
 
QCString typeString () const override
 
QCString argsString () const override
 
QCString excpString () const override
 
QCString bitfieldString () const override
 
QCString extraTypeChars () const override
 
const QCString & initializer () const override
 
int initializerLines () const override
 
TypeSpecifier getMemberSpecifiers () const override
 
VhdlSpecifier getVhdlSpecifiers () const override
 
const MemberList * getSectionList (const Definition *container) const override
 
QCString displayDefinition () const override
 
const ClassDef * getClassDef () const override
 
ClassDef * getClassDef () override
 
const FileDef * getFileDef () const override
 
FileDef * getFileDef () override
 
const ModuleDef * getModuleDef () const override
 
const NamespaceDef * getNamespaceDef () const override
 
NamespaceDef * getNamespaceDef () override
 
const ClassDef * accessorClass () const override
 
QCString getReadAccessor () const override
 
QCString getWriteAccessor () const override
 
const GroupDef * getGroupDef () const override
 
Grouping::GroupPri_t getGroupPri () const override
 
QCString getGroupFileName () const override
 
int getGroupStartLine () const override
 
bool getGroupHasDocs () const override
 
QCString qualifiedName () const override
 
QCString objCMethodName (bool localLink, bool showStatic) const override
 
Protection protection () const override
 
Specifier virtualness (int) const override
 
MemberType memberType () const override
 
QCString 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 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 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
 
bool isDocsForDefinition () const override
 
const MemberDef * getEnumScope () const override
 
const MemberVector & enumFieldList () const override
 
QCString 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 fromAnonymousScope () const override
 
MemberDef * fromAnonymousMember () const override
 
bool hasCallGraph () const override
 
bool hasCallerGraph () const override
 
bool hasReferencesRelation () const override
 
bool hasReferencedByRelation () const override
 
bool hasInlineSource () const override
 
StringVector getQualifiers () const override
 
const MemberDef * templateMaster () const override
 
QCString getScopeString () const override
 
ClassDef * getClassDefOfAnonymousType () const override
 
bool isTypedefValCached () const override
 
const ClassDef * getCachedTypedefVal () const override
 
QCString getCachedTypedefTemplSpec () const override
 
QCString 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
 
QCString displayName (bool b=TRUE) const override
 
QCString getDeclType () const override
 
StringVector getLabels (const Definition *container) const override
 
const ArgumentList & typeConstraints () const override
 
QCString documentation () const override
 
QCString briefDescription (bool) const override
 
QCString fieldType () const override
 
bool isReference () const override
 
QCString getDeclFileName () const override
 
int getDeclLine () const override
 
int getDeclColumn () const override
 
QCString requiresClause () const override
 
bool visibleInIndex () const override
 
void warnIfUndocumented () const override
 
void warnIfUndocumentedParams () const override
 
void detectUndocumentedParams (bool, bool) const override
 
void setMemberGroup (MemberGroup *grp) override
 
std::unique_ptr< MemberDef > createTemplateInstanceMember (const ArgumentList &formalArgs, const std::unique_ptr< ArgumentList > &actualArgs) const 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 QCString &inheritId=QCString()) const override
 
void writeEnumDeclaration (OutputList &typeDecl, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod) const 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
 
- Public Member Functions inherited from DefinitionAliasMixin< MemberDef >
 DefinitionAliasMixin (const Definition *scope, const Definition *alias)
 
void init ()
 
void deinit ()
 
bool isAlias () const override
 
const QCString & name () const override
 
bool isAnonymous () const override
 
const QCString & localName () 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 FileDef * getBodyDef () const override
 
SrcLangExt getLanguage () const override
 
const GroupList & partOfGroups () const override
 
bool isLinkableViaGroup () const override
 
const RefItemVector & xrefListItems () const override
 
const Definition * findInnerCompound (const QCString &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
 
QCString id () const override
 
const SectionRefs & getSectionRefs () const override
 
QCString navigationPathAsString () const override
 
QCString pathFragment () const override
 

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< MemberDef >
const Definition * getAlias () const
 
const Definition * getScope () const
 

Member Function Documentation

◆ anchor()

QCString MemberDefAliasImpl::anchor ( ) const
inlineoverridevirtual

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

Implements Definition.

◆ briefDescription()

QCString MemberDefAliasImpl::briefDescription ( bool  abbreviate) const
inlineoverridevirtual

Returns the brief description of this definition. This can include commands.

Implements Definition.

◆ codeSymbolType()

CodeSymbolType MemberDefAliasImpl::codeSymbolType ( ) const
inlineoverridevirtual

Used for syntax highlighting symbol class

Implements Definition.

◆ definitionType()

DefType MemberDefAliasImpl::definitionType ( ) const
inlineoverridevirtual

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

Implements Definition.

◆ displayName()

QCString MemberDefAliasImpl::displayName ( bool  includeScope = TRUE) const
inlineoverridevirtual

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

Implements Definition.

◆ documentation()

QCString MemberDefAliasImpl::documentation ( ) const
inlineoverridevirtual

Returns the detailed description of this definition

Implements Definition.

◆ getOutputFileBase()

QCString MemberDefAliasImpl::getOutputFileBase ( ) const
inlineoverridevirtual

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

Implements Definition.

◆ getReference()

QCString MemberDefAliasImpl::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.

◆ hasDocumentation()

bool MemberDefAliasImpl::hasDocumentation ( ) const
inlineoverridevirtual

Returns TRUE iff the definition is documented (which could be generated documentation)

See also
hasUserDocumentation()

Implements Definition.

◆ isLinkable()

bool MemberDefAliasImpl::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.

◆ isLinkableInProject()

bool MemberDefAliasImpl::isLinkableInProject ( ) const
inlineoverridevirtual

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

Implements Definition.

◆ isReference()

bool MemberDefAliasImpl::isReference ( ) const
inlineoverridevirtual

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

Implements Definition.

◆ name()

const QCString& MemberDefAliasImpl::name ( ) const
inlineoverridevirtual

Returns the name of the definition

Implements Definition.

◆ qualifiedName()

QCString MemberDefAliasImpl::qualifiedName ( ) const
inlineoverridevirtual

Returns the fully qualified name of this definition

Implements Definition.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.13