mrdocs::doc::SoftBreakInline

A line break that may render as a space

Synopsis

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

struct SoftBreakInline
    : InlineCommonBase<InlineKind::SoftBreak>

Description

Syntax:


This is the first part of a line,
and this is the continuation on the next line.

Placing a backslash (\) at the end of a line, followed by a new line, can also create a soft line break. This method is often preferred because it is less susceptible to space-trimming issues.


This is the first part of a line,\
and this is the continuation on the next line.

Base Classes

Name	Description
`InlineCommonBase<InlineKind::SoftBreak>`	Base class for providing variant discriminator functions.

Member Functions

Name	Description
`SoftBreakInline` [constructor]	Construct a soft line break node.
`~SoftBreakInline` [destructor] [virtual]	Virtual destructor for inline hierarchy.
`operator==`	Equality compares soft breaks (trivial).
`operator<=>`	Order soft breaks (trivial).

Static Member Functions

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

Static Data Members

Name
`kind_id`

Non-Member Functions

Name	Description
`getAsPlainText`	Get the plain text representation of an inline element tree.
`getAsPlainText`	Get the plain text representation of an inline element tree.