mrdocs::doc::ListBlock

A list of list items

Synopsis

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

struct ListBlock final
    : BlockCommonBase<BlockKind::List>

Base Classes

Name Description

BlockCommonBase<BlockKind::List>

Base class for providing variant discriminator functions.

Member Functions

Name

Description

operator==

Equality operator

operator<=>

Three‐way comparison operators

Static Member Functions

Name

isAdmonition

isBrief

isCode

isDefinitionList

isFootnoteDefinition

isHeading

isList

isMath

isParagraph

isParam

isPostcondition

isPrecondition

isQuote

isReturns

isSee

isTParam

isTable

isThematicBreak

isThrows

Data Members

Name

items

listKind

Static Data Members

Name

kind_id

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