mirror of
https://github.com/neovim/neovim.git
synced 2025-02-25 18:55:25 -06:00
Merge pull request #14435 from michaelb/doc_missing_nvim_open_term
doc : fixing missing @return in nvim_open_term doc
This commit is contained in:
commit
bb7d3790bf
@ -1212,6 +1212,9 @@ nvim_open_term({buffer}, {opts}) *nvim_open_term()*
|
|||||||
{buffer} the buffer to use (expected to be empty)
|
{buffer} the buffer to use (expected to be empty)
|
||||||
{opts} Optional parameters. Reserved for future use.
|
{opts} Optional parameters. Reserved for future use.
|
||||||
|
|
||||||
|
Return: ~
|
||||||
|
Channel id, or 0 on error
|
||||||
|
|
||||||
nvim_open_win({buffer}, {enter}, {config}) *nvim_open_win()*
|
nvim_open_win({buffer}, {enter}, {config}) *nvim_open_win()*
|
||||||
Open a new window.
|
Open a new window.
|
||||||
|
|
||||||
@ -2280,6 +2283,10 @@ nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {opts})
|
|||||||
color
|
color
|
||||||
• "blend": blend with background text color.
|
• "blend": blend with background text color.
|
||||||
|
|
||||||
|
• hl_eol : when true, for a multiline highlight
|
||||||
|
covering the EOL of a line, continue the
|
||||||
|
highlight for the rest of the screen line
|
||||||
|
(just like for diff and cursorline highlight).
|
||||||
• ephemeral : for use with
|
• ephemeral : for use with
|
||||||
|nvim_set_decoration_provider| callbacks. The
|
|nvim_set_decoration_provider| callbacks. The
|
||||||
mark will only be used for the current redraw
|
mark will only be used for the current redraw
|
||||||
|
@ -592,14 +592,34 @@ buf_request({bufnr}, {method}, {params}, {handler})
|
|||||||
You could instead iterate all clients and call their
|
You could instead iterate all clients and call their
|
||||||
`cancel_request()` methods.
|
`cancel_request()` methods.
|
||||||
|
|
||||||
|
*vim.lsp.buf_request_all()*
|
||||||
|
buf_request_all({bufnr}, {method}, {params}, {callback})
|
||||||
|
Sends an async request for all active clients attached to the
|
||||||
|
buffer. Executes the callback on the combined result.
|
||||||
|
Parameters are the same as |vim.lsp.buf_request()| but the
|
||||||
|
return result and callback are different.
|
||||||
|
|
||||||
|
Parameters: ~
|
||||||
|
{bufnr} (number) Buffer handle, or 0 for current.
|
||||||
|
{method} (string) LSP method name
|
||||||
|
{params} (optional, table) Parameters to send to the
|
||||||
|
server
|
||||||
|
{callback} (function) The callback to call when all
|
||||||
|
requests are finished.
|
||||||
|
|
||||||
|
Return: ~
|
||||||
|
(function) A function that will cancel all requests which
|
||||||
|
is the same as the one returned from `buf_request` .
|
||||||
|
|
||||||
*vim.lsp.buf_request_sync()*
|
*vim.lsp.buf_request_sync()*
|
||||||
buf_request_sync({bufnr}, {method}, {params}, {timeout_ms})
|
buf_request_sync({bufnr}, {method}, {params}, {timeout_ms})
|
||||||
Sends a request to a server and waits for the response.
|
Sends a request to all server and waits for the response of
|
||||||
|
all of them.
|
||||||
|
|
||||||
Calls |vim.lsp.buf_request()| but blocks Nvim while awaiting
|
Calls |vim.lsp.buf_request_all()| but blocks Nvim while
|
||||||
the result. Parameters are the same as |vim.lsp.buf_request()|
|
awaiting the result. Parameters are the same as
|
||||||
but the return result is different. Wait maximum of
|
|vim.lsp.buf_request()| but the return result is different.
|
||||||
{timeout_ms} (default 100) ms.
|
Wait maximum of {timeout_ms} (default 100) ms.
|
||||||
|
|
||||||
Parameters: ~
|
Parameters: ~
|
||||||
{bufnr} (number) Buffer handle, or 0 for current.
|
{bufnr} (number) Buffer handle, or 0 for current.
|
||||||
@ -678,6 +698,9 @@ client_is_stopped({client_id}) *vim.lsp.client_is_stopped()*
|
|||||||
Return: ~
|
Return: ~
|
||||||
true if client is stopped, false otherwise.
|
true if client is stopped, false otherwise.
|
||||||
|
|
||||||
|
flush({client}) *vim.lsp.flush()*
|
||||||
|
TODO: Documentation
|
||||||
|
|
||||||
get_active_clients() *vim.lsp.get_active_clients()*
|
get_active_clients() *vim.lsp.get_active_clients()*
|
||||||
Gets all active clients.
|
Gets all active clients.
|
||||||
|
|
||||||
@ -708,6 +731,15 @@ get_log_path() *vim.lsp.get_log_path()*
|
|||||||
Return: ~
|
Return: ~
|
||||||
(String) Path to logfile.
|
(String) Path to logfile.
|
||||||
|
|
||||||
|
init({client}, {bufnr}) *vim.lsp.init()*
|
||||||
|
client_id → state
|
||||||
|
|
||||||
|
state pending_change?: function that the timer starts to
|
||||||
|
trigger didChange pending_changes: list of tables with the
|
||||||
|
pending changesets; for incremental_sync only
|
||||||
|
use_incremental_sync: bool buffers?: table (bufnr → lines);
|
||||||
|
for incremental sync only timer?: uv_timer
|
||||||
|
|
||||||
omnifunc({findstart}, {base}) *vim.lsp.omnifunc()*
|
omnifunc({findstart}, {base}) *vim.lsp.omnifunc()*
|
||||||
Implements 'omnifunc' compatible LSP completion.
|
Implements 'omnifunc' compatible LSP completion.
|
||||||
|
|
||||||
@ -727,6 +759,16 @@ omnifunc({findstart}, {base}) *vim.lsp.omnifunc()*
|
|||||||
|complete-items|
|
|complete-items|
|
||||||
|CompleteDone|
|
|CompleteDone|
|
||||||
|
|
||||||
|
*vim.lsp.prepare()*
|
||||||
|
prepare({bufnr}, {firstline}, {new_lastline}, {changedtick})
|
||||||
|
TODO: Documentation
|
||||||
|
|
||||||
|
reset({client_id}) *vim.lsp.reset()*
|
||||||
|
TODO: Documentation
|
||||||
|
|
||||||
|
reset_buf({client}, {bufnr}) *vim.lsp.reset_buf()*
|
||||||
|
TODO: Documentation
|
||||||
|
|
||||||
set_log_level({level}) *vim.lsp.set_log_level()*
|
set_log_level({level}) *vim.lsp.set_log_level()*
|
||||||
Sets the global log level for LSP logging.
|
Sets the global log level for LSP logging.
|
||||||
|
|
||||||
@ -849,6 +891,11 @@ start_client({config}) *vim.lsp.start_client()*
|
|||||||
• allow_incremental_sync (bool, default
|
• allow_incremental_sync (bool, default
|
||||||
true): Allow using incremental sync
|
true): Allow using incremental sync
|
||||||
for buffer edits
|
for buffer edits
|
||||||
|
• debounce_text_changes (number,
|
||||||
|
default nil): Debounce didChange
|
||||||
|
notifications to the server by the
|
||||||
|
given number in milliseconds. No
|
||||||
|
debounce occurs if nil
|
||||||
|
|
||||||
Return: ~
|
Return: ~
|
||||||
Client id. |vim.lsp.get_client_by_id()| Note: client may
|
Client id. |vim.lsp.get_client_by_id()| Note: client may
|
||||||
@ -1311,6 +1358,10 @@ on_publish_diagnostics({_}, {_}, {params}, {client_id}, {_}, {config})
|
|||||||
• Update diagnostics in InsertMode or wait
|
• Update diagnostics in InsertMode or wait
|
||||||
until InsertLeave
|
until InsertLeave
|
||||||
|
|
||||||
|
• severity_sort: (default=false)
|
||||||
|
• Sort diagnostics (and thus signs and virtual
|
||||||
|
text)
|
||||||
|
|
||||||
reset({client_id}, {buffer_client_map}) *vim.lsp.diagnostic.reset()*
|
reset({client_id}, {buffer_client_map}) *vim.lsp.diagnostic.reset()*
|
||||||
Clear diagnotics and diagnostic cache
|
Clear diagnotics and diagnostic cache
|
||||||
|
|
||||||
|
@ -1267,6 +1267,7 @@ fail:
|
|||||||
/// @param buffer the buffer to use (expected to be empty)
|
/// @param buffer the buffer to use (expected to be empty)
|
||||||
/// @param opts Optional parameters. Reserved for future use.
|
/// @param opts Optional parameters. Reserved for future use.
|
||||||
/// @param[out] err Error details, if any
|
/// @param[out] err Error details, if any
|
||||||
|
/// @return Channel id, or 0 on error
|
||||||
Integer nvim_open_term(Buffer buffer, Dictionary opts, Error *err)
|
Integer nvim_open_term(Buffer buffer, Dictionary opts, Error *err)
|
||||||
FUNC_API_SINCE(7)
|
FUNC_API_SINCE(7)
|
||||||
{
|
{
|
||||||
|
Loading…
Reference in New Issue
Block a user