Doxygen
Loading...
Searching...
No Matches
NamespaceDef Class Referenceabstract

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

#include <src/namespacedef.h>

Inheritance diagram for NamespaceDef:
Collaboration diagram for NamespaceDef:

Public Member Functions

virtual int numDocMembers () const =0
virtual const LinkedRefMap< NamespaceDef > & getUsedNamespaces () const =0
virtual const LinkedRefMap< const Definition > & getUsedDefinitions () const =0
virtual bool isConstantGroup () const =0
virtual bool isModule () const =0
virtual bool isLibrary () const =0
virtual bool isInline () const =0
virtual bool isVisibleInHierarchy () const =0
virtual bool hasDetailedDescription () 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 DString &) const =0
virtual int countVisibleMembers () 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 DString title () const =0
virtual DString compoundTypeString () const =0
Public Member Functions inherited from Definition
virtual DefType definitionType () const =0
virtual CodeSymbolType codeSymbolType () const =0
virtual bool isAlias () const =0
virtual const DString & name () const =0
virtual bool isAnonymous () const =0
virtual DString displayName (bool includeScope=true) const =0
virtual const DString & localName () const =0
virtual DString qualifiedName () const =0
virtual DString symbolName () const =0
virtual DString getOutputFileBase () const =0
virtual DString anchor () const =0
virtual DString getSourceFileBase () const =0
virtual DString getSourceAnchor () const =0
virtual DString documentation () const =0
virtual int docLine () const =0
virtual DString docFile () const =0
virtual DString briefDescription (bool abbreviate=false) const =0
virtual DString briefDescriptionAsTooltip () const =0
virtual int briefLine () const =0
virtual DString briefFile () const =0
virtual DString inbodyDocumentation () const =0
virtual DString inbodyFile () const =0
virtual int inbodyLine () const =0
virtual DString getDefFileName () const =0
virtual DString getDefFileExtension () const =0
virtual int getDefLine () const =0
virtual size_t getDefColumn () const =0
virtual bool hasDocumentation () const =0
virtual bool hasUserDocumentation () const =0
virtual bool isLinkableInProject () const =0
virtual bool isLinkable () const =0
virtual bool isVisibleInProject () const =0
virtual bool isVisible () const =0
virtual bool isHidden () const =0
virtual bool isArtificial () const =0
virtual bool isExported () const =0
virtual DString getReference () const =0
virtual bool isReference () const =0
virtual DString externalReference (const DString &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 RequirementRefs & requirementReferences () const =0
virtual const Definition * findInnerCompound (const DString &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 DString id () const =0
virtual const SectionRefs & getSectionRefs () const =0
 returns the section dictionary, only of importance for pagedef
virtual DString navigationPathAsString () const =0
virtual DString pathFragment () const =0
virtual void _setSymbolName (const DString &name)=0
virtual DString _symbolName () const =0

Additional Inherited Members

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

Detailed Description

An abstract interface of a namespace symbol.

Definition at line 54 of file namespacedef.h.

Member Function Documentation

◆ compoundTypeString()

virtual DString NamespaceDef::compoundTypeString ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References compoundTypeString().

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

◆ countVisibleMembers()

virtual int NamespaceDef::countVisibleMembers ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References countVisibleMembers().

Referenced by countVisibleMembers(), NamespaceDefAliasImpl::countVisibleMembers(), and writeNamespaceTreeElement().

◆ getClasses()

virtual ClassLinkedRefMap NamespaceDef::getClasses ( ) const
pure virtual

Returns the classes contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References getClasses().

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

◆ getConcepts()

virtual ConceptLinkedRefMap NamespaceDef::getConcepts ( ) const
pure virtual

Returns the concepts contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References getConcepts().

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

◆ getExceptions()

virtual ClassLinkedRefMap NamespaceDef::getExceptions ( ) const
pure virtual

Returns the Slice exceptions contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References getExceptions().

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

◆ getInterfaces()

virtual ClassLinkedRefMap NamespaceDef::getInterfaces ( ) const
pure virtual

Returns the Slice interfaces contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References getInterfaces().

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

◆ getMemberByName()

virtual const MemberDef * NamespaceDef::getMemberByName ( const DString & ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References getMemberByName().

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

◆ getMemberGroups()

virtual const MemberGroupList & NamespaceDef::getMemberGroups ( ) const
pure virtual

Returns the user defined member groups

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References getMemberGroups().

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

◆ getMemberList()

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

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References getMemberList().

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

◆ getMemberLists()

virtual const MemberLists & NamespaceDef::getMemberLists ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References getMemberLists().

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

◆ getNamespaces()

virtual NamespaceLinkedRefMap NamespaceDef::getNamespaces ( ) const
pure virtual

Returns the namespaces contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References getNamespaces().

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

◆ getStructs()

virtual ClassLinkedRefMap NamespaceDef::getStructs ( ) const
pure virtual

Returns the Slice structs contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References getStructs().

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

◆ getUsedDefinitions()

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

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References getUsedDefinitions().

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

◆ getUsedNamespaces()

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

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References getUsedNamespaces().

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

◆ hasDetailedDescription()

virtual bool NamespaceDef::hasDetailedDescription ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References hasDetailedDescription().

Referenced by hasDetailedDescription(), and NamespaceDefAliasImpl::hasDetailedDescription().

◆ isConstantGroup()

virtual bool NamespaceDef::isConstantGroup ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References isConstantGroup().

Referenced by isConstantGroup(), and NamespaceDefAliasImpl::isConstantGroup().

◆ isInline()

virtual bool NamespaceDef::isInline ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References isInline().

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

◆ isLibrary()

virtual bool NamespaceDef::isLibrary ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References isLibrary().

Referenced by isLibrary(), and NamespaceDefAliasImpl::isLibrary().

◆ isModule()

virtual bool NamespaceDef::isModule ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References isModule().

Referenced by isModule(), and NamespaceDefAliasImpl::isModule().

◆ isVisibleInHierarchy()

virtual bool NamespaceDef::isVisibleInHierarchy ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References isVisibleInHierarchy().

Referenced by isVisibleInHierarchy(), and NamespaceDefAliasImpl::isVisibleInHierarchy().

◆ numDocMembers()

virtual int NamespaceDef::numDocMembers ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References numDocMembers().

Referenced by numDocMembers(), and NamespaceDefAliasImpl::numDocMembers().

◆ subGrouping()

virtual bool NamespaceDef::subGrouping ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References subGrouping().

Referenced by subGrouping(), and NamespaceDefAliasImpl::subGrouping().

◆ title()

virtual DString NamespaceDef::title ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

References title().

Referenced by generateSqlite3ForNamespace(), title(), and NamespaceDefAliasImpl::title().

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