class

LSProtocol::ParameterInformation

Inherits JSON::Serializable / Reference / 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(label : Array(UInt32) | String | Nil, documentation : MarkupContent | String | Nil = nil)

Source

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

Source

Instance methods

documentation

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.

To avoid ambiguities a server should use the [start, end] offset value instead of using a substring. Whether a client support this is controlled via labelOffsetSupport client capability.

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