mrdocs::doc::ListBlock

A list of list items

Synopsis

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

struct ListBlock final
    : BlockCommonBase<BlockKind::List>

Description

Syntax:

- item one
- item two

Unordered list:

   - Item 1
   - Item 2
     - Nested item 2.1
     - Nested item 2.2
Item 3
   + Item 4

Ordered list:

1. First item
2. Second item
    1. Nested ordered item 2.1
    2. Nested ordered item 2.2
3. Third item

Task lists (Checklists):

- [x] Completed task
- [ ] Pending task
- [x] Another completed task

Definition Lists (DefinitionListBlock)

Term 1
: Definition of Term 1

Term 2
: Definition of Term 2
: Another definition for Term 2

Base Classes

Name

Description

BlockCommonBase<BlockKind::List>

Base class for providing variant discriminator functions.

Static Member Functions

Name

isFootnoteDefinition

Data Members

Name

Description

items

Items contained in the list.

listKind

Display style for the list.

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