From ba296e67e40d37c9aeab3bab22f9ea719755888b Mon Sep 17 00:00:00 2001
From: Alexander Courtis <alex@courtis.org>
Date: Mon, 25 Nov 2024 14:50:09 +1100
Subject: [PATCH] feat(#2948): document API

---
 lua/nvim-tree/_meta/api_decorator.lua | 40 +++++++++++++++------------
 1 file changed, 23 insertions(+), 17 deletions(-)

diff --git a/lua/nvim-tree/_meta/api_decorator.lua b/lua/nvim-tree/_meta/api_decorator.lua
index b14dfd256c8..02a88d351ed 100644
--- a/lua/nvim-tree/_meta/api_decorator.lua
+++ b/lua/nvim-tree/_meta/api_decorator.lua
@@ -3,10 +3,10 @@ error("Cannot require a meta file")
 
 local nvim_tree = { api = { decorator = { AbstractDecorator = {} } } }
 
----Custom decorator extends nvim_tree.api.decorator.AbstractDecorator
+---Custom decorator
 ---It may:
 ---  Add icons
----  Set name highlight group
+---  Set highlight group for the name or icons
 ---  Override node icon
 ---Class must be created via nvim_tree.api.decorator.create()
 ---Mandatory constructor  :new()  will be called once per tree render, with no arguments.
@@ -24,46 +24,52 @@ local nvim_tree = { api = { decorator = { AbstractDecorator = {} } } }
 ---Names of predefined decorators or your decorator classes
 ---@alias nvim_tree.api.decorator.Name "Cut" | "Copied" | "Diagnostics" | "Bookmarks" | "Modified" | "Hidden" | "Opened" | "Git" | nvim_tree.api.decorator.AbstractDecorator
 
----Abstract decorator class, your decorator will extend this
+---Abstract decorator class, your decorator will extend this.
 ---
 ---@class (exact) nvim_tree.api.decorator.AbstractDecorator
 ---@field protected enabled boolean
 ---@field protected highlight_range nvim_tree.api.decorator.HighlightRange
 ---@field protected icon_placement nvim_tree.api.decorator.IconPlacement
 
----Abstract no-args constructor must be implemented
+---Abstract: no-args constructor must be implemented.
 ---
 function nvim_tree.api.decorator.AbstractDecorator:new() end
 
----Must be called from your constructor
----
----@class (exact) nvim_tree.api.decorator.AbstractDecoratorInitArgs
----@field enabled boolean
----@field highlight_range nvim_tree.api.decorator.HighlightRange
----@field icon_placement nvim_tree.api.decorator.IconPlacement
----
----@protected
----@param args nvim_tree.api.decorator.AbstractDecoratorInitArgs
-function nvim_tree.api.decorator.AbstractDecorator:init(args) end
-
 ---Abstract: optionally implement to set the node's icon
 ---
 ---@param node nvim_tree.api.Node
 ---@return HighlightedString? icon_node
 function nvim_tree.api.decorator.AbstractDecorator:icon_node(node) end
 
----Abstract: optionally implement to provide icons and the highlight groups for your icon_placement
+---Abstract: optionally implement to provide icons and the highlight groups for your icon_placement.
 ---
 ---@param node nvim_tree.api.Node
 ---@return HighlightedString[]? icons
 function nvim_tree.api.decorator.AbstractDecorator:icons(node) end
 
----Abstract: optionally implement to provide one highlight group to apply to your highlight_range
+---Abstract: optionally implement to provide one highlight group to apply to your highlight_range.
 ---
 ---@param node nvim_tree.api.Node
 ---@return string? highlight_group
 function nvim_tree.api.decorator.AbstractDecorator:highlight_group(node) end
 
+---Must be called from your constructor.
+---
+---@class (exact) nvim_tree.api.decorator.AbstractDecoratorInitArgs
+---@field enabled boolean
+---@field highlight_range nvim_tree.api.decorator.HighlightRange
+---@field icon_placement nvim_tree.api.decorator.IconPlacement
+---
+---@protected
+---@param args nvim_tree.api.decorator.AbstractDecoratorInitArgs
+function nvim_tree.api.decorator.AbstractDecorator:init(args) end
+
+---Define a sign. This should be called in the constructor.
+---
+---@protected
+---@param icon HighlightedString?
+function nvim_tree.api.decorator.AbstractDecorator:define_sign(icon) end
+
 
 --
 -- Example Decorator