An abstract interface of a namespace symbol. 更多...

#include <namespacedef.h>

类 NamespaceDef 继承关系图:

NamespaceDef 的协作图:

Public 成员函数
virtual	~NamespaceDef ()

virtual DefType	definitionType () const =0

virtual QCString	getOutputFileBase () const =0

virtual QCString	anchor () const =0

virtual int	numDocMembers () const =0

virtual LinkedRefMap< const NamespaceDef >	getUsedNamespaces () const =0

virtual LinkedRefMap< const ClassDef >	getUsedClasses () const =0

virtual QCString	displayName (bool=TRUE) const =0

virtual QCString	localName () const =0

virtual bool	isConstantGroup () const =0

virtual bool	isModule () const =0

virtual bool	isLibrary () const =0

virtual bool	isInline () const =0

virtual bool	isLinkableInProject () const =0

virtual bool	isLinkable () const =0

virtual bool	hasDetailedDescription () const =0

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

virtual bool	subGrouping () const =0

virtual MemberList *	getMemberList (MemberListType lt) const =0

virtual const MemberLists &	getMemberLists () const =0

virtual const MemberDef *	getMemberByName (const QCString &) const =0

virtual const MemberGroupList &	getMemberGroups () const =0

virtual ClassLinkedRefMap	getClasses () const =0

virtual ClassLinkedRefMap	getInterfaces () const =0

virtual ClassLinkedRefMap	getStructs () const =0

virtual ClassLinkedRefMap	getExceptions () const =0

virtual NamespaceLinkedRefMap	getNamespaces () const =0

virtual ConceptLinkedRefMap	getConcepts () const =0

virtual QCString	title () const =0

virtual QCString	compoundTypeString () const =0

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

virtual bool	isAlias () const =0

virtual QCString	name () const =0

virtual bool	isAnonymous () 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 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 }

详细描述

An abstract interface of a namespace symbol.

在文件 namespacedef.h 第 54 行定义.

构造及析构函数说明

◆ ~NamespaceDef()

virtual NamespaceDef::~NamespaceDef ( )

inlinevirtual

在文件 namespacedef.h 第 57 行定义.

57 {}

成员函数说明

◆ anchor()

virtual QCString NamespaceDef::anchor ( ) const

pure virtual

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

实现了 Definition.

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 addToIndices() , 以及 NamespaceDefAliasImpl::anchor().

◆ compoundTypeString()

virtual QCString NamespaceDef::compoundTypeString ( ) const

pure virtual

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 NamespaceContext::Private::compoundType(), NamespaceDefAliasImpl::compoundTypeString() , 以及 MemberDefImpl::warnIfUndocumented().

◆ definitionType()

virtual DefType NamespaceDef::definitionType ( ) const

pure virtual

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

实现了 Definition.

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

◆ displayName()

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

pure virtual

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

实现了 Definition.

在 NamespaceDefImpl , 以及 NamespaceDefAliasImpl 内被实现.

被这些函数引用 addToIndices(), MemberDefImpl::getScopeString(), MemberContext::Private::handleNameWithContextFor(), MemberDefImpl::writeDocumentation(), MemberDefImpl::writeLink() , 以及 writeNamespaceLinkForMember().

◆ findInnerCompound()

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

pure virtual

实现了 Definition.

在 DefinitionAliasMixin< NamespaceDef >, NamespaceDefAliasImpl, DefinitionMixin< NamespaceDefMutable > , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 NamespaceDefAliasImpl::findInnerCompound().

◆ getClasses()

virtual ClassLinkedRefMap NamespaceDef::getClasses ( ) const

pure virtual

Returns the classes contained in this namespace

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 NestingNodeContext::Private::addNamespaces(), NamespaceContext::Private::createClasses(), NamespaceContext::Private::createInlineClasses(), generateNamespaceDocs(), PerlModGenerator::generatePerlModForNamespace(), generateXMLForNamespace(), NamespaceDefAliasImpl::getClasses(), namespaceHasNestedClass(), writeClassTreeInsideNamespaceElement() , 以及 writeNamespaceTreeElement().

◆ getConcepts()

virtual ConceptLinkedRefMap NamespaceDef::getConcepts ( ) const

pure virtual

Returns the concepts contained in this namespace

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 NestingNodeContext::Private::addNamespaces(), generateNamespaceDocs(), NamespaceDefAliasImpl::getConcepts(), namespaceHasNestedConcept(), writeConceptTreeInsideNamespaceElement() , 以及 writeNamespaceTreeElement().

◆ getExceptions()

virtual ClassLinkedRefMap NamespaceDef::getExceptions ( ) const

pure virtual

Returns the Slice exceptions contained in this namespace

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 generateNamespaceDocs(), NamespaceDefAliasImpl::getExceptions(), namespaceHasNestedClass() , 以及 writeClassTreeInsideNamespaceElement().

◆ getInterfaces()

virtual ClassLinkedRefMap NamespaceDef::getInterfaces ( ) const

pure virtual

Returns the Slice interfaces contained in this namespace

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 generateNamespaceDocs(), NamespaceDefAliasImpl::getInterfaces(), namespaceHasNestedClass() , 以及 writeClassTreeInsideNamespaceElement().

◆ getMemberByName()

virtual const MemberDef* NamespaceDef::getMemberByName ( const QCString & ) const

pure virtual

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 NamespaceDefAliasImpl::getMemberByName().

◆ getMemberGroups()

virtual const MemberGroupList& NamespaceDef::getMemberGroups ( ) const

pure virtual

Returns the user defined member groups

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 NamespaceContext::Private::createMemberGroups(), PerlModGenerator::generatePerlModForNamespace(), generateXMLForNamespace() , 以及 NamespaceDefAliasImpl::getMemberGroups().

◆ getMemberList()

virtual MemberList* NamespaceDef::getMemberList ( MemberListType lt ) const

pure virtual

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 NestingNodeContext::Private::addMembers(), countVisibleMembers(), NamespaceContext::Private::createMemberList(), generateDEFForNamespace(), PerlModGenerator::generatePerlModForNamespace(), NamespaceDefAliasImpl::getMemberList() , 以及 writeNamespaceMembers().

◆ getMemberLists()

virtual const MemberLists& NamespaceDef::getMemberLists ( ) const

pure virtual

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 generateXMLForNamespace() , 以及 NamespaceDefAliasImpl::getMemberLists().

◆ getNamespaces()

virtual NamespaceLinkedRefMap NamespaceDef::getNamespaces ( ) const

pure virtual

Returns the namespaces contained in this namespace

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 NestingNodeContext::Private::addNamespaces(), NamespaceContext::Private::createConstantgroups(), NamespaceContext::Private::createNamespaces(), PerlModGenerator::generatePerlModForNamespace(), generateXMLForNamespace(), NamespaceDefAliasImpl::getNamespaces(), namespaceHasNestedClass(), namespaceHasNestedConcept(), namespaceHasNestedNamespace(), writeClassTreeInsideNamespaceElement(), writeConceptTreeInsideNamespaceElement() , 以及 writeNamespaceTreeElement().

◆ getOutputFileBase()

virtual QCString NamespaceDef::getOutputFileBase ( ) const

pure virtual

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

实现了 Definition.

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 generateDEFForNamespace(), generateXMLForNamespace(), MemberDefImpl::getOutputFileBase(), NamespaceDefAliasImpl::getOutputFileBase(), writeAlphabeticalClassList(), writeClassTreeInsideNamespaceElement(), writeConceptTreeInsideNamespaceElement() , 以及 writeNamespaceTreeElement().

◆ getStructs()

virtual ClassLinkedRefMap NamespaceDef::getStructs ( ) const

pure virtual

Returns the Slice structs contained in this namespace

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 generateNamespaceDocs(), NamespaceDefAliasImpl::getStructs(), namespaceHasNestedClass() , 以及 writeClassTreeInsideNamespaceElement().

◆ getUsedClasses()

virtual LinkedRefMap<const ClassDef> NamespaceDef::getUsedClasses ( ) const

pure virtual

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 NamespaceDefAliasImpl::getUsedClasses(), SymbolResolver::Private::isAccessibleFrom() , 以及 SymbolResolver::Private::isAccessibleFromWithExpScope().

◆ getUsedNamespaces()

virtual LinkedRefMap<const NamespaceDef> NamespaceDef::getUsedNamespaces ( ) const

pure virtual

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 findUsingDirectives(), NamespaceDefAliasImpl::getUsedNamespaces(), SymbolResolver::Private::isAccessibleFrom() , 以及 SymbolResolver::Private::isAccessibleFromWithExpScope().

◆ hasDetailedDescription()

virtual bool NamespaceDef::hasDetailedDescription ( ) const

pure virtual

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 NamespaceDefAliasImpl::hasDetailedDescription() , 以及 NamespaceContext::Private::hasDetails().

◆ isConstantGroup()

virtual bool NamespaceDef::isConstantGroup ( ) const

pure virtual

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 NamespaceDefAliasImpl::isConstantGroup().

◆ isInline()

virtual bool NamespaceDef::isInline ( ) const

pure virtual

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 buildNamespaceList(), generateXMLForNamespace(), NamespaceDefAliasImpl::isInline() , 以及 resolveClassNestingRelations().

◆ isLibrary()

virtual bool NamespaceDef::isLibrary ( ) const

pure virtual

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 NamespaceDefAliasImpl::isLibrary().

◆ isLinkable()

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

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 addEnumValuesToEnums(), addMemberToSearchIndex(), getDefs(), MemberDefImpl::getOutputFileBase(), getScopeDefs(), MemberDefImpl::isDetailedSectionVisible(), NamespaceDefAliasImpl::isLinkable(), writeAlphabeticalClassList() , 以及 MemberDefImpl::writeDocumentation().

◆ isLinkableInProject()

virtual bool NamespaceDef::isLinkableInProject ( ) const

pure virtual

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

实现了 Definition.

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 MemberDefImpl::_computeLinkableInProject(), NestingContext::Private::addNamespace(), addNamespaceMemberNameToIndex(), addSourceReferences(), addToIndices(), NamespaceMembersIndexContext::Private::createMembersFiltered(), generateNamespaceDocs(), NamespaceDefAliasImpl::isLinkableInProject(), writeClassTreeInsideNamespaceElement(), writeConceptTreeInsideNamespaceElement(), writeNamespaceTreeElement() , 以及 writeTagFile().

◆ isModule()

virtual bool NamespaceDef::isModule ( ) const

pure virtual

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 NamespaceDefAliasImpl::isModule().

◆ localName()

virtual QCString NamespaceDef::localName ( ) const

pure virtual

Returns the local name without any scope qualifiers.

实现了 Definition.

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 addToIndices(), NamespaceDefAliasImpl::localName(), makeDisplayName(), writeClassTreeInsideNamespaceElement(), writeConceptTreeInsideNamespaceElement() , 以及 writeNamespaceTreeElement().

◆ numDocMembers()

virtual int NamespaceDef::numDocMembers ( ) const

pure virtual

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 NamespaceDefAliasImpl::numDocMembers().

◆ subGrouping()

virtual bool NamespaceDef::subGrouping ( ) const

pure virtual

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 NamespaceContext::Private::createMemberGroups() , 以及 NamespaceDefAliasImpl::subGrouping().

◆ title()

virtual QCString NamespaceDef::title ( ) const

pure virtual

在 NamespaceDefAliasImpl , 以及 NamespaceDefImpl 内被实现.

被这些函数引用 NamespaceDefAliasImpl::title() , 以及 NamespaceContext::Private::title().

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

src/namespacedef.h

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ ~NamespaceDef()

成员函数说明

◆ anchor()

◆ compoundTypeString()

◆ definitionType()

◆ displayName()

◆ findInnerCompound()

◆ getClasses()

◆ getConcepts()

◆ getExceptions()

◆ getInterfaces()

◆ getMemberByName()

◆ getMemberGroups()

◆ getMemberList()

◆ getMemberLists()

◆ getNamespaces()

◆ getOutputFileBase()

◆ getStructs()

◆ getUsedClasses()

◆ getUsedNamespaces()

◆ hasDetailedDescription()

◆ isConstantGroup()

◆ isInline()

◆ isLibrary()

◆ isLinkable()

◆ isLinkableInProject()

◆ isModule()

◆ localName()

◆ numDocMembers()

◆ subGrouping()

◆ title()