class

LSProtocol::SignatureInformation

Inherits JSON::Serializable / Reference / Object

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

Constructors

new(pull : JSON::PullParser)
Source
new(label : String | Nil, active_parameter : UInt32 | Nil = nil, documentation : MarkupContent | String | Nil = nil, parameters : Array(ParameterInformation) | Nil = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

active_parameter

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

Source
documentation

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

Source
label

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

Source
parameters

The parameters of this signature.

Source