mrdocs::doc::TextInline

A Node containing a string of text.

Synopsis

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

struct TextInline
    : InlineCommonBase<InlineKind::Text>

Description

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

Syntax:

plain text

Base Classes

Name Description

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

InlineCommonBase<InlineKind::Text>

Base class for providing variant discriminator functions.

Member Functions

Name

Description

TextInline [constructor]

Constructors

~TextInline [destructor] [virtual]

Virtual destructor for the inline hierarchy.

operator==

Equality compares literal strings.

operator<=>

Order text nodes lexicographically by their literal.

Static Member Functions

Name

isCode

isCopyDetails

isEmph

isFootnoteReference

Data Members

Name

Description

literal

Plain text carried by this inline node.

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.

Created with MrDocs