diff options
| author | Yi Ming <ofseed@foxmail.com> | 2024-08-06 19:28:42 +0800 |
|---|---|---|
| committer | Christian Clason <c.clason@uni-graz.at> | 2024-08-06 18:18:34 +0200 |
| commit | 0a1212ef94547f04db789a660639fab6837e00ce (patch) | |
| tree | 64321422332dad8ce2038cec1d3ba861095b6c1e /runtime/lua/vim/treesitter/languagetree.lua | |
| parent | cc26cf0400286990d553bee993c9b113ca4cbc46 (diff) | |
| download | rneovim-0a1212ef94547f04db789a660639fab6837e00ce.tar.gz rneovim-0a1212ef94547f04db789a660639fab6837e00ce.tar.bz2 rneovim-0a1212ef94547f04db789a660639fab6837e00ce.zip | |
docs(treesitter): generate inline docs for `Range`s
docs(treesitter): in-place parameter description
docs(treesitter): remove internal type names
docs(treesitter): add missing private annotation
Diffstat (limited to 'runtime/lua/vim/treesitter/languagetree.lua')
| -rw-r--r-- | runtime/lua/vim/treesitter/languagetree.lua | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua index 03803f5869..d43a0a5d0b 100644 --- a/runtime/lua/vim/treesitter/languagetree.lua +++ b/runtime/lua/vim/treesitter/languagetree.lua @@ -638,6 +638,8 @@ end ---Gets the set of included regions managed by this LanguageTree. This can be different from the ---regions set by injection query, because a partial |LanguageTree:parse()| drops the regions ---outside the requested range. +---Each list represents a range in the form of +---{ {start_row}, {start_col}, {start_bytes}, {end_row}, {end_col}, {end_bytes} }. ---@return table<integer, Range6[]> function LanguageTree:included_regions() if self._regions then @@ -1087,7 +1089,7 @@ end --- Determines whether {range} is contained in the |LanguageTree|. --- ----@param range Range4 `{ start_line, start_col, end_line, end_col }` +---@param range Range4 ---@return boolean function LanguageTree:contains(range) for _, tree in pairs(self._trees) do @@ -1108,7 +1110,7 @@ end --- Gets the tree that contains {range}. --- ----@param range Range4 `{ start_line, start_col, end_line, end_col }` +---@param range Range4 ---@param opts? vim.treesitter.LanguageTree.tree_for_range.Opts ---@return TSTree? function LanguageTree:tree_for_range(range, opts) @@ -1135,7 +1137,7 @@ end --- Gets the smallest node that contains {range}. --- ----@param range Range4 `{ start_line, start_col, end_line, end_col }` +---@param range Range4 ---@param opts? vim.treesitter.LanguageTree.tree_for_range.Opts ---@return TSNode? function LanguageTree:node_for_range(range, opts) @@ -1147,7 +1149,7 @@ end --- Gets the smallest named node that contains {range}. --- ----@param range Range4 `{ start_line, start_col, end_line, end_col }` +---@param range Range4 ---@param opts? vim.treesitter.LanguageTree.tree_for_range.Opts ---@return TSNode? function LanguageTree:named_node_for_range(range, opts) @@ -1159,7 +1161,7 @@ end --- Gets the appropriate language that contains {range}. --- ----@param range Range4 `{ start_line, start_col, end_line, end_col }` +---@param range Range4 ---@return vim.treesitter.LanguageTree tree Managing {range} function LanguageTree:language_for_range(range) for _, child in pairs(self._children) do |