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>
, BlockContainerDescription
This paragraph represents an admonition, such as a note, tip, important, caution, or warning.
Syntax:
@note textBase Classes
Name |
Description |
Base class for providing variant discriminator functions. |
|
A composite block that stores a sequence of child blocks. |
Member Functions
Name |
Description |
|
Construct an admonition with the given kind. |
|
Non-Member Functions
Name |
Description |
Determine if the inline is empty |
|
Removes leading whitespace from the first text elements |
|
Removes leading whitespace from the block. |
|
Removes trailing whitespace from the last text elements |
|
Removes trailing whitespace from the block. |
|
Removes leading and trailing whitespace from the block. |
|
Removes leading and trailing whitespace from the text elements |
Created with MrDocs