Interface ReferenceDescription

Describes a cross-reference within a document or between two documents.

interface ReferenceDescription {
    local?: boolean;
    segment: DocumentSegment;
    sourcePath: string;
    sourceUri: URI;
    targetPath: string;
    targetUri: URI;
}

Index

Properties

local? segment sourcePath sourceUri targetPath targetUri

Properties

`Optional`local

local?: boolean

Marks a local reference i.e. a cross reference inside a document.

segment

segment: DocumentSegment

Segment of the reference text.

sourcePath

sourcePath: string

Path to AstNode that holds a reference

sourceUri

sourceUri: URI

URI of the document that holds a reference

targetPath

targetPath: string

Path to the target AstNode inside the document

targetUri

targetUri: URI

Target document uri