mrdocs::EnumSymbol

Metadata for an enumeration declaration.

Synopsis

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

struct EnumSymbol final
    : SymbolCommonBase<SymbolKind::Enum>

Base Classes

Name

Description

SymbolCommonBase<SymbolKind::Enum>

Base class for providing variant discriminator functions.

Member Functions

Name

Description

EnumSymbol [constructor]

Construct an enum symbol with its ID.

Static Member Functions

Name

Data Members

Name

Description

Constants

The members of this scope.

Scoped

Indicates whether this enum is scoped (e.g. enum class).

UnderlyingType

The underlying type of this enum, if explicitly specified.

Static Data Members

Name

kind_id

Non-Member Functions

Name

Description

allMembers

Return the list of enum constants for this symbol.

canMerge

Check whether two symbols may be merged.

getPrimaryLocation

Determine a location to use when none is explicitly chosen.

Created with MrDocs