mrdocs::GuideSymbol

Info for deduction guides.

Synopsis

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

struct GuideSymbol final
    : SymbolCommonBase<SymbolKind::Guide>

Base Classes

Name

Description

SymbolCommonBase<SymbolKind::Guide>

Base class for providing variant discriminator functions.

Member Functions

Name

Description

GuideSymbol [constructor]

Construct a deduction guide symbol with its ID.

operator<=>

Compare guides by what they deduce, then by their parameters and template head.

Static Member Functions

Name

Data Members

Name

Description

Deduced

The pattern for the deduced specialization.

Explicit

The explicit‐specifier, if any.

Params

The parameters of the deduction guide.

Template

Template head, if any.

Static Data Members

Name

Description

kind_id

The variant discriminator constant of the most‐derived class.

Non-Member Functions

Name

Description

buildSymbolDom

Build the DOM value for a single symbol.

canMerge

Check whether two symbols may be merged.

getPrimaryLocation

Determine a location to use when none is explicitly chosen.

Created with MrDocs