mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-10-21 17:21:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: regenerate [skip ci]

Browse Source
This commit is contained in:
marvim
2022-01-17 18:28:23 +00:00
parent 8f54b88a5e
commit 2c94b75eac
4 changed files with 45 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
runtime/doc/api.txt
View File

@@ -709,8 +709,8 @@ nvim_chan_send({chan}, {data}) *nvim_chan_send()*
Send data to channel `id` . For a job, it writes it to the Send data to channel `id` . For a job, it writes it to the
stdin of the process. For the stdio channel |channel-stdio|, stdin of the process. For the stdio channel |channel-stdio|,
it writes to Nvim's stdout. For an internal terminal instance it writes to Nvim's stdout. For an internal terminal instance
(|nvim_open_term()|) it writes directly to terimal output. See (|nvim_open_term()|) it writes directly to terminal output.
|channel-bytes| for more information. See |channel-bytes| for more information.
This function writes raw data, not RPC messages. If the This function writes raw data, not RPC messages. If the
channel was created with `rpc=true` then the channel expects channel was created with `rpc=true` then the channel expects
@@ -1405,7 +1405,7 @@ nvim_replace_termcodes({str}, {from_part}, {do_lt}, {special})
{from_part} Legacy Vim parameter. Usually true. {from_part} Legacy Vim parameter. Usually true.
{do_lt} Also translate <lt>. Ignored if `special` is {do_lt} Also translate <lt>. Ignored if `special` is
false. false.
{special} Replace |keycodes|, e.g. <CR> becomes a "\n" {special} Replace |keycodes|, e.g. <CR> becomes a "\r"
char. char.
See also: ~ See also: ~
@@ -2548,6 +2548,10 @@ nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {*opts})
• priority: a priority value for the highlight • priority: a priority value for the highlight
group. For example treesitter highlighting group. For example treesitter highlighting
uses a value of 100. uses a value of 100.
• strict: boolean that indicates extmark should
not be placed if the line or column value is
past the end of the buffer or end of the line
respectively. Defaults to true.
Return: ~ Return: ~
Id of the created/updated extmark Id of the created/updated extmark

45
runtime/doc/lsp.txt
View File

@@ -749,8 +749,8 @@ omnifunc({findstart}, {base}) *vim.lsp.omnifunc()*
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.
Levels by name: "trace", "debug", "info", "warn", "error" Levels by name: "TRACE", "DEBUG", "INFO", "WARN", "ERROR"
Level numbers begin with "trace" at 0 Level numbers begin with "TRACE" at 0
Use `lsp.log_levels` for reverse lookup. Use `lsp.log_levels` for reverse lookup.
@@ -887,10 +887,10 @@ start_client({config}) *vim.lsp.start_client()*
default true): Allow using default true): Allow using
incremental sync for buffer edits incremental sync for buffer edits
• debounce_text_changes (number, • debounce_text_changes (number,
default 150): Debounce didChange default nil): Debounce didChange
notifications to the server by the notifications to the server by the
given number in milliseconds. No given number in milliseconds. No
debounce occurs if set to 0. debounce occurs if nil
• exit_timeout (number, default 500): • exit_timeout (number, default 500):
Milliseconds to wait for server to Milliseconds to wait for server to
exit cleanly after sending the exit cleanly after sending the
@@ -1008,7 +1008,7 @@ document_highlight() *vim.lsp.buf.document_highlight()*
Send request to the server to resolve document highlights for Send request to the server to resolve document highlights for
the current text document position. This request can be the current text document position. This request can be
triggered by a key mapping or by events such as `CursorHold` , triggered by a key mapping or by events such as `CursorHold` ,
eg: e.g.:
> >
autocmd CursorHold <buffer> lua vim.lsp.buf.document_highlight() autocmd CursorHold <buffer> lua vim.lsp.buf.document_highlight()
autocmd CursorHoldI <buffer> lua vim.lsp.buf.document_highlight() autocmd CursorHoldI <buffer> lua vim.lsp.buf.document_highlight()
@@ -1024,11 +1024,12 @@ document_symbol() *vim.lsp.buf.document_symbol()*
Lists all symbols in the current buffer in the quickfix Lists all symbols in the current buffer in the quickfix
window. window.
execute_command({command}) *vim.lsp.buf.execute_command()* execute_command({command_params}) *vim.lsp.buf.execute_command()*
Executes an LSP server command. Executes an LSP server command.
Parameters: ~ Parameters: ~
{command} A valid `ExecuteCommandParams` object {command_params} table A valid `ExecuteCommandParams`
object
See also: ~ See also: ~
https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_executeCommand https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_executeCommand
@@ -1331,7 +1332,7 @@ signature_help({_}, {result}, {ctx}, {config})
Lua module: vim.lsp.util *lsp-util* Lua module: vim.lsp.util *lsp-util*
*vim.lsp.util.apply_text_document_edit()* *vim.lsp.util.apply_text_document_edit()*
apply_text_document_edit({text_document_edit}, {index}) apply_text_document_edit({text_document_edit}, {index}, {offset_encoding})
Applies a `TextDocumentEdit` , which is a list of changes to a Applies a `TextDocumentEdit` , which is a list of changes to a
single document. single document.
@@ -1351,18 +1352,19 @@ apply_text_edits({text_edits}, {bufnr}, {offset_encoding})
Parameters: ~ Parameters: ~
{text_edits} table list of `TextEdit` objects {text_edits} table list of `TextEdit` objects
{bufnr} number Buffer id {bufnr} number Buffer id
{offset_encoding} string utf-8|utf-16|utf-32|nil defaults {offset_encoding} string utf-8|utf-16|utf-32 defaults to
to encoding of first client of `bufnr` encoding of first client of `bufnr`
See also: ~ See also: ~
https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textEdit https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textEdit
*vim.lsp.util.apply_workspace_edit()* *vim.lsp.util.apply_workspace_edit()*
apply_workspace_edit({workspace_edit}) apply_workspace_edit({workspace_edit}, {offset_encoding})
Applies a `WorkspaceEdit` . Applies a `WorkspaceEdit` .
Parameters: ~ Parameters: ~
{workspace_edit} (table) `WorkspaceEdit` {workspace_edit} table `WorkspaceEdit`
{offset_encoding} string utf-8|utf-16|utf-32 (required)
buf_clear_references({bufnr}) *vim.lsp.util.buf_clear_references()* buf_clear_references({bufnr}) *vim.lsp.util.buf_clear_references()*
Removes document highlights from a buffer. Removes document highlights from a buffer.
@@ -1379,9 +1381,7 @@ buf_highlight_references({bufnr}, {references}, {offset_encoding})
{references} table List of `DocumentHighlight` {references} table List of `DocumentHighlight`
objects to highlight objects to highlight
{offset_encoding} string One of "utf-8", "utf-16", {offset_encoding} string One of "utf-8", "utf-16",
"utf-32", or nil. Defaults to "utf-32".
`offset_encoding` of first client of
`bufnr`
See also: ~ See also: ~
https://microsoft.github.io/language-server-protocol/specifications/specification-3-17/#documentHighlight https://microsoft.github.io/language-server-protocol/specifications/specification-3-17/#documentHighlight
@@ -1470,16 +1470,19 @@ get_effective_tabstop({bufnr}) *vim.lsp.util.get_effective_tabstop()*
See also: ~ See also: ~
|softtabstop| |softtabstop|
jump_to_location({location}) *vim.lsp.util.jump_to_location()* *vim.lsp.util.jump_to_location()*
jump_to_location({location}, {offset_encoding})
Jumps to a location. Jumps to a location.
Parameters: ~ Parameters: ~
{location} ( `Location` | `LocationLink` ) {location} table ( `Location` | `LocationLink` )
{offset_encoding} string utf-8|utf-16|utf-32 (required)
Return: ~ Return: ~
`true` if the jump succeeded `true` if the jump succeeded
locations_to_items({locations}) *vim.lsp.util.locations_to_items()* *vim.lsp.util.locations_to_items()*
locations_to_items({locations}, {offset_encoding})
Returns the items with the byte position calculated correctly Returns the items with the byte position calculated correctly
and in sorted order, for display in quickfix and location and in sorted order, for display in quickfix and location
lists. lists.
@@ -1488,8 +1491,10 @@ locations_to_items({locations}) *vim.lsp.util.locations_to_items()*
|setqflist()| or |setloclist()|. |setqflist()| or |setloclist()|.
Parameters: ~ Parameters: ~
{locations} (table) list of `Location` s or {locations} table list of `Location` s or
`LocationLink` s `LocationLink` s
{offset_encoding} string offset_encoding for locations
utf-8|utf-16|utf-32
Return: ~ Return: ~
(table) list of items (table) list of items

9
runtime/doc/lua.txt
View File

@@ -1872,6 +1872,15 @@ add({filetypes}) *vim.filetype.add()*
{filetypes} table A table containing new filetype maps {filetypes} table A table containing new filetype maps
(see example). (see example).
match({name}, {bufnr}) *vim.filetype.match()*
Set the filetype for the given buffer from a file name.
Parameters: ~
{name} string File name (can be an absolute or relative
path)
{bufnr} number|nil The buffer to set the filetype for.
Defaults to the current buffer.
============================================================================== ==============================================================================
Lua module: keymap *lua-keymap* Lua module: keymap *lua-keymap*

7
runtime/doc/treesitter.txt
View File

@@ -467,8 +467,9 @@ parse_query({lang}, {query}) *parse_query()*
• `info.patterns` contains information about predicates. • `info.patterns` contains information about predicates.
Parameters: ~ Parameters: ~
{lang} The language {lang} string The language
{query} A string containing the query (s-expr syntax) {query} string A string containing the query (s-expr
syntax)
Return: ~ Return: ~
The query The query
@@ -665,7 +666,7 @@ LanguageTree:invalidate({self}, {reload}) *LanguageTree:invalidate()*
{self} {self}
LanguageTree:is_valid({self}) *LanguageTree:is_valid()* LanguageTree:is_valid({self}) *LanguageTree:is_valid()*
Determines whether this tree is valid. If the tree is invalid, `parse()` must be called to get the an updated tree. Determines whether this tree is valid. If the tree is invalid, `parse()` must be called to get the updated tree.
Parameters: ~ Parameters: ~
{self} {self}