const class compilerDoc::DocLink

sys::Obj
  compilerDoc::DocLink

Source

DocLink models a link between two documents.

The following link formats are built-in:

Format             Display     Links To
------             -------     --------
pod::index         pod         absolute link to pod index
pod::pod-doc       pod         absolute link to pod doc chapter
pod::Type          Type        absolute link to type qname
pod::Types.slot    Type.slot   absolute link to slot qname
pod::Chapter       Chapter     absolute link to book chapter
pod::Chapter#frag  Chapter     absolute link to book chapter anchor
Type               Type        pod relative link to type
Type.slot          Type.slot   pod relative link to slot
slot               slot        type relative link to slot
Chapter            Chapter     pod relative link to book chapter
Chapter#frag       Chapter     pod relative link to chapter anchor
#frag              heading     chapter relative link to anchor

absUri

const Uri? absUri

Source

If link resolves to an absolute URI

dis

const Str dis

Source

Display text for the anchor

frag

const Str? frag

Source

Optional fragment in the link document

from

const Doc from

Source

Document we are linking from

make

new make(Doc from, Doc target, Str dis := target.docName(), Str? frag := null)

Source

Construct with from doc, dis text, target document, and optional fragment identifier

makeAbsUri

new makeAbsUri(Doc from, Uri uri, Str dis)

Source

Construct an absolute link such as "https://foo/"

target

const Doc target

Source

Target document

toStr

virtual override Str toStr()

Source

Debug string representation