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.

Syntax:

@note text

Base Classes

Name

Description

BlockCommonBase<BlockKind::Admonition>

Base class for providing variant discriminator functions.

BlockContainer

A composite block that stores a sequence of child blocks.

Member Functions

Name

Description

AdmonitionBlock [constructor]

Construct an admonition with the given kind.

asBlockContainer

asBlockContainer overloads

Static Member Functions

Name

isFootnoteDefinition

Data Members

Name

Description

Title

Optional title for the admonition

admonish

The kind of admonition

blocks

Child blocks contained within this composite block.

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