Marshall Bowers
4aaf3459c4
This PR adds more documentation for various constructs in the `zed_extension_api` crate. `wit_bindgen` is able to generate doc comments on the Rust constructs using the the doc comments in the WIT files, so we're able to leverage that for the majority of the constructs that we expose. Release Notes: - N/A
82 lines
1.5 KiB
Plaintext
82 lines
1.5 KiB
Plaintext
interface lsp {
|
|
/// An LSP completion.
|
|
record completion {
|
|
label: string,
|
|
detail: option<string>,
|
|
kind: option<completion-kind>,
|
|
insert-text-format: option<insert-text-format>,
|
|
}
|
|
|
|
/// The kind of an LSP completion.
|
|
variant completion-kind {
|
|
text,
|
|
method,
|
|
function,
|
|
%constructor,
|
|
field,
|
|
variable,
|
|
class,
|
|
%interface,
|
|
module,
|
|
property,
|
|
unit,
|
|
value,
|
|
%enum,
|
|
keyword,
|
|
snippet,
|
|
color,
|
|
file,
|
|
reference,
|
|
folder,
|
|
enum-member,
|
|
constant,
|
|
struct,
|
|
event,
|
|
operator,
|
|
type-parameter,
|
|
other(s32),
|
|
}
|
|
|
|
/// Defines how to interpret the insert text in a completion item.
|
|
variant insert-text-format {
|
|
plain-text,
|
|
snippet,
|
|
other(s32),
|
|
}
|
|
|
|
record symbol {
|
|
kind: symbol-kind,
|
|
name: string,
|
|
}
|
|
|
|
variant symbol-kind {
|
|
file,
|
|
module,
|
|
namespace,
|
|
%package,
|
|
class,
|
|
method,
|
|
property,
|
|
field,
|
|
%constructor,
|
|
%enum,
|
|
%interface,
|
|
function,
|
|
variable,
|
|
constant,
|
|
%string,
|
|
number,
|
|
boolean,
|
|
array,
|
|
object,
|
|
key,
|
|
null,
|
|
enum-member,
|
|
struct,
|
|
event,
|
|
operator,
|
|
type-parameter,
|
|
other(s32),
|
|
}
|
|
}
|