mrdocs::doc::MathBlock

Synopsis

Declared in <mrdocs/Metadata/DocComment/Block/MathBlock.hpp>

struct MathBlock final
    : BlockCommonBase<BlockKind::Math>

Base Classes

Name Description

Name	Description
`BlockCommonBase<BlockKind::Math>`	Base class for providing variant discriminator functions.

BlockCommonBase<BlockKind::Math>

Base class for providing variant discriminator functions.

Member Functions

Name

Description

MathBlock [constructor]

Copy‐construct a math block.

operator=

Copy‐assign a math block.

operator<=>

Compare math blocks by literal content.

Static Member Functions

Name

isFootnoteDefinition

Data Members

Name

Description

literal

Raw TeX math source

Static Data Members

Name

kind_id

Non-Member Functions

Name

Description

isEmpty

Determine if the inline is empty

ltrim

Removes leading whitespace from the block.

rtrim

Removes trailing whitespace from the block.

trim

Removes leading and trailing whitespace from the block.

Description

A block of LaTeX math, typically between _ … _ or fenced with "math".

On a new line:

$$ \int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi} $$

Or as a code block:

```math
\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}
```

Created with MrDocs