mirror of
https://github.com/neovim/neovim.git
synced 2025-12-15 19:05:40 +00:00
docs: Treesitter (#13260)
* doc & fixes: Generate treesitter docs * fixup to treesitter-core * docs(treesitter): fix docs for most functions Co-authored-by: Thomas Vigouroux <tomvig38@gmail.com>
This commit is contained in:
@@ -25,12 +25,12 @@ setmetatable(M, {
|
||||
})
|
||||
|
||||
--- Creates a new parser.
|
||||
--
|
||||
-- It is not recommended to use this, use vim.treesitter.get_parser() instead.
|
||||
--
|
||||
-- @param bufnr The buffer the parser will be tied to
|
||||
-- @param lang The language of the parser
|
||||
-- @param opts Options to pass to the language tree
|
||||
---
|
||||
--- It is not recommended to use this, use vim.treesitter.get_parser() instead.
|
||||
---
|
||||
--- @param bufnr The buffer the parser will be tied to
|
||||
--- @param lang The language of the parser
|
||||
--- @param opts Options to pass to the created language tree
|
||||
function M._create_parser(bufnr, lang, opts)
|
||||
language.require_language(lang)
|
||||
if bufnr == 0 then
|
||||
@@ -41,10 +41,12 @@ function M._create_parser(bufnr, lang, opts)
|
||||
|
||||
local self = LanguageTree.new(bufnr, lang, opts)
|
||||
|
||||
---@private
|
||||
local function bytes_cb(_, ...)
|
||||
self:_on_bytes(...)
|
||||
end
|
||||
|
||||
---@private
|
||||
local function detach_cb(_, ...)
|
||||
if parsers[bufnr] == self then
|
||||
parsers[bufnr] = nil
|
||||
@@ -52,6 +54,7 @@ function M._create_parser(bufnr, lang, opts)
|
||||
self:_on_detach(...)
|
||||
end
|
||||
|
||||
---@private
|
||||
local function reload_cb(_, ...)
|
||||
self:_on_reload(...)
|
||||
end
|
||||
@@ -64,15 +67,15 @@ function M._create_parser(bufnr, lang, opts)
|
||||
end
|
||||
|
||||
--- Gets the parser for this bufnr / ft combination.
|
||||
--
|
||||
-- If needed this will create the parser.
|
||||
-- Unconditionnally attach the provided callback
|
||||
--
|
||||
-- @param bufnr The buffer the parser should be tied to
|
||||
-- @param ft The filetype of this parser
|
||||
-- @param opts Options object to pass to the parser
|
||||
--
|
||||
-- @returns The parser
|
||||
---
|
||||
--- If needed this will create the parser.
|
||||
--- Unconditionnally attach the provided callback
|
||||
---
|
||||
--- @param bufnr The buffer the parser should be tied to
|
||||
--- @param lang The filetype of this parser
|
||||
--- @param opts Options object to pass to the created language tree
|
||||
---
|
||||
--- @returns The parser
|
||||
function M.get_parser(bufnr, lang, opts)
|
||||
opts = opts or {}
|
||||
|
||||
@@ -92,6 +95,11 @@ function M.get_parser(bufnr, lang, opts)
|
||||
return parsers[bufnr]
|
||||
end
|
||||
|
||||
--- Gets a string parser
|
||||
---
|
||||
--- @param str The string to parse
|
||||
--- @param lang The language of this string
|
||||
--- @param opts Options to pass to the created language tree
|
||||
function M.get_string_parser(str, lang, opts)
|
||||
vim.validate {
|
||||
str = { str, 'string' },
|
||||
|
||||
Reference in New Issue
Block a user