Inheritance diagram for ConceptDef:
Collaboration diagram for ConceptDef:
Public Member Functions | |
| virtual DefType | definitionType () const =0 |
| virtual QCString | getOutputFileBase () const =0 |
| virtual bool | hasDetailedDescription () const =0 |
| virtual QCString | displayName (bool includeScope=true) const =0 |
| virtual const IncludeInfo * | includeInfo () const =0 |
| virtual ArgumentList | getTemplateParameterList () const =0 |
| virtual QCString | anchor () const =0 |
| virtual bool | isLinkableInProject () const =0 |
| virtual bool | isLinkable () const =0 |
| virtual QCString | initializer () const =0 |
| virtual void | writeDeclarationLink (OutputList &ol, bool &found, const QCString &header, bool localNames) const =0 |
| virtual const NamespaceDef * | getNamespaceDef () const =0 |
| virtual const FileDef * | getFileDef () const =0 |
| virtual QCString | title () const =0 |
| virtual int | groupId () const =0 |
 Public Member Functions inherited from Definition | |
| virtual CodeSymbolType | codeSymbolType () const =0 |
| virtual bool | isAlias () const =0 |
| virtual const QCString & | name () const =0 |
| virtual bool | isAnonymous () const =0 |
| virtual const QCString & | localName () const =0 |
| virtual QCString | qualifiedName () const =0 |
| virtual QCString | symbolName () const =0 |
| virtual QCString | getSourceFileBase () const =0 |
| virtual QCString | getSourceAnchor () const =0 |
| virtual QCString | documentation () const =0 |
| virtual int | docLine () const =0 |
| virtual QCString | docFile () const =0 |
| virtual QCString | briefDescription (bool abbreviate=FALSE) const =0 |
| virtual QCString | briefDescriptionAsTooltip () const =0 |
| virtual int | briefLine () const =0 |
| virtual QCString | inbodyDocumentation () const =0 |
| virtual QCString | inbodyFile () const =0 |
| virtual int | inbodyLine () const =0 |
| virtual QCString | briefFile () const =0 |
| virtual QCString | getDefFileName () const =0 |
| virtual QCString | getDefFileExtension () const =0 |
| virtual int | getDefLine () const =0 |
| virtual int | getDefColumn () const =0 |
| virtual bool | hasDocumentation () const =0 |
| virtual bool | hasUserDocumentation () const =0 |
| virtual bool | isVisibleInProject () const =0 |
| virtual bool | isVisible () const =0 |
| virtual bool | isHidden () const =0 |
| virtual bool | isArtificial () const =0 |
| virtual QCString | getReference () const =0 |
| virtual bool | isReference () const =0 |
| virtual QCString | externalReference (const QCString &relPath) const =0 |
| virtual int | getStartDefLine () const =0 |
| virtual int | getStartBodyLine () const =0 |
| virtual int | getEndBodyLine () const =0 |
| virtual const FileDef * | getBodyDef () const =0 |
| virtual SrcLangExt | getLanguage () const =0 |
| Returns the programming language this definition was written in. More... | |
| virtual const GroupList & | partOfGroups () const =0 |
| virtual bool | isLinkableViaGroup () const =0 |
| virtual const RefItemVector & | xrefListItems () const =0 |
| virtual const Definition * | findInnerCompound (const QCString &name) const =0 |
| virtual Definition * | getOuterScope () const =0 |
| virtual const MemberVector & | getReferencesMembers () const =0 |
| virtual const MemberVector & | getReferencedByMembers () const =0 |
| virtual bool | hasSections () const =0 |
| virtual bool | hasSources () const =0 |
| virtual bool | hasBriefDescription () const =0 |
| returns TRUE if this class has a brief description | |
| virtual QCString | id () const =0 |
| virtual const SectionRefs & | getSectionRefs () const =0 |
| returns the section dictionary, only of importance for pagedef | |
| virtual QCString | navigationPathAsString () const =0 |
| virtual QCString | pathFragment () const =0 |
| virtual void | _setSymbolName (const QCString &name)=0 |
| virtual QCString | _symbolName () const =0 |
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 } |
Member Function Documentation
◆ anchor()
|
pure virtual |
Returns the anchor within a page where this item can be found
Implements Definition.
Implemented in ConceptDefAliasImpl, and ConceptDefImpl.
◆ definitionType()
|
pure virtual |
Use this for dynamic inspection of the type of the derived class
Implements Definition.
Implemented in ConceptDefAliasImpl, and ConceptDefImpl.
◆ displayName()
|
pure virtual |
Returns the name of the definition as it appears in the output
Implements Definition.
Implemented in ConceptDefAliasImpl, and ConceptDefImpl.
◆ getOutputFileBase()
|
pure virtual |
Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.
Implements Definition.
Implemented in ConceptDefAliasImpl, and ConceptDefImpl.
◆ isLinkable()
|
pure virtual |
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.
Implemented in ConceptDefAliasImpl, and ConceptDefImpl.
◆ isLinkableInProject()
|
pure virtual |
Returns TRUE iff it is possible to link to this item within this project.
Implements Definition.
Implemented in ConceptDefAliasImpl, and ConceptDefImpl.
The documentation for this class was generated from the following file:
- src/conceptdef.h
