doxygen
Classes | Public Member Functions | 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:
DefinitionIntf ClassDef DefinitionAliasImpl DefinitionImpl DirDef FileDef GroupDef MemberDef NamespaceDef PageDef

Classes

struct  Cookie
 

Public Member Functions

virtual bool isAlias () const =0
 
virtual QCString name () 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 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 GroupListpartOfGroups () const =0
 
virtual bool isLinkableViaGroup () const =0
 
virtual QList< ListItemInfo > * xrefListItems () const =0
 
virtual DefinitionfindInnerCompound (const char *name) const =0
 
virtual DefinitiongetOuterScope () const =0
 
virtual MemberSDictgetReferencesMembers () const =0
 
virtual MemberSDictgetReferencedByMembers () 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 SectionDictgetSectionDict () const =0
 returns the section dictionary, only of importance for pagedef
 
virtual QCString navigationPathAsString () const =0
 
virtual QCString pathFragment () const =0
 
virtual void setName (const char *name)=0
 
virtual void setId (const char *name)=0
 
virtual void setDefFile (const QCString &df, int defLine, int defColumn)=0
 
virtual void setDocumentation (const char *d, const char *docFile, int docLine, bool stripWhiteSpace=TRUE)=0
 
virtual void setBriefDescription (const char *b, const char *briefFile, int briefLine)=0
 
virtual void setInbodyDocumentation (const char *d, const char *docFile, int docLine)=0
 
virtual void setReference (const char *r)=0
 
virtual void setBodySegment (int bls, int ble)=0
 
virtual void setBodyDef (FileDef *fd)=0
 
virtual void setRefItems (const QList< ListItemInfo > *sli)=0
 
virtual void setOuterScope (Definition *d)=0
 
virtual void setHidden (bool b)=0
 
virtual void setArtificial (bool b)=0
 
virtual void setLanguage (SrcLangExt lang)=0
 
virtual void setLocalName (const QCString name)=0
 
virtual void makePartOfGroup (GroupDef *gd)=0
 
virtual void addSectionsToDefinition (QList< SectionInfo > *anchorList)=0
 
virtual void addSourceReferencedBy (const MemberDef *d)=0
 
virtual void addSourceReferences (const MemberDef *d)=0
 
virtual void mergeRefItems (Definition *d)=0
 
virtual void addInnerCompound (const Definition *d)=0
 
virtual void addSectionsToIndex ()=0
 
virtual void writeSourceDef (OutputList &ol, const char *scopeName) const =0
 
virtual void writeInlineCode (OutputList &ol, const char *scopeName) const =0
 
virtual void writeSourceRefs (OutputList &ol, const char *scopeName) const =0
 
virtual void writeSourceReffedBy (OutputList &ol, const char *scopeName) const =0
 
virtual void writeNavigationPath (OutputList &ol) const =0
 
virtual void writeQuickMemberLinks (OutputList &, const MemberDef *) const =0
 
virtual void writeSummaryLinks (OutputList &) const =0
 
virtual void writeDocAnchorsToTagFile (FTextStream &) const =0
 
virtual void writeToc (OutputList &ol, const LocalToc &lt) 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
 
- Public Member Functions inherited from DefinitionIntf
virtual DefType definitionType () const =0
 

Additional Inherited Members

- Public Types inherited from DefinitionIntf
enum  DefType {
  TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3,
  TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7,
  TypeSymbolList = 8
}
 

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 Function Documentation

§ addSectionsToDefinition()

virtual void Definition::addSectionsToDefinition ( QList< SectionInfo > *  anchorList)
pure virtual

Add the list of anchors that mark the sections that are found in the documentation.

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ 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, MemberDefImpl, DefinitionAliasImpl, and DefinitionImpl.

§ briefDescriptionAsTooltip()

virtual QCString Definition::briefDescriptionAsTooltip ( ) const
pure virtual

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

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ briefFile()

virtual QCString Definition::briefFile ( ) const
pure virtual

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

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ briefLine()

virtual int Definition::briefLine ( ) const
pure virtual

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

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ 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().

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ docLine()

virtual int Definition::docLine ( ) const
pure virtual

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

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ documentation()

virtual QCString Definition::documentation ( ) const
pure virtual

Returns the detailed description of this definition

Implemented in MemberDefAliasImpl, MemberDef, MemberDefImpl, DefinitionAliasImpl, and DefinitionImpl.

§ externalReference()

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

Convenience method to return a resolved external link

Implemented in DefinitionAliasImpl, and DefinitionImpl.

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

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ getDefColumn()

virtual int Definition::getDefColumn ( ) const
pure virtual

returns the column number at which the definition was found

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ getDefFileExtension()

virtual QCString Definition::getDefFileExtension ( ) const
pure virtual

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

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ getDefFileName()

virtual QCString Definition::getDefFileName ( ) const
pure virtual

returns the file in which this definition was found

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ getDefLine()

virtual int Definition::getDefLine ( ) const
pure virtual

returns the line number at which the definition was found

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ getEndBodyLine()

virtual int Definition::getEndBodyLine ( ) const
pure virtual

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

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ getLanguage()

virtual SrcLangExt Definition::getLanguage ( ) const
pure virtual

Returns the programming language this definition was written in.

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ 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, ClassDef, FileDef, ClassDefImpl, MemberDefImpl, FileDefImpl, MemberDef, GroupDefImpl, DirDef, GroupDef, NamespaceDefImpl, PageDefImpl, PageDef, NamespaceDef, and DirDefImpl.

§ 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, DefinitionAliasImpl, ClassDef, ClassDefImpl, MemberDefImpl, DefinitionImpl, and MemberDef.

§ getSourceAnchor()

virtual QCString Definition::getSourceAnchor ( ) const
pure virtual

Returns the anchor of the source listing of this definition.

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ getSourceFileBase()

virtual QCString Definition::getSourceFileBase ( ) const
pure virtual

Returns the name of the source listing of this definition.

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

§ getStartBodyLine()

virtual int Definition::getStartBodyLine ( ) const
pure virtual

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

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ 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, DefinitionAliasImpl, ClassDef, ClassDefImpl, and DefinitionImpl.

§ hasUserDocumentation()

virtual bool Definition::hasUserDocumentation ( ) const
pure virtual

Returns TRUE iff the definition is documented by the user.

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ inbodyDocumentation()

virtual QCString Definition::inbodyDocumentation ( ) const
pure virtual

Returns the documentation found inside the body of a member

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ inbodyFile()

virtual QCString Definition::inbodyFile ( ) const
pure virtual

Returns the file in which the in body documentation was found

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ inbodyLine()

virtual int Definition::inbodyLine ( ) const
pure virtual

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

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ isAlias()

virtual bool Definition::isAlias ( ) const
pure virtual

Returns TRUE if this is an alias of another definition

Implemented in DefinitionAliasImpl, and DefinitionImpl.

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

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ isHidden()

virtual bool Definition::isHidden ( ) const
pure virtual

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

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ 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, MemberDef, NamespaceDefAliasImpl, MemberDefImpl, ClassDef, FileDef, ClassDefImpl, GroupDefImpl, FileDefImpl, GroupDef, NamespaceDefImpl, NamespaceDef, DirDef, PageDefImpl, PageDef, and DirDefImpl.

§ 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, DefinitionAliasImpl, ClassDef, ClassDefImpl, and DefinitionImpl.

§ isVisible()

virtual bool Definition::isVisible ( ) const
pure virtual

Returns TRUE iff the name may appear in the output

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ isVisibleInProject()

virtual bool Definition::isVisibleInProject ( ) const
pure virtual

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

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ localName()

virtual QCString Definition::localName ( ) const
pure virtual

Returns the local name without any scope qualifiers.

Implemented in NamespaceDefAliasImpl, DefinitionAliasImpl, NamespaceDefImpl, NamespaceDef, and DefinitionImpl.

§ name()

virtual QCString Definition::name ( ) const
pure virtual

Returns the name of the definition

Implemented in DefinitionAliasImpl, FileDef, FileDefImpl, and DefinitionImpl.

§ qualifiedName()

virtual QCString Definition::qualifiedName ( ) const
pure virtual

Returns the fully qualified name of this definition

Implemented in MemberDefAliasImpl, DefinitionAliasImpl, MemberDef, MemberDefImpl, and DefinitionImpl.

§ setBriefDescription()

virtual void Definition::setBriefDescription ( const char *  b,
const char *  briefFile,
int  briefLine 
)
pure virtual

Sets the brief description of this definition to b. A dot is added to the sentence if not available.

Implemented in MemberDefAliasImpl, MemberDef, MemberDefImpl, DefinitionAliasImpl, and DefinitionImpl.

§ setDefFile()

virtual void Definition::setDefFile ( const QCString df,
int  defLine,
int  defColumn 
)
pure virtual

Set a new file name and position

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ setDocumentation()

virtual void Definition::setDocumentation ( const char *  d,
const char *  docFile,
int  docLine,
bool  stripWhiteSpace = TRUE 
)
pure virtual

Sets the documentation of this definition to d.

Implemented in MemberDefAliasImpl, MemberDef, MemberDefImpl, DefinitionAliasImpl, and DefinitionImpl.

§ setId()

virtual void Definition::setId ( const char *  name)
pure virtual

Sets a unique id for the symbol. Used for libclang integration.

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ setInbodyDocumentation()

virtual void Definition::setInbodyDocumentation ( const char *  d,
const char *  docFile,
int  docLine 
)
pure virtual

Set the documentation that was found inside the body of an item. If there was already some documentation set, the new documentation will be appended.

Implemented in MemberDefAliasImpl, MemberDef, MemberDefImpl, DefinitionAliasImpl, and DefinitionImpl.

§ setName()

virtual void Definition::setName ( const char *  name)
pure virtual

Sets a new name for the definition

Implemented in ClassDefAliasImpl, ClassDef, DefinitionAliasImpl, ClassDefImpl, and DefinitionImpl.

§ setReference()

virtual void Definition::setReference ( const char *  r)
pure virtual

Sets the tag file id via which this definition was imported.

Implemented in DefinitionAliasImpl, and DefinitionImpl.

§ symbolName()

virtual QCString Definition::symbolName ( ) const
pure virtual

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

Implemented in DefinitionAliasImpl, and DefinitionImpl.


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