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

Name

Description

InlineCommonBase<InlineKind::Math>

Base class for providing variant discriminator functions.

Member Functions

Name

Description

MathInline [constructor]

Constructors

~MathInline [destructor] [virtual]

Virtual destructor for inline hierarchy.

Static Member Functions

Name

isCode

isCopyDetails

isEmph

isFootnoteReference

Data Members

Name

Description

literal

Raw LaTeX/TeX math content.

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