mrdocs::doc::Inline

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

NameDescription
~Inline [destructor] [virtual]Virtual destructor to enable polymorphic deletion.
asInline asInline overloads

Data Members

NameDescription
Kind Discriminator identifying which inline variant is active.

Protected Member Functions

NameDescription
Inline [constructor]Constructors

Non-Member Functions

NameDescription
getAsPlainTextGet the plain text representation of an inline element tree.
getAsPlainTextGet the plain text representation of an inline element tree.

Derived Classes

NameDescription
InlineCommonBase Base class for providing variant discriminator functions.