mrdocs::doc::AdmonitionBlock

A block for side‐notes like tips, warnings, notes

Synopsis

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

struct AdmonitionBlock final
    : BlockCommonBase<BlockKind::Admonition>
    , BlockContainer

Description

This paragraph represents an admonition, such as a note, tip, important, caution, or warning.

Base Classes

Name Description

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

BlockCommonBase<BlockKind::Admonition>

Base class for providing variant discriminator functions.

BlockContainer

Member Functions

Name

Description

AdmonitionBlock [constructor]

Default constructor

asBlockContainer

operator==

Equality operators

operator<=>

Three‐way comparison operators

Static Member Functions

Name

isFootnoteDefinition

Data Members

Name

Description

Title

Optional title for the admonition

admonish

The kind of admonition

blocks

Static Data Members

Name

kind_id

Non-Member Functions

Name

Description

isEmpty

Determine if the inline is empty

ltrim

Removes leading whitespace from the first text elements

ltrim

Removes leading whitespace from the block.

rtrim

Removes trailing whitespace from the last text elements

rtrim

Removes trailing whitespace from the block.

trim

Removes leading and trailing whitespace from the block.

trim

Removes leading and trailing whitespace from the text elements

Created with MrDocs