mrdocs::doc::ImageInline

Synopsis

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

struct ImageInline final
    : InlineCommonBase<InlineKind::Image>
    , InlineContainer

Syntax:


@image html path/to/img "alt text"


![Alt text](image_url "Optional title text")

Name	Description
`InlineCommonBase<InlineKind::Image>`	Base class for providing variant discriminator functions.
`InlineContainer`	An internal node in the inline element tree.

Name	Description
`ImageInline` [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.

Name	Description
`alt`	Alternate text when the image cannot be shown.
`children`	Child inline elements contained here.
`src`	Image source URL or path.

Name	Description
`kind_id`	The variant discriminator constant of the most-derived class.

Name	Description
`getAsPlainText`	Flatten an InlineContainer to plain text.
`getAsPlainText`	Get the plain text representation of an inline element tree.
`getAsPlainText`	Flatten an InlineContainer to plain text.
`getAsPlainText`	Get the plain text representation of an inline element tree.
`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.