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

#include <definition.h>

Inheritance diagram for Definition:

Classes
struct	Cookie

Public Member Functions
	Definition (const char defFileName, int defLine, int defColumn, const char name, const char b=0, const char d=0, bool isSymbol=TRUE)

virtual	~Definition ()

const QCString &	name () const

virtual QCString	displayName (bool includeScope=TRUE) const =0

QCString	localName () const

virtual QCString	qualifiedName () const

QCString	symbolName () const

virtual QCString	getOutputFileBase () const =0

virtual QCString	anchor () const =0

virtual QCString	getSourceFileBase () const

virtual QCString	getSourceAnchor () const

virtual QCString	documentation () const

int	docLine () const

QCString	docFile () const

virtual QCString	briefDescription (bool abbreviate=FALSE) const

QCString	briefDescriptionAsTooltip () const

int	briefLine () const

QCString	inbodyDocumentation () const

QCString	inbodyFile () const

int	inbodyLine () const

QCString	briefFile () const

QCString	getDefFileName () const

QCString	getDefFileExtension () const

int	getDefLine () const

int	getDefColumn () const

virtual bool	hasDocumentation () const

virtual bool	hasUserDocumentation () const

virtual bool	isLinkableInProject () const =0

virtual bool	isLinkable () const =0

virtual bool	isVisibleInProject () const

virtual bool	isVisible () const

bool	isHidden () const

bool	isArtificial () const

virtual QCString	getReference () const

virtual bool	isReference () const

QCString	externalReference (const QCString &relPath) const

int	getStartBodyLine () const

int	getEndBodyLine () const

FileDef *	getBodyDef () const

SrcLangExt	getLanguage () const
	Returns the programming language this definition was written in. More...

GroupList *	partOfGroups () const

bool	isLinkableViaGroup () const

QList< ListItemInfo > *	xrefListItems () const

virtual Definition *	findInnerCompound (const char *name)

virtual Definition *	getOuterScope () const

MemberSDict *	getReferencesMembers () const

MemberSDict *	getReferencedByMembers () const

bool	hasSections () const

bool	hasSources () const

bool	hasBriefDescription () const
	returns TRUE if this class has a brief description

QCString	id () const

virtual void	setName (const char *name)

void	setId (const char *name)

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

virtual void	setBriefDescription (const char b, const char briefFile, int briefLine)

virtual void	setInbodyDocumentation (const char d, const char docFile, int docLine)

void	setReference (const char *r)

void	addSectionsToDefinition (QList< SectionInfo > *anchorList)

void	setBodySegment (int bls, int ble)

void	setBodyDef (FileDef *fd)

void	addSourceReferencedBy (MemberDef *d)

void	addSourceReferences (MemberDef *d)

void	setRefItems (const QList< ListItemInfo > *sli)

void	mergeRefItems (Definition *d)

virtual void	addInnerCompound (Definition *d)

virtual void	setOuterScope (Definition *d)

virtual void	setHidden (bool b)

void	setArtificial (bool b)

void	setLanguage (SrcLangExt lang)

void	writeSourceDef (OutputList &ol, const char *scopeName)

void	writeInlineCode (OutputList &ol, const char *scopeName)

void	writeSourceRefs (OutputList &ol, const char *scopeName)

void	writeSourceReffedBy (OutputList &ol, const char *scopeName)

void	makePartOfGroup (GroupDef *gd)

void	writeNavigationPath (OutputList &ol) const

QCString	navigationPathAsString () const

virtual void	writeQuickMemberLinks (OutputList &, MemberDef *) const

virtual void	writeSummaryLinks (OutputList &)

QCString	pathFragment () const

void	writeDocAnchorsToTagFile (FTextStream &)

void	setLocalName (const QCString name)

void	addSectionsToIndex ()

void	writeToc (OutputList &ol)

void	setCookie (Cookie *cookie)

Cookie *	cookie () const

Public Member Functions inherited from DefinitionIntf
virtual DefType	definitionType () const =0

Protected Member Functions
	Definition (const Definition &d)

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.

Constructor & Destructor Documentation

§ Definition()

Definition::Definition	(	const char *	defFileName,
		int	defLine,
		int	defColumn,
		const char *	name,
		const char *	b = `0`,
		const char *	d = `0`,
		bool	isSymbol = `TRUE`
	)

Create a new definition

§ ~Definition()

Definition::~Definition ( )

virtual

Destroys the definition

Member Function Documentation

§ addSectionsToDefinition()

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

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

§ anchor()

virtual QCString Definition::anchor ( ) const

pure virtual

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

Implemented in ClassDef, FileDef, MemberDef, DirDef, GroupDef, PageDef, and NamespaceDef.

§ briefDescription()

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

virtual

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

Reimplemented in MemberDef.

§ briefDescriptionAsTooltip()

QCString Definition::briefDescriptionAsTooltip ( ) const

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

§ briefFile()

QCString Definition::briefFile ( ) const

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

§ briefLine()

int Definition::briefLine ( ) const

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

§ displayName()

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

pure virtual

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

Implemented in MemberDef, ClassDef, FileDef, NamespaceDef, PageDef, DirDef, and GroupDef.

§ docFile()

QCString Definition::docFile ( ) const

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

§ docLine()

int Definition::docLine ( ) const

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

§ documentation()

QCString Definition::documentation ( ) const

virtual

Returns the detailed description of this definition

Reimplemented in MemberDef.

§ externalReference()

QCString Definition::externalReference ( const QCString & relPath ) const

Convenience method to return a resolved external link

§ getBodyDef()

FileDef * Definition::getBodyDef ( ) const

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

§ getDefColumn()

int Definition::getDefColumn ( ) const

inline

returns the column number at which the definition was found

§ getDefFileExtension()

QCString Definition::getDefFileExtension ( ) const

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

§ getDefFileName()

QCString Definition::getDefFileName ( ) const

returns the file in which this definition was found

§ getDefLine()

int Definition::getDefLine ( ) const

inline

returns the line number at which the definition was found

§ getEndBodyLine()

int Definition::getEndBodyLine ( ) const

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

§ getLanguage()

SrcLangExt Definition::getLanguage ( ) const

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 ClassDef, FileDef, MemberDef, DirDef, GroupDef, PageDef, and NamespaceDef.

§ getReference()

QCString Definition::getReference ( ) const

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

Reimplemented in ClassDef, and MemberDef.

§ getSourceAnchor()

QCString Definition::getSourceAnchor ( ) const

virtual

Returns the anchor of the source listing of this definition.

§ getSourceFileBase()

QCString Definition::getSourceFileBase ( ) const

virtual

Returns the name of the source listing of this definition.

Reimplemented in ClassDef, and FileDef.

§ getStartBodyLine()

int Definition::getStartBodyLine ( ) const

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

§ hasDocumentation()

bool Definition::hasDocumentation ( ) const

virtual

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

See also: hasUserDocumentation()

Reimplemented in MemberDef, and ClassDef.

§ hasUserDocumentation()

bool Definition::hasUserDocumentation ( ) const

virtual

Returns TRUE iff the definition is documented by the user.

§ inbodyDocumentation()

QCString Definition::inbodyDocumentation ( ) const

Returns the documentation found inside the body of a member

§ inbodyFile()

QCString Definition::inbodyFile ( ) const

Returns the file in which the in body documentation was found

§ inbodyLine()

int Definition::inbodyLine ( ) const

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

§ isArtificial()

bool Definition::isArtificial ( ) const

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

§ isHidden()

bool Definition::isHidden ( ) const

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 MemberDef, ClassDef, FileDef, NamespaceDef, GroupDef, DirDef, and PageDef.

§ isLinkableInProject()

virtual bool Definition::isLinkableInProject ( ) const

pure virtual

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

Implemented in MemberDef, ClassDef, FileDef, NamespaceDef, GroupDef, DirDef, and PageDef.

§ isReference()

bool Definition::isReference ( ) const

virtual

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

Reimplemented in MemberDef, and ClassDef.

§ isVisible()

bool Definition::isVisible ( ) const

virtual

Returns TRUE iff the name may appear in the output

§ isVisibleInProject()

bool Definition::isVisibleInProject ( ) const

virtual

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

§ localName()

QCString Definition::localName ( ) const

Returns the local name without any scope qualifiers.

§ name()

const QCString& Definition::name ( ) const

inline

Returns the name of the definition

§ navigationPathAsString()

QCString Definition::navigationPathAsString ( ) const

Returns the string used in the footer for $navpath when GENERATE_TREEVIEW is enabled

§ qualifiedName()

QCString Definition::qualifiedName ( ) const

virtual

Returns the fully qualified name of this definition

Reimplemented in MemberDef.

§ setBriefDescription()

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

virtual

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

Reimplemented in MemberDef.

§ setDocumentation()

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

virtual

Sets the documentation of this definition to d.

Reimplemented in MemberDef.

§ setId()

void Definition::setId ( const char * name )

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

§ setInbodyDocumentation()

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

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.

Reimplemented in MemberDef.

§ setName()

void Definition::setName ( const char * name )

virtual

Sets a new name for the definition

Reimplemented in ClassDef.

§ setReference()

void Definition::setReference ( const char * r )

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

§ symbolName()

QCString Definition::symbolName ( ) const

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

§ writeDocAnchorsToTagFile()

void Definition::writeDocAnchorsToTagFile ( FTextStream & tagFile )

Writes the documentation anchors of the definition to the Doxygen::tagFile stream.

§ writeInlineCode()

void Definition::writeInlineCode	(	OutputList &	ol,
		const char *	scopeName
	)

Write code of this definition into the documentation

§ writeSourceDef()

void Definition::writeSourceDef	(	OutputList &	ol,
		const char *	scopeName
	)

Write a reference to the source code defining this definition

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

src/definition.h
src/definition.cpp

Classes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ Definition()

§ ~Definition()

Member Function Documentation

§ addSectionsToDefinition()

§ anchor()

§ briefDescription()

§ briefDescriptionAsTooltip()

§ briefFile()

§ briefLine()

§ displayName()

§ docFile()

§ docLine()

§ documentation()

§ externalReference()

§ getBodyDef()

§ getDefColumn()

§ getDefFileExtension()

§ getDefFileName()

§ getDefLine()

§ getEndBodyLine()

§ getLanguage()

§ getOutputFileBase()

§ getReference()

§ getSourceAnchor()

§ getSourceFileBase()

§ getStartBodyLine()

§ hasDocumentation()

§ hasUserDocumentation()

§ inbodyDocumentation()

§ inbodyFile()

§ inbodyLine()

§ isArtificial()

§ isHidden()

§ isLinkable()

§ isLinkableInProject()

§ isReference()

§ isVisible()

§ isVisibleInProject()

§ localName()

§ name()

§ navigationPathAsString()

§ qualifiedName()

§ setBriefDescription()

§ setDocumentation()

§ setId()

§ setInbodyDocumentation()

§ setName()

§ setReference()

§ symbolName()

§ writeDocAnchorsToTagFile()

§ writeInlineCode()

§ writeSourceDef()