mrdocs::doc::LineBreakInline

A hard line break that renders as ""

Synopsis

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

struct LineBreakInline
    : InlineCommonBase<InlineKind::LineBreak>

Base Classes

Name Description

InlineCommonBase<InlineKind::LineBreak>

Base class for providing variant discriminator functions.

Member Functions

Name

Description

LineBreakInline [constructor]

Construct a line break node.

~LineBreakInline [destructor] [virtual]

Virtual destructor for the inline hierarchy.

operator==

Equality compares line breaks (trivial).

operator<=>

Order line breaks (trivial).

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.

Description

Syntax:

first line\
second line

or

first line<br>second line

Created with MrDocs