aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJaehwang Jung <tomtomjhj@gmail.com>2023-03-05 01:47:30 +0900
committerGitHub <noreply@github.com>2023-03-04 17:47:30 +0100
commit59542504b41dfddb6f26524fb4ce811e0f22a785 (patch)
tree66988840ab1c45b5a7dfe320ee0b7b56528cfb81
parent46c4cbced567f5f05f2c95b91cd90084ea8b5528 (diff)
downloadrneovim-59542504b41dfddb6f26524fb4ce811e0f22a785.tar.gz
rneovim-59542504b41dfddb6f26524fb4ce811e0f22a785.tar.bz2
rneovim-59542504b41dfddb6f26524fb4ce811e0f22a785.zip
docs(highlight): fix type annotations (#22272)
-rw-r--r--runtime/lua/vim/highlight.lua14
1 files changed, 7 insertions, 7 deletions
diff --git a/runtime/lua/vim/highlight.lua b/runtime/lua/vim/highlight.lua
index 20ad48dd27..89eae0def5 100644
--- a/runtime/lua/vim/highlight.lua
+++ b/runtime/lua/vim/highlight.lua
@@ -36,12 +36,12 @@ end
--- Highlight range between two positions
---
----@param bufnr number of buffer to apply highlighting to
----@param ns namespace to add highlight to
----@param higroup highlight group to use for highlighting
----@param start first position (tuple {line,col})
----@param finish second position (tuple {line,col})
----@param opts table with options:
+---@param bufnr integer Buffer number to apply highlighting to
+---@param ns integer Namespace to add highlight to
+---@param higroup string Highlight group to use for highlighting
+---@param start { [1]: integer, [2]: integer } Start position {line, col}
+---@param finish { [1]: integer, [2]: integer } Finish position {line, col}
+---@param opts table|nil Optional parameters
-- - regtype type of range (see |setreg()|, default charwise)
-- - inclusive boolean indicating whether the range is end-inclusive (default false)
-- - priority number indicating priority of highlight (default priorities.user)
@@ -84,7 +84,7 @@ local yank_timer
--- customize conditions (here: do not highlight a visual selection) via
--- au TextYankPost * lua vim.highlight.on_yank {on_visual=false}
---
--- @param opts table with options controlling the highlight:
+-- @param opts table|nil Optional parameters
-- - higroup highlight group for yanked region (default "IncSearch")
-- - timeout time in ms before highlight is cleared (default 150)
-- - on_macro highlight when executing macro (default false)