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]

Virtual to keep dynamic dispatch working for block hierarchies.

asBlock

asBlock overloads

Data Members

Name

Description

Kind

Discriminator identifying which concrete block this instance holds.

Static Data Members

Name

Description

kind_id

The variant discriminator constant of the most‐derived class.

Protected Member Functions

Name

Description

BlockCommonBase [constructor]

Construct with the fixed block kind.

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

A list of terms paired with definitions.

FootnoteDefinitionBlock

Text defining the content of a footnote reference.

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

Text describing conditions guaranteed on successful exit.

PreconditionBlock

Text describing required conditions before entry.

QuoteBlock

A quoted block of text.

ReturnsBlock

Documentation for a function return type

SeeBlock

A

TParamBlock

Documentation for a template parameter

TableBlock

A table block

ThematicBreakBlock

A horizontal thematic break separating sections.

ThrowsBlock

Documentation for a function exception clause

Created with MrDocs