aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/lsp.lua
diff options
context:
space:
mode:
authorGregory Anders <greg@gpanders.com>2021-11-18 11:29:31 -0700
committerGregory Anders <greg@gpanders.com>2021-11-18 11:30:09 -0700
commit8081a30ca8efbd23ae5f67d9756f8d0183177ee4 (patch)
tree08e6639d77b80f361ebeafcfd64d0f9ad4127c29 /runtime/lua/vim/lsp.lua
parent0746f0021f688071a29bc221faf553d7d210cee4 (diff)
downloadrneovim-8081a30ca8efbd23ae5f67d9756f8d0183177ee4.tar.gz
rneovim-8081a30ca8efbd23ae5f67d9756f8d0183177ee4.tar.bz2
rneovim-8081a30ca8efbd23ae5f67d9756f8d0183177ee4.zip
docs: mark tagfunc.lua methods as private
Diffstat (limited to 'runtime/lua/vim/lsp.lua')
-rw-r--r--runtime/lua/vim/lsp.lua14
1 files changed, 11 insertions, 3 deletions
diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 6254bb542a..88dcb38dd1 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1587,9 +1587,17 @@ function lsp.formatexpr(opts)
return 0
end
--- Provides an interface between the built-in client and `tagfunc`
---
--- Used via `set tagfunc=v:lua.vim.lsp.tagfunc`
+--- Provides an interface between the built-in client and 'tagfunc'.
+---
+--- When used with normal mode commands (e.g. |CTRL-]|) this will invoke
+--- the "textDocument/definition" LSP method to find the tag under the cursor.
+--- Otherwise, uses "workspace/symbol". If no results are returned from
+--- any LSP servers, falls back to using built-in tags.
+---
+---@param pattern Pattern used to find a workspace symbol
+---@param flags See |tag-function|
+---
+---@returns A list of matching tags
function lsp.tagfunc(...)
return require('vim.lsp.tagfunc')(...)
end