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

Inline

A Node containing a string of text.

Member Functions

Name

Description

~InlineCommonBase [destructor] [virtual]

Virtual destructor to preserve polymorphic cleanup.

asInline

asInline overloads

Data Members

Name

Description

Kind

Discriminator identifying which inline variant is active.

Static Data Members

Name

Description

kind_id

The variant discriminator constant of the most‐derived class.

Protected Member Functions

Name

Description

InlineCommonBase [constructor]

Default‐construct with the fixed inline kind.

Friends

Name Description

mrdocs::doc::mrdocs_member_descriptor_fn

mrdocs::doc::mrdocs_base_descriptor_fn

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

CodeInline

Inline code (monospaced) used for short snippets within text.

CopyDetailsInline

Documentation copied from another symbol.

EmphInline

Emphasized text (typically rendered in italics).

FootnoteReferenceInline

A reference to a symbol.

HighlightInline

Highlighted text span used to call out important words.

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 a space

StrikethroughInline

Strikethrough span to show removed or deprecated text.

StrongInline

Strong emphasis span (typically rendered in bold).

SubscriptInline

Subscript text fragment (lowered baseline).

SuperscriptInline

Superscript text fragment (raised baseline).

TextInline

A Node containing a string of text.

Created with MrDocs