Preformatted source code.

Synopsis

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

struct CodeBlock final
    : BlockCommonBase<BlockKind::Code>

Base Classes

Name Description

BlockCommonBase<BlockKind::Code>

Base class for providing variant discriminator functions.

Member Functions

Name

Description

CodeBlock [constructor]

Construct an empty code block.

operator==

Equality compares literal and info string.

operator<=>

Compare code blocks by literal and info string.

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

Description

info

Fence info string, e.g. "cpp"

literal

Raw code text inside the fenced block.

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