mirror of
https://github.com/neovim/neovim.git
synced 2025-11-03 17:24:29 +00:00
f62728cd80
**Problem:** The documentation for `TSNode` and `TSTree` methods is incomplete from the LSP perspective. This is because they are written directly to the vimdoc, rather than in Lua and generated to vimdoc. **Solution:** Migrate the docs to Lua and generate them into the vimdoc. This requires breaking up the `treesitter/_meta.lua` file into a directory with a few different modules. This commit also makes the vimdoc generator slightly more robust with regard to sections that have multiple help tags (e.g. `*one* *two*`)
45 lines
1.2 KiB
Lua
45 lines
1.2 KiB
Lua
---@meta
|
|
-- luacheck: no unused args
|
|
error('Cannot require a meta file')
|
|
|
|
--- @brief A "treesitter tree" represents the parsed contents of a buffer, which can be
|
|
--- used to perform further analysis. It is a |userdata| reference to an object
|
|
--- held by the treesitter library.
|
|
---
|
|
--- An instance `TSTree` of a treesitter tree supports the following methods.
|
|
|
|
---@nodoc
|
|
---@class TSTree: userdata
|
|
local TSTree = {} -- luacheck: no unused
|
|
|
|
--- Return the root node of this tree.
|
|
---@return TSNode
|
|
function TSTree:root() end
|
|
|
|
-- stylua: ignore
|
|
---@param start_byte integer
|
|
---@param end_byte_old integer
|
|
---@param end_byte_new integer
|
|
---@param start_row integer
|
|
---@param start_col integer
|
|
---@param end_row_old integer
|
|
---@param end_col_old integer
|
|
---@param end_row_new integer
|
|
---@param end_col_new integer
|
|
---@nodoc
|
|
function TSTree:edit(start_byte, end_byte_old, end_byte_new, start_row, start_col, end_row_old, end_col_old, end_row_new, end_col_new) end
|
|
|
|
--- Returns a copy of the `TSTree`.
|
|
---@return TSTree
|
|
function TSTree:copy() end
|
|
|
|
---@param include_bytes true
|
|
---@return Range6[]
|
|
---@nodoc
|
|
function TSTree:included_ranges(include_bytes) end
|
|
|
|
---@param include_bytes false
|
|
---@return Range4[]
|
|
---@nodoc
|
|
function TSTree:included_ranges(include_bytes) end
|