mrdocs::IdentifierName

Represents an identifier

Synopsis

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

struct IdentifierName final
    : Name

Description

This class is used to represent an identifier that could be in the corpus or not.

When the symbol is in the corpus, the id field will be set to the symbol ID of the symbol.

When the symbol is not in the corpus, the id field will be set to SymbolID::invalid.

Base Classes

Name Description

Name

Represents a name for a named Type

Member Functions

Name

Description

IdentifierName [constructor]

Default‐construct an identifier with kind Identifier.

asName

asName overloads

operator==

Equality compares all fields.

operator<=>

Three‐way comparison operators

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.

Non-Member Functions

Name

Description

toString

Convert the name to a human‐readable string.

Created with MrDocs