docs(#3088): extract api/node.lua functions, doc WIP

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -2653,18 +2653,18 @@ buffer.delete({node}, {opts})             *nvim_tree.api.node.buffer.delete()*
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node`) file
-      • {opts}  (`table?`) A table with the following fields:
-                • {force}? (`boolean`, default: false) Delete even if buffer
-                  is modified.
+      • {opts}  (`table?`)
+                • {force}? (`boolean`, default: false) Proceed even if the
+                  buffer is modified.
 
 buffer.wipe({node}, {opts})                 *nvim_tree.api.node.buffer.wipe()*
     Wipes node's related buffer, if one exists. Executes |:bwipe| or |:bwipe|!
 
     Parameters: ~
       • {node}  (`nvim_tree.api.Node?`) file
       • {opts}  (`table?`) optional
-                • {force}? (`boolean`, default: false) Wipe even if buffer is
-                  modified.
+                • {force}? (`boolean`, default: false) Proceed even if the
+                  buffer is modified.
 
 collapse({node}, {opts})                       *nvim_tree.api.node.collapse()*
     Collapse the tree under a directory or a file's parent directory.

lua/nvim-tree/actions/node/buffer.lua

@@ -4,14 +4,14 @@ local notify = require("nvim-tree.notify")
 local M = {}
 
 ---@param node Node
----@param opts ApiNodeDeleteWipeBufferOpts|nil
+---@param opts? nvim_tree.api.node.buffer.RemoveOpts
 ---@return nil
 function M.delete(node, opts)
   M.delete_buffer("delete", node.absolute_path, opts)
 end
 
 ---@param node Node
----@param opts ApiNodeDeleteWipeBufferOpts|nil
+---@param opts? nvim_tree.api.node.buffer.RemoveOpts
 ---@return nil
 function M.wipe(node, opts)
   M.delete_buffer("wipe", node.absolute_path, opts)
@@ -21,7 +21,7 @@ end
 
 ---@param mode ApiNodeDeleteWipeBufferMode
 ---@param filename string
----@param opts ApiNodeDeleteWipeBufferOpts|nil
+---@param opts? nvim_tree.api.node.buffer.RemoveOpts
 ---@return nil
 function M.delete_buffer(mode, filename, opts)
   if type(mode) ~= "string" then

lua/nvim-tree/api/node.lua

@@ -2,6 +2,7 @@
 local nvim_tree = { api = { node = { navigate = { sibling = {}, git = {}, diagnostics = {}, opened = {}, }, run = {}, open = {}, buffer = {}, } } }
 
 
+---
 ---@class nvim_tree.api.node.open.Opts
 ---@inlinedoc
 ---
@@ -15,33 +16,28 @@ local nvim_tree = { api = { node = { navigate = { sibling = {}, git = {}, diagno
 
 
 ---
----Deletes node's related buffer, if one exists. Executes [:bdelete] or [:bdelete]!
----
----@param node nvim_tree.api.Node file
----@param opts? nvim_tree.api.node.buffer.delete.Opts
-function nvim_tree.api.node.buffer.delete(node, opts) end
-
----@class nvim_tree.api.node.buffer.delete.Opts optional
+---@class nvim_tree.api.node.buffer.RemoveOpts
 ---@inlinedoc
 ---
----Delete even if buffer is modified.
+---Proceed even if the buffer is modified.
 ---(default: false)
 ---@field force? boolean
 
+
+---
+---Deletes node's related buffer, if one exists. Executes [:bdelete] or [:bdelete]!
+---
+---@param node nvim_tree.api.Node file
+---@param opts? nvim_tree.api.node.buffer.RemoveOpts
+function nvim_tree.api.node.buffer.delete(node, opts) end
+
 ---
 ---Wipes node's related buffer, if one exists. Executes [:bwipe] or [:bwipe]!
 ---
 ---@param node? nvim_tree.api.Node file
----@param opts? nvim_tree.api.node.buffer.wipe.Opts optional
+---@param opts? nvim_tree.api.node.buffer.RemoveOpts optional
 function nvim_tree.api.node.buffer.wipe(node, opts) end
 
----@class nvim_tree.api.node.buffer.wipe.Opts
----@inlinedoc
----
----Wipe even if buffer is modified.
----(default: false)
----@field force? boolean
-
 ---
 ---Collapse the tree under a directory or a file's parent directory.
 ---