Doxygen
Loading...
Searching...
No Matches
Public Member Functions | List of all members
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< ClassDef > & getUsedClasses () 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 QCString &) 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 QCString title () const =0
 
virtual QCString 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 QCString & name () const =0
 
virtual bool isAnonymous () const =0
 
virtual QCString displayName (bool includeScope=TRUE) const =0
 
virtual const QCString & localName () const =0
 
virtual QCString qualifiedName () const =0
 
virtual QCString symbolName () const =0
 
virtual QCString getOutputFileBase () const =0
 
virtual QCString anchor () 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 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 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
 

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 QCString NamespaceDef::compoundTypeString ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

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

◆ countVisibleMembers()

virtual int NamespaceDef::countVisibleMembers ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

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

◆ getClasses()

virtual ClassLinkedRefMap NamespaceDef::getClasses ( ) const
pure virtual

Returns the classes contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by generateNamespaceDocs(), PerlModGenerator::generatePerlModForNamespace(), generateSqlite3ForNamespace(), generateXMLForNamespace(), 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.

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

◆ getExceptions()

virtual ClassLinkedRefMap NamespaceDef::getExceptions ( ) const
pure virtual

Returns the Slice exceptions contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by generateNamespaceDocs(), 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.

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

◆ getMemberByName()

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

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

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

◆ getMemberGroups()

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

Returns the user defined member groups

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

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

◆ getMemberList()

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

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

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

◆ getMemberLists()

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

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

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

◆ getNamespaces()

virtual NamespaceLinkedRefMap NamespaceDef::getNamespaces ( ) const
pure virtual

Returns the namespaces contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

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

◆ getStructs()

virtual ClassLinkedRefMap NamespaceDef::getStructs ( ) const
pure virtual

Returns the Slice structs contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

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

◆ getUsedClasses()

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

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

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

◆ getUsedNamespaces()

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

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

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

◆ hasDetailedDescription()

virtual bool NamespaceDef::hasDetailedDescription ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by NamespaceDefAliasImpl::hasDetailedDescription().

◆ isConstantGroup()

virtual bool NamespaceDef::isConstantGroup ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by NamespaceDefAliasImpl::isConstantGroup().

◆ isInline()

virtual bool NamespaceDef::isInline ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

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

◆ isLibrary()

virtual bool NamespaceDef::isLibrary ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by NamespaceDefAliasImpl::isLibrary().

◆ isModule()

virtual bool NamespaceDef::isModule ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by NamespaceDefAliasImpl::isModule().

◆ isVisibleInHierarchy()

virtual bool NamespaceDef::isVisibleInHierarchy ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by NamespaceDefAliasImpl::isVisibleInHierarchy().

◆ numDocMembers()

virtual int NamespaceDef::numDocMembers ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by NamespaceDefAliasImpl::numDocMembers().

◆ subGrouping()

virtual bool NamespaceDef::subGrouping ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by NamespaceDefAliasImpl::subGrouping().

◆ title()

virtual QCString NamespaceDef::title ( ) const
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

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

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