Inheritance diagram for DirDefImpl:

Collaboration diagram for DirDefImpl:

Public Member Functions
	DirDefImpl (const QCString &path)

virtual DefType	definitionType () const

virtual CodeSymbolType	codeSymbolType () const

virtual QCString	getOutputFileBase () const

virtual QCString	anchor () const

virtual bool	isLinkableInProject () const

virtual bool	isLinkable () const

virtual QCString	displayName (bool=TRUE) const

virtual const QCString	shortName () const

virtual void	addSubDir (DirDef *subdir)

virtual const FileList &	getFiles () const

virtual void	addFile (const FileDef *fd)

virtual const DirList &	subDirs () const

virtual bool	hasSubdirs () const

virtual int	level () const

virtual DirDef *	parent () const

virtual int	dirCount () const

virtual const UsedDirLinkedMap &	usedDirs () const

virtual bool	isParentOf (const DirDef *dir) const

virtual bool	depGraphIsTrivial () const

virtual QCString	shortTitle () const

virtual bool	hasDetailedDescription () const

virtual void	writeDocumentation (OutputList &ol)

virtual void	writeTagFile (TextStream &t)

virtual void	setDiskName (const QCString &name)

virtual void	sort ()

virtual void	setParent (DirDef *parent)

virtual void	setDirCount (int count)

virtual void	setLevel ()

virtual void	addUsesDependency (const DirDef usedDir, const FileDef srcFd, const FileDef *dstFd, bool srcDirect, bool dstDirect)
	Add as "uses" dependency between this dir and dir, that was caused by a dependency on file fd. More...

virtual void	computeDependencies ()
	Computes the dependencies between directories.

Public Member Functions inherited from DefinitionMixin< DirDef >
	DefinitionMixin (const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char b=0, const char d=0, bool isSymbol=TRUE)

virtual bool	isAlias () const

virtual QCString	name () const

virtual bool	isAnonymous () const

virtual QCString	localName () const

virtual QCString	qualifiedName () const

virtual QCString	symbolName () const

virtual QCString	getSourceFileBase () const

virtual QCString	getSourceAnchor () const

virtual QCString	documentation () const

virtual int	docLine () const

virtual QCString	docFile () const

virtual QCString	briefDescription (bool abbreviate=FALSE) const

virtual QCString	briefDescriptionAsTooltip () const

virtual int	briefLine () const

virtual QCString	inbodyDocumentation () const

virtual QCString	inbodyFile () const

virtual int	inbodyLine () const

virtual QCString	briefFile () const

virtual QCString	getDefFileName () const

virtual QCString	getDefFileExtension () const

virtual int	getDefLine () const

virtual int	getDefColumn () const

virtual bool	hasDocumentation () const

virtual bool	hasUserDocumentation () const

virtual bool	isVisibleInProject () const

virtual bool	isVisible () const

virtual bool	isHidden () const

virtual bool	isArtificial () const

virtual QCString	getReference () const

virtual bool	isReference () const

virtual QCString	externalReference (const QCString &relPath) const

virtual int	getStartDefLine () const

virtual int	getStartBodyLine () const

virtual int	getEndBodyLine () const

virtual const FileDef *	getBodyDef () const

virtual SrcLangExt	getLanguage () const

virtual const GroupList &	partOfGroups () const

virtual bool	isLinkableViaGroup () const

virtual const RefItemVector &	xrefListItems () const

virtual const Definition *	findInnerCompound (const QCString &name) const

virtual Definition *	getOuterScope () const

virtual const MemberVector &	getReferencesMembers () const

virtual const MemberVector &	getReferencedByMembers () const

virtual bool	hasSections () const

virtual bool	hasSources () const

virtual bool	hasBriefDescription () const

virtual QCString	id () const

virtual const SectionRefs &	getSectionRefs () const

virtual void	setName (const QCString &name)

virtual void	setId (const QCString &name)

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

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

virtual void	setBriefDescription (const QCString &brief, const QCString &briefFile, int briefLine)

virtual void	setInbodyDocumentation (const QCString &doc, const QCString &docFile, int docLine)

virtual void	setReference (const QCString &r)

virtual void	addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)

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

virtual void	setBodyDef (const FileDef *fd)

virtual void	addSourceReferencedBy (const MemberDef *md)

virtual void	addSourceReferences (const MemberDef *md)

virtual void	setRefItems (const RefItemVector &sli)

virtual void	mergeRefItems (Definition *def)

virtual void	mergeReferences (const Definition *other)

virtual void	mergeReferencedBy (const Definition *other)

virtual void	addInnerCompound (const Definition *def)

virtual void	setOuterScope (Definition *def)

virtual void	setHidden (bool b)

virtual void	setArtificial (bool b)

virtual void	setLanguage (SrcLangExt lang)

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

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

virtual bool	hasSourceRefs () const

virtual bool	hasSourceReffedBy () const

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

virtual void	writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const

virtual void	makePartOfGroup (const GroupDef *gd)

virtual void	writeNavigationPath (OutputList &ol) const

virtual QCString	navigationPathAsString () const

virtual void	writeQuickMemberLinks (OutputList &ol, const MemberDef *md) const

virtual void	writeSummaryLinks (OutputList &ol) const

virtual QCString	pathFragment () const

virtual void	writeDocAnchorsToTagFile (TextStream &fs) const

virtual void	setLocalName (const QCString &name)

virtual void	addSectionsToIndex ()

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

virtual void	computeTooltip ()

virtual void	_setSymbolName (const QCString &name)

virtual QCString	_symbolName () const

Static Public Member Functions
static DirDef *	mergeDirectoryInTree (const QCString &path)

Additional Inherited Members
Public Types inherited from Definition
enum	DefType { TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3, TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7, TypeConcept = 8 }

Protected Member Functions inherited from DefinitionMixin< DirDef >
	DefinitionMixin (const DefinitionMixin &def)=default

Member Function Documentation

◆ addUsesDependency()

void DirDefImpl::addUsesDependency	(	const DirDef *	dir,
		const FileDef *	srcFd,
		const FileDef *	dstFd,
		bool	srcDirect,
		bool	dstDirect
	)

virtual

Add as "uses" dependency between this dir and dir, that was caused by a dependency on file fd.

srcDirect and dstDirect indicate if it is a direct dependencies (true) or if the dependencies was indirect (e.g. a parent dir that has a child dir that has the dependencies)

Implements DirDef.

◆ anchor()

virtual QCString DirDefImpl::anchor ( ) const

inlinevirtual

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

Implements DirDef.

◆ codeSymbolType()

virtual CodeSymbolType DirDefImpl::codeSymbolType ( ) const

inlinevirtual

Used for syntax highlighting symbol class

Implements Definition.

◆ definitionType()

virtual DefType DirDefImpl::definitionType ( ) const

inlinevirtual

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

Implements DirDef.

◆ displayName()

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

inlinevirtual

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

Implements DirDef.

◆ getOutputFileBase()

QCString DirDefImpl::getOutputFileBase ( ) const

virtual

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

Implements DirDef.

◆ isLinkable()

bool DirDefImpl::isLinkable ( ) const

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.

Implements DirDef.

◆ isLinkableInProject()

bool DirDefImpl::isLinkableInProject ( ) const

virtual

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

Implements DirDef.

◆ mergeDirectoryInTree()

DirDef * DirDefImpl::mergeDirectoryInTree ( const QCString & path )

static

strip part of path if it matches one of the paths in the Config_getList(STRIP_FROM_PATH) list

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

src/dirdef.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ addUsesDependency()

◆ anchor()

◆ codeSymbolType()

◆ definitionType()

◆ displayName()

◆ getOutputFileBase()

◆ isLinkable()

◆ isLinkableInProject()

◆ mergeDirectoryInTree()