mrdocs::MacroSymbol

Info for preprocessor macros.

Synopsis

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

struct MacroSymbol final
    : SymbolCommonBase<SymbolKind::Macro>

Description

Covers both object-like and function-like macros.

Base Classes

NameDescription
SymbolCommonBase<SymbolKind::Macro>Base class for providing variant discriminator functions.

Member Functions

NameDescription
MacroSymbol [constructor]Create a macro symbol bound to an ID.

Static Member Functions

Name
isConcept
isEnum
isEnumConstant
isFunction
isGuide
isMacro
isNamespace
isNamespaceAlias
isOverloads
isRecord
isTypedef
isUsing
isVariable

Data Members

NameDescription
IsFunctionLike Whether this is a function-like macro.
IsVariadic Whether the macro takes a variadic argument list.
Parameters The names of the macro's parameters.

Static Data Members

NameDescription
kind_id The variant discriminator constant of the most-derived class.

Non-Member Functions

NameDescription
buildSymbolDomBuild the DOM value for a single symbol.
canMergeCheck whether two symbols may be merged.
getPrimaryLocationDetermine a location to use when none is explicitly chosen.