mrdocs::Name

Represents a name for a named Type

Synopsis

Declared in <mrdocs/Metadata/Name/NameBase.hpp>

struct Name;

Description

When the Type is a named type, this class represents the name of the type.

It also includes the symbol ID of the named type, so that it can be referenced in the documentation.

This allows the Type to store either a Name or a SpecializationName, which contains the arguments for a template specialization without requiring the application to extract an unnecessary symbol.

Member Functions

Name

Description

~Name [destructor] [virtual]

Virtual destructor for polymorphic cleanup.

asName

asName overloads

operator==

Equality compares all fields.

operator<=>

Order names by kind, identifier, id, and prefix.

Data Members

Name

Description

Identifier

The unqualified name.

Kind

The kind of name this is.

Prefix

The parent name info, if any.

id

The SymbolID of the named symbol, if it exists.

Protected Member Functions

Name

Description

Name [constructor]

Constructors

Non-Member Functions

Name

Description

toString

Convert the name to a human‐readable string.

Derived Classes

Name Description

IdentifierName

Represents an identifier

SpecializationName

Represents a (possibly qualified) symbol name with template arguments.

Created with MrDocs