mrdocs::SymbolCommonBase
Base class for providing variant discriminator functions.
Synopsis
Declared in <mrdocs/Metadata/Symbol/SymbolBase.hpp>
template<SymbolKind K>
struct SymbolCommonBase
: SymbolDescription
This offers functions that return a boolean at compile‐time, indicating if the most‐derived class is a certain type.
Data Members
Name |
Description |
Declaration access. |
|
A legible, filesystem‐ and URL‐safe name for this symbol. |
|
The C++ attributes attached to this declaration. |
|
Determine why a symbol is extracted. |
|
The base class this symbol was inherited from. |
|
Kind of declaration. |
|
The source location information. |
|
The unqualified name. |
|
The parent symbol, if any. |
|
The extracted documentation for this declaration. |
|
The unique identifier for this symbol. |
Protected Member Functions
Name |
Description |
|
Constructors |
Non-Member Functions
Name |
Description |
Build the DOM value for a single symbol. |
|
Check whether two symbols may be merged. |
|
Determine a location to use when none is explicitly chosen. |
|
Derived Classes
Name |
Description |
Info for concepts. |
|
Info for enum constants. |
|
Metadata for an enumeration declaration. |
|
Metadata for a function or method. |
|
Info for deduction guides. |
|
Info for preprocessor macros. |
|
Info for namespace aliases. |
|
Describes a namespace and its members. |
|
Represents a set of function overloads. |
|
Metadata for struct, class, or union. |
|
Info for typedef and using declarations. |
|
Info for using declarations. |
|
A variable. |
Created with MrDocs