mrdocs::doc::TextInline

A Node containing a string of text.

Synopsis

Declared in <mrdocs/Metadata/DocComment/Inline/TextInline.hpp>
struct TextInline
    : InlineCommonBase<InlineKind::Text>

Base Classes

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

Member Functions

Name Description
TextInline [constructor]Constructors
~TextInline [destructor] [virtual]Destructor
operator== Equality operator
operator<=> Three-way comparison operators

Static Member Functions

Name
isCode
isCopyDetails
isEmph
isFootnoteReference
isHighlight
isImage
isLineBreak
isLink
isMath
isReference
isSoftBreak
isStrikethrough
isStrong
isSubscript
isSuperscript
isText

Data Members

Name
literal

Static Data Members

Name
kind_id

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.

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