mrdocs::RecordSymbol

Metadata for struct, class, or union.

Synopsis

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

struct RecordSymbol final
    : SymbolCommonBase<SymbolKind::Record>

Base Classes

Name Description

SymbolCommonBase<SymbolKind::Record>

Base class for providing variant discriminator functions.

Member Functions

Name

Description

RecordSymbol [constructor]

Create a record symbol bound to an ID.

operator<=>

Compare records including bases, members, and flags.

Data Members

Name

Description

Bases

List of immediate bases.

Derived

List of derived classes

Friends

List of friends.

Interface

Lists of members.

IsFinal

Whether the class is marked final.

IsFinalDestructor

Whether the destructor is marked final.

IsTypeDef

Whether the record originated from a typedef‐style declaration.

KeyKind

Kind of record this is (class, struct, or union).

Template

When present, this record is a template or specialization.

Static Data Members

Name

kind_id

Non-Member Functions

Name

Description

allMembers

View all record members across access levels.

canMerge

Check whether two symbols may be merged.

getPrimaryLocation

Determine a location to use when none is explicitly chosen.

merge

Merges two Symbol objects.

merge

Merge metadata from another record of the same identity.

Created with MrDocs