View Source GenLSP.Structures.SignatureHelp (gen_lsp v0.9.0)

Signature help represents the signature of something callable. There can be multiple signature but only one active and only one active parameter.

Link to this section Summary

Functions

Fields

  • signatures: One or more signatures.

Link to this section Types

@type t() :: %GenLSP.Structures.SignatureHelp{
  active_parameter: GenLSP.BaseTypes.uinteger() | nil,
  active_signature: GenLSP.BaseTypes.uinteger() | nil,
  signatures: [GenLSP.Structures.SignatureInformation.t()]
}

Link to this section Functions

Link to this function

%GenLSP.Structures.SignatureHelp{}

View Source (struct)

fields

Fields

  • signatures: One or more signatures.

  • active_signature: The active signature. If omitted or the value lies outside the range of signatures the value defaults to zero or is ignored if the SignatureHelp has no signatures.

    Whenever possible implementors should make an active decision about the active signature and shouldn't rely on a default value.

    In future version of the protocol this property might become mandatory to better express this.

  • active_parameter: The active parameter of the active signature. If omitted or the value lies outside the range of signatures[activeSignature].parameters defaults to 0 if the active signature has parameters. If the active signature has no parameters it is ignored. In future version of the protocol this property might become mandatory to better express the active parameter if the active signature does have any.