mrdocs::doc::Block

A piece of block content

Synopsis

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

struct Block;

Description

The top level is a list of blocks.

There are two types of blocks: headings and paragraphs.

Member Functions

Name

Description

~Block [destructor] [virtual]

Destructor

asBlock

operator==

Equality operator

operator<=>

Three‐way comparison operator

Data Members

Name

Kind

Protected Member Functions

Name

Description

Block [constructor]

Constructors

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

BlockCommonBase

Base class for providing variant discriminator functions.

Created with MrDocs