mrdocs::doc::CodeBlock

Preformatted source code.

Synopsis

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

struct CodeBlock final
    : BlockCommonBase<BlockKind::Code>

Base Classes

NameDescription
BlockCommonBase<BlockKind::Code>Base class for providing variant discriminator functions.

Member Functions

NameDescription
CodeBlock [constructor]Construct an empty code block.

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

NameDescription
info Fence info string, e.g. "cpp"
literal Raw code text inside the fenced block.

Non-Member Functions

NameDescription
isEmptyDetermine if the inline is empty
ltrimRemoves leading whitespace from the block.
rtrimRemoves trailing whitespace from the block.
trimRemoves leading and trailing whitespace from the block.