mrdocs::doc::FootnoteReferenceInline

A reference to a symbol.

Synopsis

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

struct FootnoteReferenceInline
    : InlineCommonBase<InlineKind::FootnoteReference>

Description

In markdown, this is represented as "label".

Syntax:

[^footnote-id]

Base Classes

Name

Description

InlineCommonBase<InlineKind::FootnoteReference>

Base class for providing variant discriminator functions.

Static Member Functions

Name

isCode

isCopyDetails

isEmph

isFootnoteReference

isHighlight

isImage

isLineBreak

isLink

isMath

isReference

isSoftBreak

isStrikethrough

isStrong

isSubscript

isSuperscript

isText

Data Members

Name

Description

label

Footnote label that the reference points to.

Static Data Members

Name

Description

kind_id

The variant discriminator constant of the most‐derived class.

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