mrdocs::doc::StrongInline

Strong emphasis span (typically rendered in bold).

Synopsis

Declared in <mrdocs/Metadata/DocComment/Inline/StrongInline.hpp>
struct StrongInline final
    : InlineCommonBase<InlineKind::Strong>
    , InlineContainer

Description

Syntax:

@b bold

Base Classes

Name Description
InlineCommonBase<InlineKind::Strong>Base class for providing variant discriminator functions.
InlineContainerAn internal node in the inline element tree.

Member Functions

NameDescription
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

Static Member Functions

Name
isCode
isCopyDetails
isEmph
isFootnoteReference
isHighlight
isImage
isLineBreak
isLink
isMath
isReference
isSoftBreak
isStrikethrough
isStrong
isSubscript
isSuperscript
isText

Data Members

NameDescription
children Child inline elements contained here.

Static Data Members

Name
kind_id

Using Declarations

NameDescription
StrongInline Inherit text container constructors.

Non-Member Functions

Name Description
getAsPlainTextFlatten an InlineContainer to plain text.
getAsPlainTextFlatten an InlineContainer to plain text.
getAsPlainTextGet the plain text representation of an inline element tree.
getAsPlainTextGet the plain text representation of an inline element tree.
ltrimRemoves leading whitespace from the first text element in the given InlineContainer.
rtrimRemoves trailing whitespace from the last text element in the given InlineContainer.
trimRemoves leading and trailing whitespace from the text elements in the given InlineContainer.