A hyperlink.

Synopsis

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

struct LinkInline final
    : InlineCommonBase<InlineKind::Link>
    , InlineContainer

Description

Syntax:

@link https://example.com label @endlink

Or with markdown syntax:

[link text](URL)
[link text](URL "title")

Or:

<a href="https://www.example.com">Visit Example.com</a>

Base Classes

Name Description

InlineCommonBase<InlineKind::Link>

Base class for providing variant discriminator functions.

InlineContainer

An internal node in the inline element tree.

Member Functions

Name

Description

LinkInline [constructor]

Constructors

operator=

Assignment operators

append

append overloads

asInlineContainer

Return this container as a base‐class reference.

back

Get the last inline child.

begin

Begin iterator forwarding to children.

clear

Clear all inline children.

emplace_back

Append a child of the specified type in‐place.

empty

Determine if there are no inline children.

end

End iterator forwarding to children.

erase

Erase inline children.

front

Get the first inline child.

insert

Insert inline children.

operator+=

Addition assignment operators

size

Get the number of inline children.

operator==

Equality operators

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

Description

children

Child inline elements contained here.

href

Destination of the hyperlink.

Static Data Members

Name

kind_id

Non-Member Functions

Name

Description

getAsPlainText

Flatten an InlineContainer to plain text.

getAsPlainText

Flatten an InlineContainer to plain text.

getAsPlainText

Get the plain text representation of an inline element tree.

getAsPlainText

Get the plain text representation of an inline element tree.

ltrim

Removes leading whitespace from the first text element in the given InlineContainer.

rtrim

Removes trailing whitespace from the last text element in the given InlineContainer.

trim

Removes leading and trailing whitespace from the text elements in the given InlineContainer.

Created with MrDocs