mrdocs::doc::ReturnsBlock

Documentation for a function return type

Synopsis

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

struct ReturnsBlock final
    : BlockCommonBase<BlockKind::Returns>
    , InlineContainer

Name	Description
`BlockCommonBase<BlockKind::Returns>`	Base class for providing variant discriminator functions.
`InlineContainer`	An internal node in the inline element tree

Name	Description
`ReturnsBlock` [constructor]	Constructors
`~ReturnsBlock` [destructor] [virtual]	Destructor
`operator=`	Assign an InlineContainer with a single TextInline child.
`append`	`append` overloads
`asInlineContainer`	Helper function so that derived classes can get a reference to the base class.
`back`	Get the last inline child.
`begin`	Begin iterator forwarding to children
`clear`	Clear all inline children.
`emplace_back`	Append a child of the specified type.
`empty`	Determine if there are no inline children.
`end`	End iterator forwarding to children
`erase`	Erase from children
`front`	Get the first inline child.
`insert`	Erase from children
`operator+=`	Addition assignment operators
`size`	Get the number of inline children.
`operator==`	Compare two InlineContainers.
`operator<=>`	Compare two InlineContainers.

Name
`children`

Name
`kind_id`

Name
`ReturnsBlock`

Name	Description
`getAsPlainText`	Flatten an InlineContainer to plain text.
`getAsPlainText`	Flatten an InlineContainer to plain text.
`isEmpty`	Determine if the inline is empty
`ltrim`	Removes leading whitespace from the first text element in the given InlineContainer.
`ltrim`	Removes leading whitespace from the block.
`rtrim`	Removes trailing whitespace from the last text element in the given InlineContainer.
`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 in the given InlineContainer.