mrdocs::doc::TableBlock

A table block

Synopsis

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

struct TableBlock final
    : BlockCommonBase<BlockKind::Table>

Description

Syntax:

| Header 1 | Header 2 | Header 3 |
| :------- | :------: | -------: |
| Left     | Center   | Right    |
| Cell 1A  | Cell 1B  | Cell 1C  |
| Cell 2A  | Cell 2B  | Cell 2C  |

Base Classes

Name

Description

BlockCommonBase<BlockKind::Table>

Base class for providing variant discriminator functions.

Static Member Functions

Name

isFootnoteDefinition

Data Members

Name

Description

Alignments

Column alignments for each table column.

items

Rows that make up the table body (header first when present).

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.

Created with MrDocs