A model of a directory symbol. 更多...

#include <dirdef.h>

类 DirDef 继承关系图:

DirDef 的协作图:

类
class	UsedDirLinkedMap

Public 成员函数
virtual	~DirDef ()

virtual DefType	definitionType () const =0

virtual QCString	getOutputFileBase () const =0

virtual QCString	anchor () const =0

virtual bool	isLinkableInProject () const =0

virtual bool	isLinkable () const =0

virtual QCString	displayName (bool=TRUE) const =0

virtual const QCString	shortName () const =0

virtual void	addSubDir (DirDef *subdir)=0

virtual const FileList &	getFiles () const =0

virtual void	addFile (const FileDef *fd)=0

virtual const DirList &	subDirs () const =0

virtual bool	hasSubdirs () const =0

virtual int	level () const =0

virtual DirDef *	parent () const =0

virtual int	dirCount () const =0

virtual const UsedDirLinkedMap &	usedDirs () const =0

virtual bool	isParentOf (const DirDef *dir) const =0

virtual bool	depGraphIsTrivial () const =0

virtual QCString	shortTitle () const =0

virtual bool	hasDetailedDescription () const =0

virtual void	writeDocumentation (OutputList &ol)=0

virtual void	writeTagFile (TextStream &t)=0

virtual void	setDiskName (const QCString &name)=0

virtual void	setDirCount (int count)=0

virtual void	sort ()=0

virtual void	setParent (DirDef *parent)=0

virtual void	setLevel ()=0

virtual void	addUsesDependency (const DirDef usedDir, const FileDef srcFd, const FileDef *dstFd, bool srcDirect, bool dstDirect)=0

virtual void	computeDependencies ()=0

Public 成员函数继承自 DefinitionMutable
virtual void	setName (const QCString &name)=0

virtual void	setId (const QCString &name)=0

virtual void	setDefFile (const QCString &df, int defLine, int defColumn)=0

virtual void	setDocumentation (const QCString &d, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)=0

virtual void	setBriefDescription (const QCString &b, const QCString &briefFile, int briefLine)=0

virtual void	setInbodyDocumentation (const QCString &d, const QCString &docFile, int docLine)=0

virtual void	setReference (const QCString &r)=0

virtual void	setBodySegment (int defLine, int bls, int ble)=0

virtual void	setBodyDef (const FileDef *fd)=0

virtual void	setRefItems (const RefItemVector &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 (const GroupDef *gd)=0

virtual void	addSectionsToDefinition (const std::vector< const 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	mergeReferences (const Definition *other)=0

virtual void	mergeReferencedBy (const Definition *other)=0

virtual void	computeTooltip ()=0

virtual void	writeSourceDef (OutputList &ol, const QCString &scopeName) const =0

virtual void	writeInlineCode (OutputList &ol, const QCString &scopeName) const =0

virtual bool	hasSourceRefs () const =0

virtual bool	hasSourceReffedBy () const =0

virtual void	writeSourceRefs (OutputList &ol, const QCString &scopeName) const =0

virtual void	writeSourceReffedBy (OutputList &ol, const QCString &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 (TextStream &) const =0

virtual void	writeToc (OutputList &ol, const LocalToc &lt) const =0

virtual	~DefinitionMutable ()=default

Public 成员函数继承自 Definition
virtual CodeSymbolType	codeSymbolType () const =0

virtual bool	isAlias () const =0

virtual QCString	name () const =0

virtual bool	isAnonymous () const =0

virtual 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. 更多...

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

virtual	~Definition ()=default

额外继承的成员函数
Public 类型继承自 Definition
enum	DefType { TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3, TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7, TypeConcept = 8 }

详细描述

A model of a directory symbol.

在文件 dirdef.h 第 110 行定义.

构造及析构函数说明

◆ ~DirDef()

virtual DirDef::~DirDef ( )

inlinevirtual

在文件 dirdef.h 第 113 行定义.

113 {}

成员函数说明

◆ addFile()

virtual void DirDef::addFile ( const FileDef * fd )

pure virtual

在 DirDefImpl 内被实现.

被这些函数引用 buildDirectories().

◆ addSubDir()

virtual void DirDef::addSubDir ( DirDef * subdir )

pure virtual

在 DirDefImpl 内被实现.

被这些函数引用 buildDirectories().

◆ addUsesDependency()

virtual void DirDef::addUsesDependency	(	const DirDef *	usedDir,
		const FileDef *	srcFd,
		const FileDef *	dstFd,
		bool	srcDirect,
		bool	dstDirect
	)

pure virtual

在 DirDefImpl 内被实现.

被这些函数引用 DirDefImpl::addUsesDependency().

◆ anchor()

virtual QCString DirDef::anchor ( ) const

pure virtual

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

实现了 Definition.

在 DirDefImpl 内被实现.

◆ computeDependencies()

virtual void DirDef::computeDependencies ( )

pure virtual

在 DirDefImpl 内被实现.

◆ definitionType()

virtual DefType DirDef::definitionType ( ) const

pure virtual

Use this for dynamic inspection of the type of the derived class

实现了 Definition.

在 DirDefImpl 内被实现.

◆ depGraphIsTrivial()

virtual bool DirDef::depGraphIsTrivial ( ) const

pure virtual

在 DirDefImpl 内被实现.

被这些函数引用 DotDirDeps::isTrivial().

◆ dirCount()

virtual int DirDef::dirCount ( ) const

pure virtual

在 DirDefImpl 内被实现.

被这些函数引用 addDependencies().

◆ displayName()

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

pure virtual

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

实现了 Definition.

在 DirDefImpl 内被实现.

被这些函数引用 DotDirDeps::computeTheGraph(), generateXMLForDir(), DotDirDeps::getImgAltText() , 以及 DirRelation::writeDocumentation().

◆ getFiles()

virtual const FileList& DirDef::getFiles ( ) const

pure virtual

在 DirDefImpl 内被实现.

被这些函数引用 NestingNodeContext::Private::addDirFiles(), DirContext::Private::createFiles(), dirHasVisibleChildren(), generateXMLForDir() , 以及 writeDirTreeNode().

◆ getOutputFileBase()

virtual QCString DirDef::getOutputFileBase ( ) const

pure virtual

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

实现了 Definition.

在 DirDefImpl 内被实现.

被这些函数引用 DirDefImpl::addUsesDependency(), DirContext::Private::dirGraph(), drawClusterOpening(), drawDirectory(), generateXMLForDir(), DotDirDeps::getBaseName(), writeDirTreeNode(), DirRelation::writeDocumentation(), writeDotDirDepGraph() , 以及 writePartialDirPath().

◆ hasDetailedDescription()

virtual bool DirDef::hasDetailedDescription ( ) const

pure virtual

在 DirDefImpl 内被实现.

被这些函数引用 DirContext::Private::hasDetails().

◆ hasSubdirs()

virtual bool DirDef::hasSubdirs ( ) const

pure virtual

在 DirDefImpl 内被实现.

被这些函数引用 drawTree().

◆ isLinkable()

virtual bool DirDef::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.

实现了 Definition.

在 DirDefImpl 内被实现.

被这些函数引用 resolveLink().

◆ isLinkableInProject()

virtual bool DirDef::isLinkableInProject ( ) const

pure virtual

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

实现了 Definition.

在 DirDefImpl 内被实现.

◆ isParentOf()

virtual bool DirDef::isParentOf ( const DirDef * dir ) const

pure virtual

在 DirDefImpl 内被实现.

◆ level()

virtual int DirDef::level ( ) const

pure virtual

在 DirDefImpl 内被实现.

被这些函数引用 drawClusterOpening(), drawDirectory(), isAtMaxDepth() , 以及 DirDefImpl::setLevel().

◆ parent()

virtual DirDef* DirDef::parent ( ) const

pure virtual

在 DirDefImpl 内被实现.

被这些函数引用 DirDefImpl::addUsesDependency(), DirDefImpl::isParentOf(), writeDotDirDepGraph() , 以及 writePartialDirPath().

◆ setDirCount()

virtual void DirDef::setDirCount ( int count )

pure virtual

在 DirDefImpl 内被实现.

◆ setDiskName()

virtual void DirDef::setDiskName ( const QCString & name )

pure virtual

在 DirDefImpl 内被实现.

◆ setLevel()

virtual void DirDef::setLevel ( )

pure virtual

在 DirDefImpl 内被实现.

被这些函数引用 DirDefImpl::setLevel().

◆ setParent()

virtual void DirDef::setParent ( DirDef * parent )

pure virtual

在 DirDefImpl 内被实现.

被这些函数引用 DirDefImpl::addSubDir().

◆ shortName()

virtual const QCString DirDef::shortName ( ) const

pure virtual

在 DirDefImpl 内被实现.

被这些函数引用 compareDirDefs(), DirContext::Private::dirName(), drawClusterOpening(), drawDirectory(), writeDirTreeNode(), DirRelation::writeDocumentation() , 以及 writePartialDirPath().

◆ shortTitle()

virtual QCString DirDef::shortTitle ( ) const

pure virtual

在 DirDefImpl 内被实现.

被这些函数引用 DirContext::Private::title().

◆ sort()

virtual void DirDef::sort ( )

pure virtual

在 DirDefImpl 内被实现.

◆ subDirs()

virtual const DirList& DirDef::subDirs ( ) const

pure virtual

在 DirDefImpl 内被实现.

被这些函数引用 NestingNodeContext::Private::addDirFiles(), DirContext::Private::createDirs(), dirHasVisibleChildren(), drawTree(), generateXMLForDir() , 以及 writeDirTreeNode().

◆ usedDirs()

virtual const UsedDirLinkedMap& DirDef::usedDirs ( ) const

pure virtual

在 DirDefImpl 内被实现.

被这些函数引用 addDependencies() , 以及 writeDotDirDepGraph().

◆ writeDocumentation()

virtual void DirDef::writeDocumentation ( OutputList & ol )

pure virtual

在 DirDefImpl 内被实现.

◆ writeTagFile()

virtual void DirDef::writeTagFile ( TextStream & t )

pure virtual

在 DirDefImpl 内被实现.

该类的文档由以下文件生成:

src/dirdef.h

类

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ ~DirDef()

成员函数说明

◆ addFile()

◆ addSubDir()

◆ addUsesDependency()

◆ anchor()

◆ computeDependencies()

◆ definitionType()

◆ depGraphIsTrivial()

◆ dirCount()

◆ displayName()

◆ getFiles()

◆ getOutputFileBase()

◆ hasDetailedDescription()

◆ hasSubdirs()

◆ isLinkable()

◆ isLinkableInProject()

◆ isParentOf()

◆ level()

◆ parent()

◆ setDirCount()

◆ setDiskName()

◆ setLevel()

◆ setParent()

◆ shortName()

◆ shortTitle()

◆ sort()

◆ subDirs()

◆ usedDirs()

◆ writeDocumentation()

◆ writeTagFile()