doxygen  1.8.18
About: Doxygen is a source code documentation generator tool for C++, C, Objective-C, C#, PHP, Java, Python, IDL (diverse flavors), Fortran, VHDL, Tcl, and to some extent D. Different output formats are supported.
  Fossies Dox: doxygen-1.8.18.src.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

NamespaceDef Class Referenceabstract

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

#include <namespacedef.h>

+ Inheritance diagram for NamespaceDef:
+ Collaboration diagram for NamespaceDef:

Public Member Functions

virtual ~NamespaceDef ()
 
virtual DefType definitionType () const =0
 
virtual QCString getOutputFileBase () const =0
 
virtual QCString anchor () const =0
 
virtual void insertUsedFile (FileDef *fd)=0
 
virtual void writeDocumentation (OutputList &ol)=0
 
virtual void writeMemberPages (OutputList &ol)=0
 
virtual void writeQuickMemberLinks (OutputList &ol, const MemberDef *currentMd) const =0
 
virtual void writeTagFile (FTextStream &)=0
 
virtual void insertClass (const ClassDef *cd)=0
 
virtual void insertNamespace (const NamespaceDef *nd)=0
 
virtual void insertMember (MemberDef *md)=0
 
virtual void computeAnchors ()=0
 
virtual void countMembers ()=0
 
virtual int numDocMembers () const =0
 
virtual void addUsingDirective (const NamespaceDef *nd)=0
 
virtual const NamespaceSDictgetUsedNamespaces () const =0
 
virtual void addUsingDeclaration (const Definition *def)=0
 
virtual const SDict< Definition > * getUsedClasses () const =0
 
virtual void combineUsingRelations ()=0
 
virtual QCString displayName (bool=TRUE) const =0
 
virtual QCString localName () const =0
 
virtual void setInline (bool isInline)=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 void addMembersToMemberGroup ()=0
 
virtual void distributeMemberGroupDocumentation ()=0
 
virtual void findSectionsInDocumentation ()=0
 
virtual void sortMemberLists ()=0
 
virtual DefinitionfindInnerCompound (const char *name) const =0
 
virtual void addInnerCompound (const Definition *d)=0
 
virtual void addListReferences ()=0
 
virtual void setFileName (const QCString &fn)=0
 
virtual bool subGrouping () const =0
 
virtual MemberListgetMemberList (MemberListType lt) const =0
 
virtual const QList< MemberList > & getMemberLists () const =0
 
virtual MemberDefgetMemberByName (const QCString &) const =0
 
virtual MemberGroupSDictgetMemberGroupSDict () const =0
 
virtual ClassSDictgetClassSDict () const =0
 
virtual ClassSDictgetInterfaceSDict () const =0
 
virtual ClassSDictgetStructSDict () const =0
 
virtual ClassSDictgetExceptionSDict () const =0
 
virtual const NamespaceSDictgetNamespaceSDict () const =0
 
virtual QCString title () const =0
 
virtual QCString compoundTypeString () const =0
 
virtual void setMetaData (const QCString &m)=0
 
virtual void setVisited (bool v)=0
 
virtual bool isVisited () const =0
 
- Public Member Functions inherited from Definition
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 FileDefgetBodyDef () const =0
 
virtual SrcLangExt getLanguage () const =0
 Returns the programming language this definition was written in. More...
 
virtual GroupListpartOfGroups () const =0
 
virtual bool isLinkableViaGroup () const =0
 
virtual const std::vector< RefItem * > & xrefListItems () const =0
 
virtual DefinitiongetOuterScope () const =0
 
virtual MemberSDictgetReferencesMembers () const =0
 
virtual MemberSDictgetReferencedByMembers () 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 More...
 
virtual QCString id () const =0
 
virtual const SectionRefsgetSectionRefs () const =0
 returns the section dictionary, only of importance for pagedef More...
 
virtual QCString navigationPathAsString () const =0
 
virtual QCString pathFragment () const =0
 
virtual void setName (const char *name)=0
 
virtual void setId (const char *name)=0
 
virtual void setDefFile (const QCString &df, int defLine, int defColumn)=0
 
virtual void setDocumentation (const char *d, const char *docFile, int docLine, bool stripWhiteSpace=TRUE)=0
 
virtual void setBriefDescription (const char *b, const char *briefFile, int briefLine)=0
 
virtual void setInbodyDocumentation (const char *d, const char *docFile, int docLine)=0
 
virtual void setReference (const char *r)=0
 
virtual void setBodySegment (int defLine, int bls, int ble)=0
 
virtual void setBodyDef (FileDef *fd)=0
 
virtual void setRefItems (const std::vector< RefItem * > &sli)=0
 
virtual void setOuterScope (Definition *d)=0
 
virtual void setHidden (bool b)=0
 
virtual void setArtificial (bool b)=0
 
virtual void setLanguage (SrcLangExt lang)=0
 
virtual void setLocalName (const QCString name)=0
 
virtual void makePartOfGroup (GroupDef *gd)=0
 
virtual void addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)=0
 
virtual void addSourceReferencedBy (const MemberDef *d)=0
 
virtual void addSourceReferences (const MemberDef *d)=0
 
virtual void mergeRefItems (Definition *d)=0
 
virtual void addSectionsToIndex ()=0
 
virtual void writeSourceDef (OutputList &ol, const char *scopeName) const =0
 
virtual void writeInlineCode (OutputList &ol, const char *scopeName) const =0
 
virtual void writeSourceRefs (OutputList &ol, const char *scopeName) const =0
 
virtual void writeSourceReffedBy (OutputList &ol, const char *scopeName) const =0
 
virtual void writeNavigationPath (OutputList &ol) const =0
 
virtual void writeSummaryLinks (OutputList &) const =0
 
virtual void writeDocAnchorsToTagFile (FTextStream &) const =0
 
virtual void writeToc (OutputList &ol, const LocalToc &lt) const =0
 
virtual void setCookie (Cookie *cookie) const =0
 
virtual Cookiecookie () const =0
 
virtual void _setSymbolName (const QCString &name)=0
 
virtual QCString _symbolName () const =0
 
- Public Member Functions inherited from DefinitionIntf
 DefinitionIntf ()
 
virtual ~DefinitionIntf ()
 

Additional Inherited Members

- Public Types inherited from DefinitionIntf
enum  DefType {
  TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3,
  TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7,
  TypeSymbolList = 8
}
 

Detailed Description

An abstract interface of a namespace symbol.

Definition at line 37 of file namespacedef.h.

Constructor & Destructor Documentation

◆ ~NamespaceDef()

virtual NamespaceDef::~NamespaceDef ( )
inlinevirtual

Definition at line 40 of file namespacedef.h.

Member Function Documentation

◆ addInnerCompound()

virtual void NamespaceDef::addInnerCompound ( const Definition d)
pure virtual

Implements Definition.

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

◆ addListReferences()

virtual void NamespaceDef::addListReferences ( )
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by addListReferences().

◆ addMembersToMemberGroup()

virtual void NamespaceDef::addMembersToMemberGroup ( )
pure virtual

◆ addUsingDeclaration()

virtual void NamespaceDef::addUsingDeclaration ( const Definition def)
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by findUsingDeclarations().

◆ addUsingDirective()

virtual void NamespaceDef::addUsingDirective ( const NamespaceDef nd)
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by findUsingDirectives().

◆ anchor()

virtual QCString NamespaceDef::anchor ( ) const
pure virtual

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

Implements Definition.

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by NamespaceDefAliasImpl::anchor().

◆ combineUsingRelations()

virtual void NamespaceDef::combineUsingRelations ( )
pure virtual

◆ compoundTypeString()

virtual QCString NamespaceDef::compoundTypeString ( ) const
pure virtual

◆ computeAnchors()

virtual void NamespaceDef::computeAnchors ( )
pure virtual

◆ countMembers()

virtual void NamespaceDef::countMembers ( )
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by countMembers().

◆ definitionType()

virtual DefType NamespaceDef::definitionType ( ) const
pure virtual

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

Implements DefinitionIntf.

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

◆ displayName()

◆ distributeMemberGroupDocumentation()

virtual void NamespaceDef::distributeMemberGroupDocumentation ( )
pure virtual

◆ findInnerCompound()

virtual Definition* NamespaceDef::findInnerCompound ( const char *  name) const
pure virtual

◆ findSectionsInDocumentation()

virtual void NamespaceDef::findSectionsInDocumentation ( )
pure virtual

◆ getClassSDict()

◆ getExceptionSDict()

virtual ClassSDict* NamespaceDef::getExceptionSDict ( ) const
pure virtual

Returns the Slice exceptions contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by generateNamespaceDocs(), NamespaceDefAliasImpl::getExceptionSDict(), namespaceHasVisibleChild(), and writeNamespaceTree().

◆ getInterfaceSDict()

virtual ClassSDict* NamespaceDef::getInterfaceSDict ( ) const
pure virtual

Returns the Slice interfaces contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by generateNamespaceDocs(), NamespaceDefAliasImpl::getInterfaceSDict(), namespaceHasVisibleChild(), and writeNamespaceTree().

◆ getMemberByName()

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

◆ getMemberGroupSDict()

virtual MemberGroupSDict* NamespaceDef::getMemberGroupSDict ( ) const
pure virtual

◆ getMemberList()

◆ getMemberLists()

virtual const QList<MemberList>& NamespaceDef::getMemberLists ( ) const
pure virtual

◆ getNamespaceSDict()

◆ getOutputFileBase()

◆ getStructSDict()

virtual ClassSDict* NamespaceDef::getStructSDict ( ) const
pure virtual

Returns the Slice structs contained in this namespace

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by generateNamespaceDocs(), NamespaceDefAliasImpl::getStructSDict(), namespaceHasVisibleChild(), and writeNamespaceTree().

◆ getUsedClasses()

◆ getUsedNamespaces()

◆ hasDetailedDescription()

virtual bool NamespaceDef::hasDetailedDescription ( ) const
pure virtual

◆ insertClass()

virtual void NamespaceDef::insertClass ( const ClassDef cd)
pure virtual

◆ insertMember()

virtual void NamespaceDef::insertMember ( MemberDef md)
pure virtual

◆ insertNamespace()

virtual void NamespaceDef::insertNamespace ( const NamespaceDef nd)
pure virtual

◆ insertUsedFile()

virtual void NamespaceDef::insertUsedFile ( FileDef fd)
pure virtual

◆ isConstantGroup()

◆ isInline()

virtual bool NamespaceDef::isInline ( ) const
pure virtual

◆ isLibrary()

virtual bool NamespaceDef::isLibrary ( ) const
pure virtual

◆ isLinkable()

◆ isLinkableInProject()

◆ isModule()

virtual bool NamespaceDef::isModule ( ) const
pure virtual

◆ isVisited()

virtual bool NamespaceDef::isVisited ( ) const
pure virtual

◆ localName()

virtual QCString NamespaceDef::localName ( ) const
pure virtual

Returns the local name without any scope qualifiers.

Implements Definition.

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by NamespaceDefAliasImpl::localName(), NamespaceSDict::writeDeclaration(), writeGroupTreeNode(), and writeNamespaceTree().

◆ numDocMembers()

virtual int NamespaceDef::numDocMembers ( ) const
pure virtual

◆ setFileName()

virtual void NamespaceDef::setFileName ( const QCString fn)
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by buildNamespaceList().

◆ setInline()

virtual void NamespaceDef::setInline ( bool  isInline)
pure virtual

◆ setMetaData()

virtual void NamespaceDef::setMetaData ( const QCString m)
pure virtual

◆ setVisited()

virtual void NamespaceDef::setVisited ( bool  v)
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by combineUsingRelations().

◆ sortMemberLists()

virtual void NamespaceDef::sortMemberLists ( )
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by sortMemberLists().

◆ subGrouping()

virtual bool NamespaceDef::subGrouping ( ) const
pure virtual

◆ title()

virtual QCString NamespaceDef::title ( ) const
pure virtual

◆ writeDocumentation()

virtual void NamespaceDef::writeDocumentation ( OutputList ol)
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by generateNamespaceDocs().

◆ writeMemberPages()

virtual void NamespaceDef::writeMemberPages ( OutputList ol)
pure virtual

◆ writeQuickMemberLinks()

virtual void NamespaceDef::writeQuickMemberLinks ( OutputList ol,
const MemberDef currentMd 
) const
pure virtual

Implements Definition.

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

◆ writeTagFile()

virtual void NamespaceDef::writeTagFile ( FTextStream )
pure virtual

Implemented in NamespaceDefAliasImpl, and NamespaceDefImpl.

Referenced by writeTagFile().


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