table RefText

Overview

Table of this type describes a block (either plain-text or hyperlink) of LinkedText. More…

RefText = {
    -- fields

    refKind,
    text,
    id,
    external,
    tooltip,
}

Detailed Documentation

Table of this type describes a block (either plain-text or hyperlink) of LinkedText.

Fields

refKind

Holds a string describing hyperlink target. Must be one of RefKind. If this block is not a hyperlink, refKind contains <undefined>.

text

Holds a string with plain-text representation of the block.

id

Holds a Doxygen identifier of the hyperlink target. If this block is not a hyperlink id contains an empty string.