mrdocs::doc::InlineContainer

Synopsis

Declared in <mrdocs/Metadata/DocComment/Inline/InlineBase.hpp>

struct InlineContainer;

Name	Description
`InlineContainer` [constructor]	Constructors
`~InlineContainer` [destructor] [virtual]	Virtual destructor for derived containers.
`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.

Name	Description
`children`	Child inline elements contained here.

Name	Description
`getAsPlainText`	Flatten an InlineContainer to plain text.
`getAsPlainText`	Flatten an InlineContainer to plain text.
`ltrim`	Removes leading whitespace from the first text element in the given InlineContainer.
`rtrim`	Removes trailing whitespace from the last text element in the given InlineContainer.
`trim`	Removes leading and trailing whitespace from the text elements in the given InlineContainer.

Name	Description
`BriefBlock`	The brief description
`CodeInline`	Inline code (monospaced) used for short snippets within text.
`EmphInline`	Emphasized text (typically rendered in italics).
`HeadingBlock`	A manually specified section heading.
`HighlightInline`	Highlighted text span used to call out important words.
`ImageInline`	An image.
`LinkInline`	A hyperlink.
`ParagraphBlock`	A sequence of text nodes.
`ParamBlock`	Documentation for a function parameter
`PostconditionBlock`	Text describing conditions guaranteed on successful exit.
`PreconditionBlock`	Text describing required conditions before entry.
`ReturnsBlock`	Documentation for a function return type
`SeeBlock`	A
`StrikethroughInline`	Strikethrough span to show removed or deprecated text.
`StrongInline`	Strong emphasis span (typically rendered in bold).
`SubscriptInline`	Subscript text fragment (lowered baseline).
`SuperscriptInline`	Superscript text fragment (raised baseline).
`TParamBlock`	Documentation for a template parameter
`TableCell`	A cell in a table
`ThrowsBlock`	Documentation for a function exception clause