struct LSP::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:

requests/language_features/signature_help.cr

Constructors

Instance Method Summary

Constructor Detail

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

[View source]
def self.new(**args) #

[View source]

Instance Method Detail

def documentation : String | MarkupContent | Nil #

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


[View source]
def documentation=(documentation : String | MarkupContent | 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 label=(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]
def parameters=(parameters : Array(ParameterInformation) | Nil) #

The parameters of this signature.


[View source]