struct LSP::ParameterInformation

Overview

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

Included Modules

Defined in:

requests/language_features/signature_help.cr

Constructors

Instance Method Summary

Constructor Detail

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

def self.new(**args) #

Instance Method Detail

def documentation : String | MarkupContent | Nil #

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


def documentation=(documentation : String | MarkupContent | Nil) #

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


def 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.


def 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.