Public Member Functions | List of all members
NamespaceDefImpl Class Reference
Inheritance diagram for NamespaceDefImpl:
Inheritance graph
Collaboration diagram for NamespaceDefImpl:
Collaboration graph

Public Member Functions

 NamespaceDefImpl (const QCString &defFileName, int defLine, int defColumn, const QCString &name, const QCString &ref=QCString(), const QCString &refFile=QCString(), const QCString &type=QCString(), bool isPublished=false)
virtual DefType definitionType () const
virtual CodeSymbolType codeSymbolType () const
virtual QCString getOutputFileBase () const
virtual QCString anchor () const
virtual void insertUsedFile (FileDef *fd)
virtual void writeDocumentation (OutputList &ol)
virtual void writeMemberPages (OutputList &ol)
virtual void writeQuickMemberLinks (OutputList &ol, const MemberDef *currentMd) const
virtual void writeTagFile (TextStream &)
virtual void insertClass (const ClassDef *cd)
virtual void insertConcept (const ConceptDef *cd)
virtual void insertNamespace (const NamespaceDef *nd)
virtual void insertMember (MemberDef *md)
virtual void computeAnchors ()
virtual void countMembers ()
virtual int numDocMembers () const
virtual void addUsingDirective (const NamespaceDef *nd)
virtual LinkedRefMap< const NamespaceDefgetUsedNamespaces () const
virtual void addUsingDeclaration (const ClassDef *cd)
virtual LinkedRefMap< const ClassDefgetUsedClasses () const
virtual void combineUsingRelations (NamespaceDefSet &visitedNamespace)
virtual QCString displayName (bool=TRUE) const
virtual QCString localName () const
virtual void setInline (bool isInline)
virtual bool isConstantGroup () const
virtual bool isModule () const
virtual bool isLibrary () const
virtual bool isInline () const
virtual bool isLinkableInProject () const
virtual bool isLinkable () const
virtual bool hasDetailedDescription () const
virtual void addMembersToMemberGroup ()
virtual void distributeMemberGroupDocumentation ()
virtual void findSectionsInDocumentation ()
virtual void sortMemberLists ()
virtual const DefinitionfindInnerCompound (const QCString &name) const
virtual void addInnerCompound (const Definition *d)
virtual void addListReferences ()
virtual void setFileName (const QCString &fn)
virtual bool subGrouping () const
virtual MemberListgetMemberList (MemberListType lt) const
virtual const MemberListsgetMemberLists () const
virtual const MemberDefgetMemberByName (const QCString &) const
virtual const MemberGroupListgetMemberGroups () const
virtual ClassLinkedRefMap getClasses () const
virtual ClassLinkedRefMap getInterfaces () const
virtual ClassLinkedRefMap getStructs () const
virtual ClassLinkedRefMap getExceptions () const
virtual NamespaceLinkedRefMap getNamespaces () const
virtual ConceptLinkedRefMap getConcepts () const
virtual QCString title () const
virtual QCString compoundTypeString () const
virtual void setMetaData (const QCString &m)
- Public Member Functions inherited from DefinitionMixin< NamespaceDefMutable >
 DefinitionMixin (const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char *b=0, const char *d=0, bool isSymbol=TRUE)
virtual bool isAlias () const
virtual QCString name () const
virtual bool isAnonymous () const
virtual QCString qualifiedName () const
virtual QCString symbolName () const
virtual QCString getSourceFileBase () const
virtual QCString getSourceAnchor () const
virtual QCString documentation () const
virtual int docLine () const
virtual QCString docFile () const
virtual QCString briefDescription (bool abbreviate=FALSE) const
virtual QCString briefDescriptionAsTooltip () const
virtual int briefLine () const
virtual QCString inbodyDocumentation () const
virtual QCString inbodyFile () const
virtual int inbodyLine () const
virtual QCString briefFile () const
virtual QCString getDefFileName () const
virtual QCString getDefFileExtension () const
virtual int getDefLine () const
virtual int getDefColumn () const
virtual bool hasDocumentation () const
virtual bool hasUserDocumentation () const
virtual bool isVisibleInProject () const
virtual bool isVisible () const
virtual bool isHidden () const
virtual bool isArtificial () const
virtual QCString getReference () const
virtual bool isReference () const
virtual QCString externalReference (const QCString &relPath) const
virtual int getStartDefLine () const
virtual int getStartBodyLine () const
virtual int getEndBodyLine () const
virtual const FileDefgetBodyDef () const
virtual SrcLangExt getLanguage () const
virtual const GroupListpartOfGroups () const
virtual bool isLinkableViaGroup () const
virtual const RefItemVector & xrefListItems () const
virtual DefinitiongetOuterScope () const
virtual const MemberVectorgetReferencesMembers () const
virtual const MemberVectorgetReferencedByMembers () const
virtual bool hasSections () const
virtual bool hasSources () const
virtual bool hasBriefDescription () const
virtual QCString id () const
virtual const SectionRefsgetSectionRefs () const
virtual void setName (const QCString &name)
virtual void setId (const QCString &name)
virtual void setDefFile (const QCString &df, int defLine, int defColumn)
virtual void setDocumentation (const QCString &doc, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)
virtual void setBriefDescription (const QCString &brief, const QCString &briefFile, int briefLine)
virtual void setInbodyDocumentation (const QCString &doc, const QCString &docFile, int docLine)
virtual void setReference (const QCString &r)
virtual void addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)
virtual void setBodySegment (int defLine, int bls, int ble)
virtual void setBodyDef (const FileDef *fd)
virtual void addSourceReferencedBy (const MemberDef *md)
virtual void addSourceReferences (const MemberDef *md)
virtual void setRefItems (const RefItemVector &sli)
virtual void mergeRefItems (Definition *def)
virtual void mergeReferences (const Definition *other)
virtual void mergeReferencedBy (const Definition *other)
virtual void setOuterScope (Definition *def)
virtual void setHidden (bool b)
virtual void setArtificial (bool b)
virtual void setLanguage (SrcLangExt lang)
virtual void writeSourceDef (OutputList &ol, const QCString &scopeName) const
virtual void writeInlineCode (OutputList &ol, const QCString &scopeName) const
virtual bool hasSourceRefs () const
virtual bool hasSourceReffedBy () const
virtual void writeSourceRefs (OutputList &ol, const QCString &scopeName) const
virtual void writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const
virtual void makePartOfGroup (const GroupDef *gd)
virtual void writeNavigationPath (OutputList &ol) const
virtual QCString navigationPathAsString () const
virtual QCString pathFragment () const
virtual void writeDocAnchorsToTagFile (TextStream &fs) const
virtual void setLocalName (const QCString &name)
virtual void addSectionsToIndex ()
virtual void writeToc (OutputList &ol, const LocalToc &lt) const
virtual void computeTooltip ()
virtual void _setSymbolName (const QCString &name)
virtual QCString _symbolName () const

Additional Inherited Members

- Public Types inherited from Definition
enum  DefType {
  TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3,
  TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7,
  TypeConcept = 8
- Protected Member Functions inherited from DefinitionMixin< NamespaceDefMutable >
 DefinitionMixin (const DefinitionMixin &def)=default

Member Function Documentation

◆ anchor()

virtual QCString NamespaceDefImpl::anchor ( ) const

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

Implements NamespaceDef.

◆ codeSymbolType()

virtual CodeSymbolType NamespaceDefImpl::codeSymbolType ( ) const

Used for syntax highlighting symbol class

Implements Definition.

◆ definitionType()

virtual DefType NamespaceDefImpl::definitionType ( ) const

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

Implements NamespaceDef.

◆ displayName()

QCString NamespaceDefImpl::displayName ( bool  includeScope = TRUE) const

Returns the name of the definition as it appears in the output

Implements NamespaceDef.

◆ getClasses()

virtual ClassLinkedRefMap NamespaceDefImpl::getClasses ( ) const

Returns the classes contained in this namespace

Implements NamespaceDef.

◆ getConcepts()

virtual ConceptLinkedRefMap NamespaceDefImpl::getConcepts ( ) const

Returns the concepts contained in this namespace

Implements NamespaceDef.

◆ getExceptions()

virtual ClassLinkedRefMap NamespaceDefImpl::getExceptions ( ) const

Returns the Slice exceptions contained in this namespace

Implements NamespaceDef.

◆ getInterfaces()

virtual ClassLinkedRefMap NamespaceDefImpl::getInterfaces ( ) const

Returns the Slice interfaces contained in this namespace

Implements NamespaceDef.

◆ getMemberGroups()

virtual const MemberGroupList& NamespaceDefImpl::getMemberGroups ( ) const

Returns the user defined member groups

Implements NamespaceDef.

◆ getNamespaces()

virtual NamespaceLinkedRefMap NamespaceDefImpl::getNamespaces ( ) const

Returns the namespaces contained in this namespace

Implements NamespaceDef.

◆ getOutputFileBase()

QCString NamespaceDefImpl::getOutputFileBase ( ) const

Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.

Implements NamespaceDef.

◆ getStructs()

virtual ClassLinkedRefMap NamespaceDefImpl::getStructs ( ) const

Returns the Slice structs contained in this namespace

Implements NamespaceDef.

◆ isLinkable()

bool NamespaceDefImpl::isLinkable ( ) const

Returns TRUE iff it is possible to link to this item. This can be a link to another project imported via a tag file.

Implements NamespaceDef.

◆ isLinkableInProject()

bool NamespaceDefImpl::isLinkableInProject ( ) const

Returns TRUE iff it is possible to link to this item within this project.

Implements NamespaceDef.

◆ localName()

QCString NamespaceDefImpl::localName ( ) const

Returns the local name without any scope qualifiers.

Reimplemented from DefinitionMixin< NamespaceDefMutable >.

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