struct

LSP::ParameterInformation

Inherits JSON::Serializable < LSP::Initializer < Struct < Value < Object

Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new
Source

Instance methods

documentation

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

Source
documentation=(documentation : String | MarkupContent | Nil)

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

Source
label

The label of this parameter information.

Either a string or an inclusive start and exclusive end offsets within its containing signature label. (see SignatureInformation.label). The offsets are based on a UTF-16 string representation as Position and Range does.

Note: a label of type string should be a substring of its containing signature label. Its intended use case is to highlight the parameter label part in the SignatureInformation.label.

Source
label=(label : String | Tuple(Int32, Int32))

The label of this parameter information.

Either a string or an inclusive start and exclusive end offsets within its containing signature label. (see SignatureInformation.label). The offsets are based on a UTF-16 string representation as Position and Range does.

Note: a label of type string should be a substring of its containing signature label. Its intended use case is to highlight the parameter label part in the SignatureInformation.label.

Source