mrdocs::doc::InlineCommonBase

Base class for providing variant discriminator functions.

Synopsis

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

template<InlineKind K>
struct InlineCommonBase
    : Inline

Description

This offers functions that return a boolean at compile‐time, indicating if the most‐derived class is a certain type.

Base Classes

Name Description

Name	Description
`Inline`	A Node containing a string of text.

Inline

A Node containing a string of text.

Member Functions

Name

Description

~InlineCommonBase [destructor] [virtual]

Destructor

asInline

operator==

Equality operator

operator<=>

Three‐way comparison operators

Data Members

Name

Kind

Static Data Members

Name

Description

kind_id

The variant discriminator constant of the most‐derived class.

Protected Member Functions

Name

Description

InlineCommonBase [constructor]

Default constructor

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

Name	Description
`CodeInline`	A piece of styled text.
`CopyDetailsInline`	Documentation copied from another symbol.
`EmphInline`	A piece of styled text.
`FootnoteReferenceInline`	A reference to a symbol.
`HighlightInline`	A piece of highlighted text.
`ImageInline`	An image.
`LineBreakInline`	A hard line break that renders as ""
`LinkInline`	A hyperlink.
`MathInline`	An inline LaTeX math expression
`ReferenceInline`	A reference to a symbol.
`SoftBreakInline`	A line break that may render as space
`StrikethroughInline`	A piece of styled text.
`StrongInline`	A piece of styled text.
`SubscriptInline`	A piece of styled text.
`SuperscriptInline`	A piece of styled text.
`TextInline`	A Node containing a string of text.

CodeInline

A piece of styled text.

CopyDetailsInline

Documentation copied from another symbol.

EmphInline

A piece of styled text.

FootnoteReferenceInline

A reference to a symbol.

HighlightInline

A piece of highlighted text.

ImageInline

An image.