doxygen
Classes | Public Types | Public Member Functions | Friends | List of all members
Definition Class Referenceabstract

The common base class of all entity definitions found in the sources. More...

#include <definition.h>

Inheritance diagram for Definition:
Inheritance graph
[legend]

Classes

struct  Cookie
 

Public Types

enum  DefType {
  TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3,
  TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7
}
 

Public Member Functions

virtual DefType definitionType () const =0
 
virtual bool isAlias () const =0
 
virtual QCString name () const =0
 
virtual bool isAnonymous () const =0
 
virtual QCString displayName (bool includeScope=TRUE) const =0
 
virtual 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 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 FileDefgetBodyDef () const =0
 
virtual SrcLangExt getLanguage () const =0
 Returns the programming language this definition was written in. More...
 
virtual const GroupListpartOfGroups () const =0
 
virtual bool isLinkableViaGroup () const =0
 
virtual const RefItemVector & xrefListItems () const =0
 
virtual const DefinitionfindInnerCompound (const char *name) const =0
 
virtual DefinitiongetOuterScope () const =0
 
virtual std::vector< const MemberDef * > getReferencesMembers () const =0
 
virtual std::vector< const MemberDef * > 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 SectionRefsgetSectionRefs () const =0
 returns the section dictionary, only of importance for pagedef
 
virtual QCString navigationPathAsString () const =0
 
virtual QCString pathFragment () const =0
 
virtual void setCookie (Cookie *cookie) const =0
 
virtual Cookiecookie () const =0
 
virtual void _setSymbolName (const QCString &name)=0
 
virtual QCString _symbolName () const =0
 

Friends

class DefinitionImpl
 
DefinitionMutabletoDefinitionMutable (Definition *)
 
DefinitionMutabletoDefinitionMutable (const Definition *)
 

Detailed Description

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.

Member Enumeration Documentation

◆ DefType

Types of derived classes

Member Function Documentation

◆ anchor()

virtual QCString Definition::anchor ( ) const
pure virtual

◆ briefDescription()

virtual QCString Definition::briefDescription ( bool  abbreviate = FALSE) const
pure virtual

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

Implemented in MemberDefAliasImpl, MemberDef, and MemberDefImpl.

◆ briefDescriptionAsTooltip()

virtual QCString Definition::briefDescriptionAsTooltip ( ) const
pure virtual

Returns a plain text version of the brief description suitable for use as a tool tip.

◆ briefFile()

virtual QCString Definition::briefFile ( ) const
pure virtual

Returns the file in which the brief description was found. This can differ from getDefFileName().

◆ briefLine()

virtual int Definition::briefLine ( ) const
pure virtual

Returns the line number at which the brief description was found.

◆ definitionType()

virtual DefType Definition::definitionType ( ) const
pure virtual

◆ displayName()

virtual QCString Definition::displayName ( bool  includeScope = TRUE) const
pure virtual

◆ docFile()

virtual QCString Definition::docFile ( ) const
pure virtual

Returns the file in which the detailed documentation block was found. This can differ from getDefFileName().

◆ docLine()

virtual int Definition::docLine ( ) const
pure virtual

Returns the line number at which the detailed documentation was found.

◆ documentation()

virtual QCString Definition::documentation ( ) const
pure virtual

Returns the detailed description of this definition

Implemented in MemberDefAliasImpl, MemberDef, and MemberDefImpl.

◆ externalReference()

virtual QCString Definition::externalReference ( const QCString relPath) const
pure virtual

Convenience method to return a resolved external link

◆ getBodyDef()

virtual FileDef* Definition::getBodyDef ( ) const
pure virtual

Returns the file in which the body of this item is located or 0 if no body is available.

◆ getDefColumn()

virtual int Definition::getDefColumn ( ) const
pure virtual

returns the column number at which the definition was found

◆ getDefFileExtension()

virtual QCString Definition::getDefFileExtension ( ) const
pure virtual

returns the extension of the file in which this definition was found

◆ getDefFileName()

virtual QCString Definition::getDefFileName ( ) const
pure virtual

returns the file in which this definition was found

◆ getDefLine()

virtual int Definition::getDefLine ( ) const
pure virtual

returns the line number at which the definition was found (can be the declaration)

◆ getEndBodyLine()

virtual int Definition::getEndBodyLine ( ) const
pure virtual

Returns the last line of the body of this item (applicable to classes and functions).

◆ getLanguage()

virtual SrcLangExt Definition::getLanguage ( ) const
pure virtual

Returns the programming language this definition was written in.

◆ getOutputFileBase()

virtual QCString Definition::getOutputFileBase ( ) const
pure virtual

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

Implemented in MemberDefAliasImpl, ClassDefAliasImpl, NamespaceDefAliasImpl, ClassDefImpl, ClassDef, DirDef, FileDef, FileDefImpl, MemberDefImpl, MemberDef, NamespaceDef, NamespaceDefImpl, GroupDefImpl, GroupDef, DirDefImpl, PageDefImpl, and PageDef.

◆ getReference()

virtual QCString Definition::getReference ( ) const
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, MemberDefImpl, and MemberDef.

◆ getSourceAnchor()

virtual QCString Definition::getSourceAnchor ( ) const
pure virtual

Returns the anchor of the source listing of this definition.

◆ getSourceFileBase()

virtual QCString Definition::getSourceFileBase ( ) const
pure virtual

Returns the name of the source listing of this definition.

Implemented in ClassDefAliasImpl, ClassDefImpl, ClassDef, FileDef, and FileDefImpl.

◆ getStartBodyLine()

virtual int Definition::getStartBodyLine ( ) const
pure virtual

Returns the first line of the body of this item (applicable to classes and functions).

◆ getStartDefLine()

virtual int Definition::getStartDefLine ( ) const
pure virtual

Returns the first line of the implementation of this item. See also getDefLine()

◆ hasDocumentation()

virtual bool Definition::hasDocumentation ( ) const
pure virtual

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

See also
hasUserDocumentation()

Implemented in MemberDefAliasImpl, ClassDefAliasImpl, MemberDef, MemberDefImpl, ClassDefImpl, and ClassDef.

◆ hasUserDocumentation()

virtual bool Definition::hasUserDocumentation ( ) const
pure virtual

Returns TRUE iff the definition is documented by the user.

◆ inbodyDocumentation()

virtual QCString Definition::inbodyDocumentation ( ) const
pure virtual

Returns the documentation found inside the body of a member

◆ inbodyFile()

virtual QCString Definition::inbodyFile ( ) const
pure virtual

Returns the file in which the in body documentation was found

◆ inbodyLine()

virtual int Definition::inbodyLine ( ) const
pure virtual

Returns the line at which the first in body documentation part was found

◆ isAlias()

virtual bool Definition::isAlias ( ) const
pure virtual

Returns TRUE if this is an alias of another definition

◆ isAnonymous()

virtual bool Definition::isAnonymous ( ) const
pure virtual

Returns TRUE iff this definition has an artificially generated name (typically starting with a @) that is used for nameless definitions

◆ isArtificial()

virtual bool Definition::isArtificial ( ) const
pure virtual

returns TRUE if this entity was artificially introduced, for instance because it is used to show a template instantiation relation.

◆ isHidden()

virtual bool Definition::isHidden ( ) const
pure virtual

Returns TRUE iff this item is supposed to be hidden from the output.

◆ isLinkable()

virtual bool Definition::isLinkable ( ) const
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, NamespaceDefAliasImpl, MemberDef, ClassDef, ClassDefImpl, MemberDefImpl, FileDef, DirDef, NamespaceDefImpl, GroupDefImpl, FileDefImpl, GroupDef, NamespaceDef, DirDefImpl, PageDefImpl, and PageDef.

◆ isLinkableInProject()

virtual bool Definition::isLinkableInProject ( ) const
pure virtual

◆ isReference()

virtual bool Definition::isReference ( ) const
pure virtual

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

Implemented in MemberDefAliasImpl, ClassDefAliasImpl, MemberDef, MemberDefImpl, ClassDefImpl, and ClassDef.

◆ isVisible()

virtual bool Definition::isVisible ( ) const
pure virtual

Returns TRUE iff the name may appear in the output

◆ isVisibleInProject()

virtual bool Definition::isVisibleInProject ( ) const
pure virtual

Returns TRUE iff the name is part of this project and may appear in the output

◆ localName()

virtual QCString Definition::localName ( ) const
pure virtual

Returns the local name without any scope qualifiers.

Implemented in NamespaceDefAliasImpl, NamespaceDefImpl, and NamespaceDef.

◆ name()

virtual QCString Definition::name ( ) const
pure virtual

Returns the name of the definition

Implemented in MemberDefAliasImpl, FileDef, and FileDefImpl.

◆ qualifiedName()

virtual QCString Definition::qualifiedName ( ) const
pure virtual

Returns the fully qualified name of this definition

Implemented in MemberDefAliasImpl, MemberDef, and MemberDefImpl.

◆ symbolName()

virtual QCString Definition::symbolName ( ) const
pure virtual

Returns the name of this definition as it appears in the symbol map.


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