Interface JSDocLinkDisplayPart

A part of a symbol description that links from a jsdoc

tag to a declaration

interface JSDocLinkDisplayPart {
    kind: string;
    target: FileSpan;
    text: string;
}

Properties

kind: string

The symbol's kind (such as 'className' or 'parameterName' or plain 'text').

The location of the declaration that the

tag links to.

text: string

Text of an item describing the symbol.