mrdocs::doc::Inline

A Node containing a string of text.

Synopsis

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

Member Functions

Name Description
~Inline [destructor] [virtual]Destructor
asInline
operator== Equality operator
operator<=> Three-way comparison operator

Data Members

Name
Kind

Protected Member Functions

Name Description
Inline [constructor]Constructors

Non-Member Functions

Name Description
getAsPlainTextGet the plain text representation of an inline element tree.
getAsPlainTextGet the plain text representation of an inline element tree.

Derived Classes

Name Description
InlineCommonBase Base class for providing variant discriminator functions.

Description

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

Created with MrDocs