gen_lsp v0.8.1

View Source GenLSP.Structures.SignatureInformation (gen_lsp v0.8.1)

Represents the signature of something callable. A signature can have a label, like a function-name, a doc-comment, and a set of parameters.

Link to this section Summary

Types

t()

Functions

%GenLSP.Structures.SignatureInformation{}

Fields

  • label: The label of this signature. Will be shown in the UI.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %GenLSP.Structures.SignatureInformation{
  active_parameter: GenLSP.BaseTypes.uinteger() | nil,
  documentation: (String.t() | GenLSP.Structures.MarkupContent.t()) | nil,
  label: String.t(),
  parameters: [GenLSP.Structures.ParameterInformation.t()] | nil
}

Link to this section Functions

Link to this function

%GenLSP.Structures.SignatureInformation{}

View Source (struct)

fields

 Fields

  • label: The label of this signature. Will be shown in the UI.

  • documentation: The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.

  • parameters: The parameters of this signature.

  • active_parameter: The index of the active parameter.

    If provided, this is used in place of SignatureHelp.activeParameter.

    @since 3.16.0