A Node containing a string of text.

Synopsis

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

struct Inline;

Description

There will be no newlines in the text. Otherwise, this would be represented as multiple text nodes within a Paragraph node.

Member Functions

Name

Description

~Inline [destructor] [virtual]

Virtual destructor to enable polymorphic deletion.

asInline

asInline overloads

operator==

Equality compares active kind and stored data.

operator<=>

Three‐way comparison by active inline kind and data.

Data Members

Name

Description

Kind

Discriminator identifying which inline variant is active.

Protected Member Functions

Name

Description

Inline [constructor]

Constructors

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.

Derived Classes

Name Description

InlineCommonBase

Base class for providing variant discriminator functions.

Created with MrDocs