mrdocs::doc::ReferenceInline

A reference to a symbol.

Synopsis

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

struct ReferenceInline
    : InlineCommonBase<InlineKind::Reference>

Description

Syntax:

@ref target "label"

Base Classes

Name

Description

InlineCommonBase<InlineKind::Reference>

Base class for providing variant discriminator functions.

Member Functions

Name

Description

ReferenceInline [constructor]

Construct a reference with optional display text.

Static Member Functions

Name

isCode

isCopyDetails

isEmph

isFootnoteReference

Data Members

Name

Description

id

Symbol being referenced.

literal

Display text of the reference.

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