mrdocs::doc::BriefBlock

Synopsis

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

struct BriefBlock final
    : BlockCommonBase<BlockKind::Brief>
    , InlineContainer

Description

Syntax:


@brief summary

Base Classes

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

Member Functions

Name	Description
`BriefBlock` [constructor]	Constructors
`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.

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
`children`	Child inline elements contained here.
`copiedFrom`	Names of declarations whose brief text was reused.

Using Declarations

Name	Description
`BriefBlock`	Inherit inline container constructors.
`operator=`	Reuse inline container assignment operators.

Non-Member Functions

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.
`mrdocs_base_descriptor_fn`
`mrdocs_base_descriptor_fn`
`mrdocs_base_descriptor_fn`
`mrdocs_base_descriptor_fn`
`mrdocs_base_descriptor_fn`
`mrdocs_base_descriptor_fn`
`mrdocs_base_descriptor_fn`
`mrdocs_base_descriptor_fn`
`mrdocs_base_descriptor_fn`
`mrdocs_base_descriptor_fn`
`mrdocs_base_descriptor_fn`
`mrdocs_base_descriptor_fn`
`mrdocs_base_descriptor_fn`
`mrdocs_base_descriptor_fn`
`mrdocs_base_descriptor_fn`
`mrdocs_base_descriptor_fn`
`mrdocs_base_descriptor_fn`
`mrdocs_base_descriptor_fn`
`mrdocs_base_descriptor_fn`
`mrdocs_member_descriptor_fn`
`mrdocs_member_descriptor_fn`
`mrdocs_member_descriptor_fn`
`mrdocs_member_descriptor_fn`
`mrdocs_member_descriptor_fn`
`mrdocs_member_descriptor_fn`
`mrdocs_member_descriptor_fn`
`mrdocs_member_descriptor_fn`
`mrdocs_member_descriptor_fn`
`mrdocs_member_descriptor_fn`
`mrdocs_member_descriptor_fn`
`mrdocs_member_descriptor_fn`
`mrdocs_member_descriptor_fn`
`mrdocs_member_descriptor_fn`
`mrdocs_member_descriptor_fn`
`mrdocs_member_descriptor_fn`
`mrdocs_member_descriptor_fn`
`mrdocs_member_descriptor_fn`
`mrdocs_member_descriptor_fn`
`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.