mrdocs::doc::ReferenceInline

A reference to a symbol.

Synopsis

Declared in <mrdocs/Metadata/DocComment/Inline/ReferenceInline.hpp>

struct ReferenceInline
    : InlineCommonBase<InlineKind::Reference>

Base Classes

Name

Description

InlineCommonBase<InlineKind::Reference>

Base class for providing variant discriminator functions.

Member Functions

Name

Description

ReferenceInline [constructor]

Construct from string

operator==

Equality operator

operator<=>

Three‐way comparison operators

Static Member Functions

Name

isCode

isCopyDetails

isEmph

isFootnoteReference

isHighlight

isImage

isLineBreak

isLink

isMath

isReference

isSoftBreak

isStrikethrough

isStrong

isSubscript

isSuperscript

isText

Data Members

Name

id

literal

Static Data Members

Name

kind_id

Non-Member Functions

Name

Description

getAsPlainText

Get the plain text representation of an inline element tree.

getAsPlainText

Get the plain text representation of an inline element tree.

Created with MrDocs