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

Syntax:


@return description

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]	Virtual destructor for polymorphic base.
`operator=`	Assignment operators
`append`	`append` overloads
`asInlineContainer`	Return this container as a base-class reference.
`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 in-place.
`empty`	Determine if there are no inline children.
`end`	End iterator forwarding to children.
`erase`	Erase inline children.
`front`	Get the first inline child.
`insert`	Insert inline children.
`operator+=`	Addition assignment operators
`size`	Get the number of inline children.
`operator==`	Equality operators
`operator<=>`	Three-way comparison operators

Name	Description
`children`	Child inline elements contained here.

Name
`kind_id`

Name	Description
`ReturnsBlock`	Inherit inline container constructors.

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.