The NamespaceDef Class Reference

An abstract interface of a namespace symbol. More...

Declaration

class NamespaceDef { ... }

Included Headers

#include <src/namespacedef.h>

Base class

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

Derived Classes

class	DefinitionAliasMixin<Base>
class	NamespaceDefMutable

Public Member Functions Index

int	numDocMembers () const =0
const LinkedRefMap< NamespaceDef > &	getUsedNamespaces () const =0
const LinkedRefMap< const Definition > &	getUsedDefinitions () const =0
bool	isConstantGroup () const =0
bool	isModule () const =0
bool	isLibrary () const =0
bool	isInline () const =0
bool	isVisibleInHierarchy () const =0
bool	hasDetailedDescription () const =0
bool	subGrouping () const =0
MemberList *	getMemberList (MemberListType lt) const =0
const MemberLists &	getMemberLists () const =0
const MemberDef *	getMemberByName (const QCString &) const =0
int	countVisibleMembers () const =0
const MemberGroupList &	getMemberGroups () const =0
ClassLinkedRefMap	getClasses () const =0
ClassLinkedRefMap	getInterfaces () const =0
ClassLinkedRefMap	getStructs () const =0
ClassLinkedRefMap	getExceptions () const =0
NamespaceLinkedRefMap	getNamespaces () const =0
ConceptLinkedRefMap	getConcepts () const =0
QCString	title () const =0
QCString	compoundTypeString () const =0

Description

An abstract interface of a namespace symbol.

Definition at line 54 of file namespacedef.h.

Public Member Functions

compoundTypeString()

virtual QCString NamespaceDef::compoundTypeString ()

Definition at line 97 of file namespacedef.h.

Reference compoundTypeString.

Referenced by compoundTypeString, NamespaceDefAliasImpl::compoundTypeString and MemberDefImpl::warnIfUndocumented.

countVisibleMembers()

virtual int NamespaceDef::countVisibleMembers ()

Definition at line 73 of file namespacedef.h.

Reference countVisibleMembers.

Referenced by countVisibleMembers, NamespaceDefAliasImpl::countVisibleMembers and writeNamespaceTreeElement.

getClasses()

virtual ClassLinkedRefMap NamespaceDef::getClasses ()

Returns the classes contained in this namespace

Definition at line 79 of file namespacedef.h.

Reference getClasses.

Referenced by PerlModGenerator::generatePerlModForNamespace, generateSqlite3ForNamespace, generateXMLForNamespace, getClasses, NamespaceDefAliasImpl::getClasses, namespaceHasNestedClass, writeClassTreeInsideNamespaceElement and writeNamespaceTreeElement.

getConcepts()

virtual ConceptLinkedRefMap NamespaceDef::getConcepts ()

Returns the concepts contained in this namespace

Definition at line 94 of file namespacedef.h.

Reference getConcepts.

Referenced by generateSqlite3ForNamespace, generateXMLForNamespace, getConcepts, NamespaceDefAliasImpl::getConcepts, namespaceHasNestedConcept, writeConceptTreeInsideNamespaceElement and writeNamespaceTreeElement.

getExceptions()

virtual ClassLinkedRefMap NamespaceDef::getExceptions ()

Returns the Slice exceptions contained in this namespace

Definition at line 88 of file namespacedef.h.

Reference getExceptions.

Referenced by getExceptions, NamespaceDefAliasImpl::getExceptions, namespaceHasNestedClass and writeClassTreeInsideNamespaceElement.

getInterfaces()

virtual ClassLinkedRefMap NamespaceDef::getInterfaces ()

Returns the Slice interfaces contained in this namespace

Definition at line 82 of file namespacedef.h.

Reference getInterfaces.

Referenced by getInterfaces, NamespaceDefAliasImpl::getInterfaces, namespaceHasNestedClass and writeClassTreeInsideNamespaceElement.

getMemberByName()

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

Definition at line 72 of file namespacedef.h.

Reference getMemberByName.

Referenced by SymbolResolver::Private::followPath, generateClassOrGlobalLink, getMemberByName, NamespaceDefAliasImpl::getMemberByName and setCallContextForVar.

getMemberGroups()

virtual const MemberGroupList & NamespaceDef::getMemberGroups ()

Returns the user defined member groups

Definition at line 76 of file namespacedef.h.

Reference getMemberGroups.

Referenced by PerlModGenerator::generatePerlModForNamespace, generateSqlite3ForNamespace, generateXMLForNamespace, getMemberGroups and NamespaceDefAliasImpl::getMemberGroups.

getMemberList()

virtual MemberList * NamespaceDef::getMemberList (MemberListType lt)

Definition at line 70 of file namespacedef.h.

Reference getMemberList.

Referenced by generateDEFForNamespace, PerlModGenerator::generatePerlModForNamespace, getMemberList, NamespaceDefAliasImpl::getMemberList and writeNamespaceMembers.

getMemberLists()

virtual const MemberLists & NamespaceDef::getMemberLists ()

Definition at line 71 of file namespacedef.h.

Reference getMemberLists.

Referenced by generateSqlite3ForNamespace, generateXMLForNamespace, getMemberLists and NamespaceDefAliasImpl::getMemberLists.

getNamespaces()

virtual NamespaceLinkedRefMap NamespaceDef::getNamespaces ()

Returns the namespaces contained in this namespace

Definition at line 91 of file namespacedef.h.

Reference getNamespaces.

Referenced by PerlModGenerator::generatePerlModForNamespace, generateSqlite3ForNamespace, generateXMLForNamespace, getNamespaces, NamespaceDefAliasImpl::getNamespaces, hasNonReferenceNestedNamespaceRec, namespaceHasNestedClass, namespaceHasNestedConcept, namespaceHasNestedNamespace, writeClassTreeInsideNamespaceElement, writeConceptTreeInsideNamespaceElement and writeNamespaceTreeElement.

getStructs()

virtual ClassLinkedRefMap NamespaceDef::getStructs ()

Returns the Slice structs contained in this namespace

Definition at line 85 of file namespacedef.h.

Reference getStructs.

Referenced by getStructs, NamespaceDefAliasImpl::getStructs, namespaceHasNestedClass and writeClassTreeInsideNamespaceElement.

getUsedDefinitions()

virtual const LinkedRefMap< const Definition > & NamespaceDef::getUsedDefinitions ()

Definition at line 62 of file namespacedef.h.

Reference getUsedDefinitions.

Referenced by getUsedDefinitions, NamespaceDefAliasImpl::getUsedDefinitions, SymbolResolver::Private::isAccessibleFrom and SymbolResolver::Private::isAccessibleFromWithExpScope.

getUsedNamespaces()

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

Definition at line 61 of file namespacedef.h.

Reference getUsedNamespaces.

Referenced by findUsingDirectives, getUsedNamespaces, NamespaceDefAliasImpl::getUsedNamespaces, SymbolResolver::Private::isAccessibleFrom and SymbolResolver::Private::isAccessibleFromWithExpScope.

hasDetailedDescription()

virtual bool NamespaceDef::hasDetailedDescription ()

Definition at line 68 of file namespacedef.h.

Reference hasDetailedDescription.

Referenced by hasDetailedDescription and NamespaceDefAliasImpl::hasDetailedDescription.

isConstantGroup()

virtual bool NamespaceDef::isConstantGroup ()

Definition at line 63 of file namespacedef.h.

Reference isConstantGroup.

Referenced by isConstantGroup and NamespaceDefAliasImpl::isConstantGroup.

isInline()

virtual bool NamespaceDef::isInline ()

Definition at line 66 of file namespacedef.h.

Reference isInline.

Referenced by buildNamespaceList, generateXMLForNamespace, isInline, NamespaceDefAliasImpl::isInline, resolveClassNestingRelations and NamespaceDefMutable::setInline.

isLibrary()

virtual bool NamespaceDef::isLibrary ()

Definition at line 65 of file namespacedef.h.

Reference isLibrary.

Referenced by isLibrary and NamespaceDefAliasImpl::isLibrary.

isModule()

virtual bool NamespaceDef::isModule ()

Definition at line 64 of file namespacedef.h.

Reference isModule.

Referenced by isModule and NamespaceDefAliasImpl::isModule.

isVisibleInHierarchy()

virtual bool NamespaceDef::isVisibleInHierarchy ()

Definition at line 67 of file namespacedef.h.

Reference isVisibleInHierarchy.

Referenced by isVisibleInHierarchy and NamespaceDefAliasImpl::isVisibleInHierarchy.

numDocMembers()

virtual int NamespaceDef::numDocMembers ()

Definition at line 60 of file namespacedef.h.

Reference numDocMembers.

Referenced by numDocMembers and NamespaceDefAliasImpl::numDocMembers.

subGrouping()

virtual bool NamespaceDef::subGrouping ()

Definition at line 69 of file namespacedef.h.

Reference subGrouping.

Referenced by subGrouping and NamespaceDefAliasImpl::subGrouping.

title()

virtual QCString NamespaceDef::title ()

Definition at line 96 of file namespacedef.h.

Reference title.

Referenced by generateSqlite3ForNamespace, title and NamespaceDefAliasImpl::title.

---

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

• namespacedef.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.