mrdocs::doc::MathInline

An inline LaTeX math expression

Synopsis

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

struct MathInline
    : InlineCommonBase<InlineKind::Math>

Description

Inline LaTeX math, typically between \(…\).

Syntax:


$2 + 2 = 4$ or $x_{i+1}^2$

Base Classes

NameDescription
InlineCommonBase<InlineKind::Math>Base class for providing variant discriminator functions.

Member Functions

NameDescription
MathInline [constructor]Constructors
~MathInline [destructor] [virtual]Virtual destructor for inline hierarchy.

Static Member Functions

Name
isCode
isCopyDetails
isEmph
isFootnoteReference
isHighlight
isImage
isLineBreak
isLink
isMath
isReference
isSoftBreak
isStrikethrough
isStrong
isSubscript
isSuperscript
isText

Data Members

NameDescription
literal Raw LaTeX/TeX math content.

Static Data Members

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