struct LSP::SignatureHelp

Overview

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

Included Modules

Defined in:

requests/language_features/signature_help.cr

Constructors

Instance Method Summary

Macros inherited from module JSON::Serializable

json_discriminator(field, mapping, *, default = nil) json_discriminator

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(**args) #

[View source]

Instance Method Detail

def active_parameter : Int32 | Nil #

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.


[View source]
def active_parameter=(active_parameter : Int32 | Nil) #

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.


[View source]
def active_signature : Int32 | Nil #

The active signature. If omitted or the value lies outside the range of #signatures the value defaults to zero or is ignore if the SignatureHelp as 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.


[View source]
def active_signature=(active_signature : Int32 | Nil) #

The active signature. If omitted or the value lies outside the range of #signatures the value defaults to zero or is ignore if the SignatureHelp as 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.


[View source]
def signatures : Array(SignatureInformation) #

One or more signatures. If no signaures are availabe the signature help request should return null.


[View source]
def signatures=(signatures : Array(SignatureInformation)) #

One or more signatures. If no signaures are availabe the signature help request should return null.


[View source]