mrdocs::Symbol

Base class with common properties of all symbols

Synopsis

Declared in <mrdocs/Metadata/Symbol/SymbolBase.hpp>

struct Symbol;

Member Functions

NameDescription
~Symbol [destructor] [virtual]Polymorphic base needs a virtual destructor.
asInfo asInfo overloads

Data Members

NameDescription
Access Declaration access.
Anchor A legible, filesystem- and URL-safe name for this symbol.
Attributes The C++ attributes attached to this declaration.
Extraction Determine why a symbol is extracted.
IsCopyFromInherited Whether this a copy of an inherited method, as produced when inherit-base-members is not never.
Kind Kind of declaration.
Loc The source location information.
Name The unqualified name.
Parent The parent symbol, if any.
doc The extracted documentation for this declaration.
id The unique identifier for this symbol.

Protected Member Functions

NameDescription
Symbol [constructor]Constructors

Non-Member Functions

NameDescription
buildSymbolDomBuild the DOM value for a single symbol.
canMergeCheck whether two symbols may be merged.
getPrimaryLocationDetermine a location to use when none is explicitly chosen.

Derived Classes

NameDescription
SymbolCommonBase Base class for providing variant discriminator functions.