mrdocs::doc::BlockCommonBase

Base class for providing variant discriminator functions.

Synopsis

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

template<BlockKind K>
struct BlockCommonBase
    : Block

Description

This offers functions that return a boolean at compile‐time, indicating if the most‐derived class is a certain type.

Base Classes

Name Description

Block

A piece of block content

Member Functions

Name

Description

~BlockCommonBase [destructor] [virtual]

Destructor

asBlock

operator==

Equality operator

operator<=>

Three‐way comparison operators

Data Members

Name

Kind

Static Data Members

Name

Description

kind_id

The variant discriminator constant of the most‐derived class.

Protected Member Functions

Name

Description

BlockCommonBase [constructor]

Default constructor

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.

Derived Classes

Name Description

AdmonitionBlock

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

BriefBlock

The brief description

CodeBlock

Preformatted source code.

DefinitionListBlock

FootnoteDefinitionBlock

Preformatted source code.

HeadingBlock

A manually specified section heading.

ListBlock

A list of list items

MathBlock

A block of LaTeX math

ParagraphBlock

A sequence of text nodes.

ParamBlock

Documentation for a function parameter

PostconditionBlock

PreconditionBlock

QuoteBlock

A list of list items

ReturnsBlock

Documentation for a function return type

SeeBlock

A

TParamBlock

Documentation for a template parameter

TableBlock

A table block

ThematicBreakBlock

The brief description

ThrowsBlock

Documentation for a function parameter

Created with MrDocs