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

#include <src/namespacedef.h>

Inheritance diagram for NamespaceDefMutable:
Collaboration diagram for NamespaceDefMutable:

Public Member Functions

virtual void setMetaData (const DString &m)=0
virtual void insertUsedFile (FileDef *fd)=0
virtual void writeDocumentation (OutputList &ol)=0
virtual void writeMemberPages (OutputList &ol)=0
virtual void writeTagFile (TextStream &)=0
virtual void insertClass (ClassDef *cd)=0
virtual void insertConcept (ConceptDef *cd)=0
virtual void insertNamespace (NamespaceDef *nd)=0
virtual void insertMember (MemberDef *md)=0
virtual void computeAnchors ()=0
virtual void countMembers ()=0
virtual void addMembersToMemberGroup ()=0
virtual void distributeMemberGroupDocumentation ()=0
virtual void findSectionsInDocumentation ()=0
virtual void sortMemberLists ()=0
virtual void addListReferences ()=0
virtual void addRequirementReferences ()=0
virtual void setFileName (const DString &fn)=0
virtual void combineUsingRelations (NamespaceDefSet &visitedNamespace)=0
virtual void addUsingDirective (NamespaceDef *nd)=0
virtual void addUsingDeclaration (const Definition *d)=0
virtual void setInline (bool isInline)=0
Public Member Functions inherited from DefinitionMutable
virtual void setName (const DString &name)=0
virtual void setId (const DString &name)=0
virtual void setDefFile (const DString &df, int defLine, size_t defColumn)=0
virtual void setDocumentation (const DString &d, const DString &docFile, int docLine, bool stripWhiteSpace=true)=0
virtual void setBriefDescription (const DString &b, const DString &briefFile, int briefLine)=0
virtual void setInbodyDocumentation (const DString &d, const DString &docFile, int docLine)=0
virtual void setReference (const DString &r)=0
virtual void setBodySegment (int defLine, int bls, int ble)=0
virtual void setBodyDef (const FileDef *fd)=0
virtual void setRefItems (const RefItemVector &sli)=0
virtual void setRequirementReferences (const RequirementRefs &rqli)=0
virtual void setOuterScope (Definition *d)=0
virtual void setHidden (bool b)=0
virtual void setArtificial (bool b)=0
virtual void setExported (bool b)=0
virtual void setLanguage (SrcLangExt lang)=0
virtual void setLocalName (const DString &name)=0
virtual void makePartOfGroup (GroupDef *gd)=0
virtual void addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)=0
virtual void addSourceReferencedBy (MemberDef *d, const DString &sourceRefName)=0
virtual void addSourceReferences (MemberDef *d, const DString &sourceRefName)=0
virtual void mergeRefItems (Definition *d)=0
virtual void addInnerCompound (Definition *d)=0
virtual void mergeReferences (const Definition *other)=0
virtual void mergeReferencedBy (const Definition *other)=0
virtual void computeTooltip ()=0
virtual void writeSourceDef (OutputList &ol) const =0
virtual void writeInlineCode (OutputList &ol, const DString &scopeName) const =0
virtual bool hasSourceRefs () const =0
virtual bool hasSourceReffedBy () const =0
virtual void writeSourceRefs (OutputList &ol, const DString &scopeName) const =0
virtual void writeSourceReffedBy (OutputList &ol, const DString &scopeName) const =0
virtual bool hasRequirementRefs () const =0
virtual void writeRequirementRefs (OutputList &ol) const =0
virtual void writeNavigationPath (OutputList &ol) const =0
virtual void writeQuickMemberLinks (OutputList &, const MemberDef *) const =0
virtual void writeSummaryLinks (OutputList &) const =0
virtual void writePageNavigation (OutputList &) const =0
virtual void writeDocAnchorsToTagFile (TextStream &) const =0
virtual void writeToc (OutputList &ol, const LocalToc &lt) const =0
Public Member Functions inherited from NamespaceDef
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

Definition at line 100 of file namespacedef.h.

Member Function Documentation

◆ addListReferences()

virtual void NamespaceDefMutable::addListReferences ( )
pure virtual

Implemented in NamespaceDefImpl.

References addListReferences().

Referenced by addListReferences().

◆ addMembersToMemberGroup()

virtual void NamespaceDefMutable::addMembersToMemberGroup ( )
pure virtual

Implemented in NamespaceDefImpl.

References addMembersToMemberGroup().

Referenced by addMembersToMemberGroup(), and addMembersToMemberGroup().

◆ addRequirementReferences()

virtual void NamespaceDefMutable::addRequirementReferences ( )
pure virtual

Implemented in NamespaceDefImpl.

References addRequirementReferences().

Referenced by addRequirementReferences().

◆ addUsingDeclaration()

virtual void NamespaceDefMutable::addUsingDeclaration ( const Definition * d)
pure virtual

Implemented in NamespaceDefImpl.

References addUsingDeclaration().

Referenced by addUsingDeclaration(), findUsingDeclarations(), and findUsingDeclImports().

◆ addUsingDirective()

virtual void NamespaceDefMutable::addUsingDirective ( NamespaceDef * nd)
pure virtual

Implemented in NamespaceDefImpl.

References addUsingDirective().

Referenced by addUsingDirective(), and findUsingDirectives().

◆ combineUsingRelations()

virtual void NamespaceDefMutable::combineUsingRelations ( NamespaceDefSet & visitedNamespace)
pure virtual

Implemented in NamespaceDefImpl.

References combineUsingRelations().

Referenced by combineUsingRelations(), FileDefImpl::combineUsingRelations(), NamespaceDefImpl::combineUsingRelations(), and combineUsingRelations().

◆ computeAnchors()

virtual void NamespaceDefMutable::computeAnchors ( )
pure virtual

Implemented in NamespaceDefImpl.

References computeAnchors().

Referenced by computeAnchors(), and computeMemberReferences().

◆ countMembers()

virtual void NamespaceDefMutable::countMembers ( )
pure virtual

Implemented in NamespaceDefImpl.

References countMembers().

Referenced by countMembers(), and countMembers().

◆ distributeMemberGroupDocumentation()

virtual void NamespaceDefMutable::distributeMemberGroupDocumentation ( )
pure virtual

Implemented in NamespaceDefImpl.

References distributeMemberGroupDocumentation().

Referenced by distributeMemberGroupDocumentation(), and distributeMemberGroupDocumentation().

◆ findSectionsInDocumentation()

virtual void NamespaceDefMutable::findSectionsInDocumentation ( )
pure virtual

Implemented in NamespaceDefImpl.

References findSectionsInDocumentation().

Referenced by findSectionsInDocumentation(), and findSectionsInDocumentation().

◆ insertClass()

virtual void NamespaceDefMutable::insertClass ( ClassDef * cd)
pure virtual

Implemented in NamespaceDefImpl.

References insertClass().

Referenced by insertClass().

◆ insertConcept()

virtual void NamespaceDefMutable::insertConcept ( ConceptDef * cd)
pure virtual

Implemented in NamespaceDefImpl.

References insertConcept().

Referenced by insertConcept().

◆ insertMember()

virtual void NamespaceDefMutable::insertMember ( MemberDef * md)
pure virtual

Implemented in NamespaceDefImpl.

References insertMember().

Referenced by addGlobalFunction(), addVariableToFile(), findEnums(), findUsingDeclImports(), NamespaceDefImpl::insertMember(), insertMember(), and insertMemberAlias().

◆ insertNamespace()

virtual void NamespaceDefMutable::insertNamespace ( NamespaceDef * nd)
pure virtual

Implemented in NamespaceDefImpl.

References insertNamespace().

Referenced by insertNamespace().

◆ insertUsedFile()

virtual void NamespaceDefMutable::insertUsedFile ( FileDef * fd)
pure virtual

Implemented in NamespaceDefImpl.

References insertUsedFile().

Referenced by buildNamespaceList(), findUsingDirectives(), and insertUsedFile().

◆ setFileName()

virtual void NamespaceDefMutable::setFileName ( const DString & fn)
pure virtual

Implemented in NamespaceDefImpl.

References setFileName().

Referenced by buildNamespaceList(), and setFileName().

◆ setInline()

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

Implemented in NamespaceDefImpl.

References createNamespaceDef(), createNamespaceDefAlias(), getResolvedNamespace(), NamespaceDef::isInline(), Definition::name(), replaceNamespaceAliases(), setInline(), toNamespaceDef(), and toNamespaceDefMutable().

Referenced by buildNamespaceList(), findUsingDirectives(), and setInline().

◆ setMetaData()

virtual void NamespaceDefMutable::setMetaData ( const DString & m)
pure virtual

Implemented in NamespaceDefImpl.

References setMetaData().

Referenced by buildNamespaceList(), findUsingDirectives(), and setMetaData().

◆ sortMemberLists()

virtual void NamespaceDefMutable::sortMemberLists ( )
pure virtual

Implemented in NamespaceDefImpl.

References sortMemberLists().

Referenced by sortMemberLists(), and sortMemberLists().

◆ writeDocumentation()

virtual void NamespaceDefMutable::writeDocumentation ( OutputList & ol)
pure virtual

Implemented in NamespaceDefImpl.

References writeDocumentation().

Referenced by generateNamespaceDocs(), and writeDocumentation().

◆ writeMemberPages()

virtual void NamespaceDefMutable::writeMemberPages ( OutputList & ol)
pure virtual

Implemented in NamespaceDefImpl.

References writeMemberPages().

Referenced by writeMemberPages().

◆ writeTagFile()

virtual void NamespaceDefMutable::writeTagFile ( TextStream & )
pure virtual

Implemented in NamespaceDefImpl.

References writeTagFile().

Referenced by writeTagFile(), and writeTagFile().

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