class LSProtocol::SignatureInformation

Overview

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

Included Modules

Defined in:

lsprotocol/types.cr

Constructors

Instance Method Summary

Constructor Detail

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

[View source]
def self.new(label : String | Nil, active_parameter : UInt32 | Nil = nil, documentation : MarkupContent | String | Nil = nil, parameters : Array(ParameterInformation) | Nil = nil) #

[View source]

Instance Method Detail

def active_parameter : UInt32 | Nil #

The index of the active parameter.

If null, no parameter of the signature is active (for example a named argument that does not match any declared parameters). This is only valid if the client specifies the client capability textDocument.signatureHelp.noActiveParameterSupport === true

If provided (or null), this is used in place of SignatureHelp.activeParameter.

@since 3.16.0


[View source]
def documentation : MarkupContent | String | Nil #

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


[View source]
def label : String #

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


[View source]
def parameters : Array(ParameterInformation) | Nil #

The parameters of this signature.


[View source]