doxygen
|
The common base class of all entity definitions found in the sources. More...
#include <definition.h>
Public Types | |
enum | DefType { TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeModule = 3, TypeMember = 4, TypeGroup = 5, TypePackage = 6, TypePage = 7, TypeDir = 8, TypeConcept = 9 } |
Public Member Functions | |
virtual DefType | definitionType () const =0 |
virtual CodeSymbolType | codeSymbolType () const =0 |
virtual bool | isAlias () const =0 |
virtual const QCString & | name () const =0 |
virtual bool | isAnonymous () const =0 |
virtual QCString | displayName (bool includeScope=TRUE) const =0 |
virtual const QCString & | localName () const =0 |
virtual QCString | qualifiedName () const =0 |
virtual QCString | symbolName () const =0 |
virtual QCString | getOutputFileBase () const =0 |
virtual QCString | anchor () 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 | isLinkableInProject () const =0 |
virtual bool | isLinkable () const =0 |
virtual bool | isVisibleInProject () const =0 |
virtual bool | isVisible () const =0 |
virtual bool | isHidden () const =0 |
virtual bool | isArtificial () const =0 |
virtual bool | isExported () 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 |
Friends | |
class | DefinitionImpl |
DefinitionMutable * | toDefinitionMutable (Definition *) |
DefinitionMutable * | toDefinitionMutable (const Definition *) |
The common base class of all entity definitions found in the sources.
This can be a class or a member function, or a file, or a namespace, etc. Use definitionType() to find which type of definition this is.
enum Definition::DefType |
Types of derived classes
|
pure virtual |
Returns the anchor within a page where this item can be found
Implemented in MemberDefAliasImpl, ClassDefAliasImpl, ClassDef, ClassDefImpl, NamespaceDefAliasImpl, FileDefImpl, ConceptDefAliasImpl, DirDef, FileDef, MemberDefImpl, MemberDef, NamespaceDefImpl, GroupDefImpl, ModuleDefImpl, NamespaceDef, GroupDef, ConceptDefImpl, DirDefImpl, PageDefImpl, PageDef, and ConceptDef.
|
pure virtual |
Returns the brief description of this definition. This can include commands.
Implemented in MemberDefAliasImpl, MemberDef, and MemberDefImpl.
|
pure virtual |
Returns a plain text version of the brief description suitable for use as a tool tip.
|
pure virtual |
Returns the file in which the brief description was found. This can differ from getDefFileName().
|
pure virtual |
Returns the line number at which the brief description was found.
|
pure virtual |
Used for syntax highlighting symbol class
Implemented in MemberDefAliasImpl, ClassDefAliasImpl, ClassDefImpl, NamespaceDefAliasImpl, FileDefImpl, ConceptDefAliasImpl, MemberDefImpl, NamespaceDefImpl, GroupDefImpl, ModuleDefImpl, DirDefImpl, ConceptDefImpl, and PageDefImpl.
|
pure virtual |
Use this for dynamic inspection of the type of the derived class
Implemented in MemberDefAliasImpl, ClassDefAliasImpl, ClassDefImpl, NamespaceDefAliasImpl, FileDefImpl, ClassDef, DirDef, ConceptDefAliasImpl, FileDef, MemberDefImpl, NamespaceDefImpl, GroupDefImpl, ModuleDefImpl, NamespaceDef, GroupDef, MemberDef, DirDefImpl, ConceptDefImpl, PageDefImpl, PageDef, and ConceptDef.
|
pure virtual |
Returns the name of the definition as it appears in the output
Implemented in MemberDefAliasImpl, ClassDefAliasImpl, MemberDef, MemberDefImpl, ClassDefImpl, NamespaceDefAliasImpl, ClassDef, FileDefImpl, ConceptDefAliasImpl, DirDef, FileDef, NamespaceDefImpl, NamespaceDef, GroupDefImpl, ModuleDefImpl, PageDefImpl, GroupDef, PageDef, DirDefImpl, ConceptDefImpl, and ConceptDef.
|
pure virtual |
Returns the file in which the detailed documentation block was found. This can differ from getDefFileName().
|
pure virtual |
Returns the line number at which the detailed documentation was found.
|
pure virtual |
Returns the detailed description of this definition
Implemented in MemberDefAliasImpl, MemberDef, and MemberDefImpl.
Convenience method to return a resolved external link
|
pure virtual |
Returns the file in which the body of this item is located or 0 if no body is available.
|
pure virtual |
returns the column number at which the definition was found
|
pure virtual |
returns the extension of the file in which this definition was found
|
pure virtual |
returns the file in which this definition was found
|
pure virtual |
returns the line number at which the definition was found (can be the declaration)
|
pure virtual |
Returns the last line of the body of this item (applicable to classes and functions).
|
pure virtual |
Returns the programming language this definition was written in.
|
pure virtual |
Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.
Implemented in MemberDefAliasImpl, ClassDefAliasImpl, ClassDefImpl, NamespaceDefAliasImpl, FileDefImpl, ClassDef, DirDef, ConceptDefAliasImpl, FileDef, MemberDefImpl, MemberDef, NamespaceDefImpl, GroupDefImpl, ModuleDefImpl, NamespaceDef, GroupDef, DirDefImpl, ConceptDefImpl, PageDefImpl, PageDef, and ConceptDef.
|
pure virtual |
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
Implemented in MemberDefAliasImpl, ClassDefAliasImpl, ClassDefImpl, ClassDef, ConceptDefAliasImpl, MemberDefImpl, and MemberDef.
|
pure virtual |
Returns the anchor of the source listing of this definition.
|
pure virtual |
Returns the name of the source listing of this definition.
Implemented in ClassDefAliasImpl, ClassDefImpl, FileDefImpl, ClassDef, and FileDef.
|
pure virtual |
Returns the first line of the body of this item (applicable to classes and functions).
|
pure virtual |
Returns the first line of the implementation of this item. See also getDefLine()
|
pure virtual |
Returns TRUE iff the definition is documented (which could be generated documentation)
Implemented in MemberDefAliasImpl, ClassDefAliasImpl, ClassDefImpl, MemberDef, MemberDefImpl, and ClassDef.
|
pure virtual |
Returns TRUE iff the definition is documented by the user.
|
pure virtual |
Returns the documentation found inside the body of a member
|
pure virtual |
Returns the file in which the in body documentation was found
|
pure virtual |
Returns the line at which the first in body documentation part was found
|
pure virtual |
Returns TRUE if this is an alias of another definition
|
pure virtual |
Returns TRUE iff this definition has an artificially generated name (typically starting with a @) that is used for nameless definitions
|
pure virtual |
Returns TRUE if this entity was artificially introduced, for instance because it is used to show a template instantiation relation.
|
pure virtual |
Returns TRUE iff this entity was exported from a C++20 module.
|
pure virtual |
Returns TRUE iff this item is supposed to be hidden from the output.
|
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.
Implemented in MemberDefAliasImpl, ClassDefAliasImpl, ClassDefImpl, NamespaceDefAliasImpl, MemberDef, ClassDef, MemberDefImpl, FileDefImpl, FileDef, ConceptDefAliasImpl, DirDef, NamespaceDefImpl, GroupDefImpl, GroupDef, NamespaceDef, ModuleDefImpl, ConceptDefImpl, DirDefImpl, PageDefImpl, ConceptDef, and PageDef.
|
pure virtual |
Returns TRUE iff it is possible to link to this item within this project.
Implemented in MemberDefAliasImpl, ClassDefAliasImpl, ClassDefImpl, NamespaceDefAliasImpl, MemberDef, ClassDef, MemberDefImpl, FileDefImpl, FileDef, ConceptDefAliasImpl, DirDef, NamespaceDefImpl, GroupDefImpl, GroupDef, NamespaceDef, ModuleDefImpl, ConceptDefImpl, DirDefImpl, PageDefImpl, ConceptDef, and PageDef.
|
pure virtual |
Returns TRUE if this definition is imported via a tag file.
Implemented in MemberDefAliasImpl, ClassDefAliasImpl, MemberDef, MemberDefImpl, ClassDefImpl, ClassDef, and ConceptDefAliasImpl.
|
pure virtual |
Returns TRUE iff the name may appear in the output
|
pure virtual |
Returns TRUE iff the name is part of this project and may appear in the output
|
pure virtual |
Returns the local name without any scope qualifiers.
Implemented in NamespaceDefAliasImpl.
|
pure virtual |
Returns the name of the definition
Implemented in MemberDefAliasImpl, FileDefImpl, and FileDef.
|
pure virtual |
Returns the fully qualified name of this definition
Implemented in MemberDefAliasImpl, MemberDef, MemberDefImpl, and ModuleDefImpl.
|
pure virtual |
Returns the name of this definition as it appears in the symbol map.