View source

class ParameterInformation

package moonshine.lsp

@:directlyUsed@:structInit

Implementation of ParameterInformation interface from Language Server Protocol

DO NOT add new properties or methods to this class that are specific to Moonshine IDE or to a particular language. Create a subclass for new properties or create a utility function for methods.

See also:

Static methods

staticparse(original:Dynamic):ParameterInformation

Constructor

@:value({ documentation : null, label : null })new(?label:String, ?documentation:String)

Variables

documentation:Any

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

@:value("")label:String = ""

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.