mrdocs::doc::BlockContainer

A composite block that stores a sequence of child blocks.

Synopsis

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

struct BlockContainer;

Member Functions

Name

Description

asBlockContainer

asBlockContainer overloads

Data Members

Name

Description

blocks

Child blocks contained within this composite block.

Non-Member Functions

Name

Description

ltrim

Removes leading whitespace from the first text elements

rtrim

Removes trailing whitespace from the last text elements

trim

Removes leading and trailing whitespace from the text elements

Derived Classes

Name

Description

AdmonitionBlock

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

DefinitionListItem

An item in a definition list

FootnoteDefinitionBlock

Text defining the content of a footnote reference.

ListItem

An item in a ListBlock

QuoteBlock

A quoted block of text.

Created with MrDocs