NamespaceDefAliasImpl Class Reference

Inheritance diagram for NamespaceDefAliasImpl:

Collaboration diagram for NamespaceDefAliasImpl:

Public Member Functions
	NamespaceDefAliasImpl (const Definition *newScope, const NamespaceDef *nd)
	~NamespaceDefAliasImpl () override
DefType	definitionType () const override
const NamespaceDef *	getNSAlias () const
CodeSymbolType	codeSymbolType () const override
DString	getOutputFileBase () const override
DString	anchor () const override
int	numDocMembers () const override
const LinkedRefMap< NamespaceDef > &	getUsedNamespaces () const override
const LinkedRefMap< const Definition > &	getUsedDefinitions () const override
DString	displayName (bool b=true) const override
const DString &	localName () const override
bool	isConstantGroup () const override
bool	isModule () const override
bool	isLibrary () const override
bool	isInline () const override
bool	isLinkableInProject () const override
bool	isLinkable () const override
bool	isVisibleInHierarchy () const override
bool	hasDetailedDescription () const override
const Definition *	findInnerCompound (const DString &name) const override
bool	subGrouping () const override
MemberList *	getMemberList (MemberListType lt) const override
const MemberLists &	getMemberLists () const override
const MemberDef *	getMemberByName (const DString &name) const override
const MemberGroupList &	getMemberGroups () const override
ClassLinkedRefMap	getClasses () const override
ClassLinkedRefMap	getInterfaces () const override
ClassLinkedRefMap	getStructs () const override
ClassLinkedRefMap	getExceptions () const override
NamespaceLinkedRefMap	getNamespaces () const override
ConceptLinkedRefMap	getConcepts () const override
DString	title () const override
DString	compoundTypeString () const override
int	countVisibleMembers () const override
Public Member Functions inherited from DefinitionAliasMixin< NamespaceDef >
	DefinitionAliasMixin (const Definition *scope, const Definition *alias)
	~DefinitionAliasMixin () override=default
void	init ()
void	deinit ()
bool	isAlias () const override
const DString &	name () const override
bool	isAnonymous () const override
DString	qualifiedName () const override
DString	symbolName () const override
DString	getSourceFileBase () const override
DString	getSourceAnchor () const override
DString	documentation () const override
int	docLine () const override
DString	docFile () const override
DString	briefDescription (bool abbreviate=false) const override
DString	briefDescriptionAsTooltip () const override
int	briefLine () const override
DString	inbodyDocumentation () const override
DString	inbodyFile () const override
int	inbodyLine () const override
DString	briefFile () const override
DString	getDefFileName () const override
DString	getDefFileExtension () const override
int	getDefLine () const override
size_t	getDefColumn () const override
bool	hasDocumentation () const override
bool	hasUserDocumentation () const override
bool	isVisibleInProject () const override
bool	isVisible () const override
bool	isHidden () const override
bool	isArtificial () const override
bool	isExported () const override
DString	getReference () const override
bool	isReference () const override
DString	externalReference (const DString &relPath) const override
int	getStartDefLine () const override
int	getStartBodyLine () const override
int	getEndBodyLine () const override
const FileDef *	getBodyDef () const override
SrcLangExt	getLanguage () const override
const GroupList &	partOfGroups () const override
bool	isLinkableViaGroup () const override
const RefItemVector &	xrefListItems () const override
const RequirementRefs &	requirementReferences () const override
Definition *	getOuterScope () const override
const MemberVector &	getReferencesMembers () const override
const MemberVector &	getReferencedByMembers () const override
bool	hasSections () const override
bool	hasSources () const override
bool	hasBriefDescription () const override
DString	id () const override
const SectionRefs &	getSectionRefs () const override
DString	navigationPathAsString () const override
DString	pathFragment () const override

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 }
Protected Member Functions inherited from DefinitionAliasMixin< NamespaceDef >
const Definition *	getAlias () const
const Definition *	getScope () const

Detailed Description

Definition at line 184 of file namespacedef.cpp.

Constructor & Destructor Documentation

NamespaceDefAliasImpl()

NamespaceDefAliasImpl::NamespaceDefAliasImpl ( const Definition * newScope, const NamespaceDef * nd )

inline

Definition at line 187 of file namespacedef.cpp.

      : DefinitionAliasMixin(newScope,nd) { init(); }

References DefinitionAliasMixin< NamespaceDef >::DefinitionAliasMixin(), and DefinitionAliasMixin< NamespaceDef >::init().

~NamespaceDefAliasImpl()

NamespaceDefAliasImpl::~NamespaceDefAliasImpl ( )

inlineoverride

Definition at line 189 of file namespacedef.cpp.

{ deinit(); }

References DefinitionAliasMixin< NamespaceDef >::deinit().

Member Function Documentation

anchor()

DString NamespaceDefAliasImpl::anchor ( ) const

inlineoverridevirtual

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

Implements Definition.

Definition at line 201 of file namespacedef.cpp.

    { return getNSAlias()->anchor(); }

References Definition::anchor(), and getNSAlias().

codeSymbolType()

CodeSymbolType NamespaceDefAliasImpl::codeSymbolType ( ) const

inlineoverridevirtual

Used for syntax highlighting symbol class

Implements Definition.

Definition at line 197 of file namespacedef.cpp.

    { return getNSAlias()->codeSymbolType(); }

References Definition::codeSymbolType(), and getNSAlias().

compoundTypeString()

DString NamespaceDefAliasImpl::compoundTypeString ( ) const

inlineoverridevirtual

Implements NamespaceDef.

Definition at line 255 of file namespacedef.cpp.

    { return getNSAlias()->compoundTypeString(); }

References NamespaceDef::compoundTypeString(), and getNSAlias().

countVisibleMembers()

int NamespaceDefAliasImpl::countVisibleMembers ( ) const

inlineoverridevirtual

Implements NamespaceDef.

Definition at line 257 of file namespacedef.cpp.

    { return getNSAlias()->countVisibleMembers(); }

References NamespaceDef::countVisibleMembers(), and getNSAlias().

definitionType()

DefType NamespaceDefAliasImpl::definitionType ( ) const

inlineoverridevirtual

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

Implements Definition.

Definition at line 192 of file namespacedef.cpp.

{ return TypeNamespace; }

References definitionType(), and Definition::TypeNamespace.

Referenced by definitionType().

displayName()

DString NamespaceDefAliasImpl::displayName ( bool includeScope = true ) const

inlineoverridevirtual

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

Implements Definition.

Definition at line 209 of file namespacedef.cpp.

    { return makeDisplayName(this,b); }

References makeDisplayName().

findInnerCompound()

const Definition * NamespaceDefAliasImpl::findInnerCompound ( const DString & name ) const

inlineoverridevirtual

Reimplemented from DefinitionAliasMixin< NamespaceDef >.

Definition at line 229 of file namespacedef.cpp.

    { return getNSAlias()->findInnerCompound(name); }

References Definition::findInnerCompound(), getNSAlias(), and DefinitionAliasMixin< NamespaceDef >::name().

getClasses()

ClassLinkedRefMap NamespaceDefAliasImpl::getClasses ( ) const

inlineoverridevirtual

Returns the classes contained in this namespace

Implements NamespaceDef.

Definition at line 241 of file namespacedef.cpp.

    { return getNSAlias()->getClasses(); }

References NamespaceDef::getClasses(), and getNSAlias().

getConcepts()

ConceptLinkedRefMap NamespaceDefAliasImpl::getConcepts ( ) const

inlineoverridevirtual

Returns the concepts contained in this namespace

Implements NamespaceDef.

Definition at line 251 of file namespacedef.cpp.

    { return getNSAlias()->getConcepts(); }

References NamespaceDef::getConcepts(), and getNSAlias().

getExceptions()

ClassLinkedRefMap NamespaceDefAliasImpl::getExceptions ( ) const

inlineoverridevirtual

Returns the Slice exceptions contained in this namespace

Implements NamespaceDef.

Definition at line 247 of file namespacedef.cpp.

    { return getNSAlias()->getExceptions(); }

References NamespaceDef::getExceptions(), and getNSAlias().

getInterfaces()

ClassLinkedRefMap NamespaceDefAliasImpl::getInterfaces ( ) const

inlineoverridevirtual

Returns the Slice interfaces contained in this namespace

Implements NamespaceDef.

Definition at line 243 of file namespacedef.cpp.

    { return getNSAlias()->getInterfaces(); }

References NamespaceDef::getInterfaces(), and getNSAlias().

getMemberByName()

const MemberDef * NamespaceDefAliasImpl::getMemberByName ( const DString & name ) const

inlineoverridevirtual

Implements NamespaceDef.

Definition at line 237 of file namespacedef.cpp.

    { return getNSAlias()->getMemberByName(name); }

References NamespaceDef::getMemberByName(), getNSAlias(), and DefinitionAliasMixin< NamespaceDef >::name().

getMemberGroups()

const MemberGroupList & NamespaceDefAliasImpl::getMemberGroups ( ) const

inlineoverridevirtual

Returns the user defined member groups

Implements NamespaceDef.

Definition at line 239 of file namespacedef.cpp.

    { return getNSAlias()->getMemberGroups(); }

References NamespaceDef::getMemberGroups(), and getNSAlias().

getMemberList()

MemberList * NamespaceDefAliasImpl::getMemberList ( MemberListType lt ) const

inlineoverridevirtual

Implements NamespaceDef.

Definition at line 233 of file namespacedef.cpp.

    { return getNSAlias()->getMemberList(lt); }

References NamespaceDef::getMemberList(), and getNSAlias().

getMemberLists()

const MemberLists & NamespaceDefAliasImpl::getMemberLists ( ) const

inlineoverridevirtual

Implements NamespaceDef.

Definition at line 235 of file namespacedef.cpp.

    { return getNSAlias()->getMemberLists(); }

References NamespaceDef::getMemberLists(), and getNSAlias().

getNamespaces()

NamespaceLinkedRefMap NamespaceDefAliasImpl::getNamespaces ( ) const

inlineoverridevirtual

Returns the namespaces contained in this namespace

Implements NamespaceDef.

Definition at line 249 of file namespacedef.cpp.

    { return getNSAlias()->getNamespaces(); }

References NamespaceDef::getNamespaces(), and getNSAlias().

getNSAlias()

const NamespaceDef * NamespaceDefAliasImpl::getNSAlias ( ) const

inline

Definition at line 194 of file namespacedef.cpp.

{ return toNamespaceDef(getAlias()); }

References DefinitionAliasMixin< NamespaceDef >::getAlias(), and toNamespaceDef().

Referenced by anchor(), codeSymbolType(), compoundTypeString(), countVisibleMembers(), findInnerCompound(), getClasses(), getConcepts(), getExceptions(), getInterfaces(), getMemberByName(), getMemberGroups(), getMemberList(), getMemberLists(), getNamespaces(), getOutputFileBase(), getStructs(), getUsedDefinitions(), getUsedNamespaces(), hasDetailedDescription(), isConstantGroup(), isInline(), isLibrary(), isLinkable(), isLinkableInProject(), isModule(), isVisibleInHierarchy(), localName(), numDocMembers(), subGrouping(), and title().

getOutputFileBase()

DString NamespaceDefAliasImpl::getOutputFileBase ( ) const

inlineoverridevirtual

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

Implements Definition.

Definition at line 199 of file namespacedef.cpp.

    { return getNSAlias()->getOutputFileBase(); }

References getNSAlias(), and Definition::getOutputFileBase().

getStructs()

ClassLinkedRefMap NamespaceDefAliasImpl::getStructs ( ) const

inlineoverridevirtual

Returns the Slice structs contained in this namespace

Implements NamespaceDef.

Definition at line 245 of file namespacedef.cpp.

    { return getNSAlias()->getStructs(); }

References getNSAlias(), and NamespaceDef::getStructs().

getUsedDefinitions()

const LinkedRefMap< const Definition > & NamespaceDefAliasImpl::getUsedDefinitions ( ) const

inlineoverridevirtual

Implements NamespaceDef.

Definition at line 207 of file namespacedef.cpp.

    { return getNSAlias()->getUsedDefinitions(); }

References getNSAlias(), and NamespaceDef::getUsedDefinitions().

getUsedNamespaces()

const LinkedRefMap< NamespaceDef > & NamespaceDefAliasImpl::getUsedNamespaces ( ) const

inlineoverridevirtual

Implements NamespaceDef.

Definition at line 205 of file namespacedef.cpp.

    { return getNSAlias()->getUsedNamespaces(); }

References getNSAlias(), and NamespaceDef::getUsedNamespaces().

hasDetailedDescription()

bool NamespaceDefAliasImpl::hasDetailedDescription ( ) const

inlineoverridevirtual

Implements NamespaceDef.

Definition at line 227 of file namespacedef.cpp.

    { return getNSAlias()->hasDetailedDescription(); }

References getNSAlias(), and NamespaceDef::hasDetailedDescription().

isConstantGroup()

bool NamespaceDefAliasImpl::isConstantGroup ( ) const

inlineoverridevirtual

Implements NamespaceDef.

Definition at line 213 of file namespacedef.cpp.

    { return getNSAlias()->isConstantGroup(); }

References getNSAlias(), and NamespaceDef::isConstantGroup().

isInline()

bool NamespaceDefAliasImpl::isInline ( ) const

inlineoverridevirtual

Implements NamespaceDef.

Definition at line 219 of file namespacedef.cpp.

    { return getNSAlias()->isInline(); }

References getNSAlias(), and NamespaceDef::isInline().

isLibrary()

bool NamespaceDefAliasImpl::isLibrary ( ) const

inlineoverridevirtual

Implements NamespaceDef.

Definition at line 217 of file namespacedef.cpp.

    { return getNSAlias()->isLibrary(); }

References getNSAlias(), and NamespaceDef::isLibrary().

isLinkable()

bool NamespaceDefAliasImpl::isLinkable ( ) const

inlineoverridevirtual

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 Definition.

Definition at line 223 of file namespacedef.cpp.

    { return getNSAlias()->isLinkable(); }

References getNSAlias(), and Definition::isLinkable().

isLinkableInProject()

bool NamespaceDefAliasImpl::isLinkableInProject ( ) const

inlineoverridevirtual

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

Implements Definition.

Definition at line 221 of file namespacedef.cpp.

    { return getNSAlias()->isLinkableInProject(); }

References getNSAlias(), and Definition::isLinkableInProject().

isModule()

bool NamespaceDefAliasImpl::isModule ( ) const

inlineoverridevirtual

Implements NamespaceDef.

Definition at line 215 of file namespacedef.cpp.

    { return getNSAlias()->isModule(); }

References getNSAlias(), and NamespaceDef::isModule().

isVisibleInHierarchy()

bool NamespaceDefAliasImpl::isVisibleInHierarchy ( ) const

inlineoverridevirtual

Implements NamespaceDef.

Definition at line 225 of file namespacedef.cpp.

    { return getNSAlias()->isVisibleInHierarchy(); }

References getNSAlias(), and NamespaceDef::isVisibleInHierarchy().

localName()

const DString & NamespaceDefAliasImpl::localName ( ) const

inlineoverridevirtual

Returns the local name without any scope qualifiers.

Reimplemented from DefinitionAliasMixin< NamespaceDef >.

Definition at line 211 of file namespacedef.cpp.

    { return getNSAlias()->localName(); }

References getNSAlias(), and Definition::localName().

numDocMembers()

int NamespaceDefAliasImpl::numDocMembers ( ) const

inlineoverridevirtual

Implements NamespaceDef.

Definition at line 203 of file namespacedef.cpp.

    { return getNSAlias()->numDocMembers(); }

References getNSAlias(), and NamespaceDef::numDocMembers().

subGrouping()

bool NamespaceDefAliasImpl::subGrouping ( ) const

inlineoverridevirtual

Implements NamespaceDef.

Definition at line 231 of file namespacedef.cpp.

    { return getNSAlias()->subGrouping(); }

References getNSAlias(), and NamespaceDef::subGrouping().

title()

DString NamespaceDefAliasImpl::title ( ) const

inlineoverridevirtual

Implements NamespaceDef.

Definition at line 253 of file namespacedef.cpp.

    { return getNSAlias()->title(); }

References getNSAlias(), and NamespaceDef::title().

---

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

• src/namespacedef.cpp