gen_lsp v0.10.0

View Source GenLSP.Structures.DocumentLink (gen_lsp v0.10.0)

A document link is a range in a text document that links to an internal or external resource, like another text document or a web site.

Link to this section Summary

Types

t()

Functions

%GenLSP.Structures.DocumentLink{}

Fields

  • range: The range this link applies to.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %GenLSP.Structures.DocumentLink{
  data: GenLSP.TypeAlias.LSPAny.t() | nil,
  range: GenLSP.Structures.Range.t(),
  target: String.t() | nil,
  tooltip: String.t() | nil
}

Link to this section Functions

Link to this function

%GenLSP.Structures.DocumentLink{}

View Source (struct)

fields

 Fields

  • range: The range this link applies to.

  • target: The uri this link points to. If missing a resolve request is sent later.

  • tooltip: The tooltip text when you hover over this link.

    If a tooltip is provided, is will be displayed in a string that includes instructions on how to trigger the link, such as {0} (ctrl + click). The specific instructions vary depending on OS, user settings, and localization.

    @since 3.15.0

  • data: A data entry field that is preserved on a document link between a DocumentLinkRequest and a DocumentLinkResolveRequest.