mrdocs::doc::QuoteBlock

Synopsis

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

struct QuoteBlock final
    : BlockCommonBase<BlockKind::Quote>
    , BlockContainer

Description

Syntax:


> quoted text

Multi-line quotes:


> This is the first line of a multi-line quote.
> This is the second line.
> And this is the third.

Nested quotes:


> This is the outer quote.
>
> > This is a nested quote within the outer quote.
> >
> > > This is a further nested quote.

Quotes with other markdown elements:


> ### Important Note
>
> - This blockquote contains a heading.
> - And a list item.
>
> *Emphasis* and **strong emphasis** also work within blockquotes.

Base Classes

Name	Description
`BlockCommonBase<BlockKind::Quote>`	Base class for providing variant discriminator functions.
`BlockContainer`	A composite block that stores a sequence of child blocks.

Member Functions

Name	Description
`asBlockContainer`	`asBlockContainer` overloads

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
`blocks`	Child blocks contained within this composite block.

Non-Member Functions

Name	Description
`isEmpty`	Determine if the inline is empty
`ltrim`	Removes leading whitespace from the first text elements
`ltrim`	Removes leading whitespace from the block.
`rtrim`	Removes trailing whitespace from the last text elements
`rtrim`	Removes trailing whitespace from the block.
`trim`	Removes leading and trailing whitespace from the block.
`trim`	Removes leading and trailing whitespace from the text elements