An internal node in the inline element tree
Synopsis
Declared in <mrdocs/Metadata/DocComment/Inline/InlineBase.hpp>
struct InlineContainer;Member Functions
Name |
Description |
|
Construct an InlineContainer with a single TextInline child. |
|
Destructor |
Assign an InlineContainer with a single TextInline child. |
|
|
|
Helper function so that derived classes can get a reference to the base class. |
|
Get the last inline child. |
|
Begin iterator forwarding to children |
|
Clear all inline children. |
|
Append a child of the specified type. |
|
Determine if there are no inline children. |
|
End iterator forwarding to children |
|
Erase from children |
|
Get the first inline child. |
|
Erase from children |
|
Addition assignment operators |
|
Get the number of inline children. |
|
Compare two InlineContainers. |
|
Compare two InlineContainers. |
Data Members
Name |
Non-Member Functions
Name |
Description |
Flatten an InlineContainer to plain text. |
|
Flatten an InlineContainer to plain text. |
|
Removes leading whitespace from the first text element in the given InlineContainer. |
|
Removes trailing whitespace from the last text element in the given InlineContainer. |
|
Removes leading and trailing whitespace from the text elements in the given InlineContainer. |
Derived Classes
Name |
Description |
The brief description |
|
A piece of styled text. |
|
A piece of styled text. |
|
A manually specified section heading. |
|
A piece of highlighted text. |
|
An image. |
|
A hyperlink. |
|
A sequence of text nodes. |
|
Documentation for a function parameter |
|
Documentation for a function return type |
|
A |
|
A piece of styled text. |
|
A piece of styled text. |
|
A piece of styled text. |
|
A piece of styled text. |
|
Documentation for a template parameter |
|
A cell in a table |
|
Documentation for a function parameter |
Created with MrDocs