standardise on '---@param'

Author: alex-courtis

lua/nvim-tree/renderer/builder.lua

@@ -4,15 +4,15 @@ local notify = require "nvim-tree.notify"
 local pad = require "nvim-tree.renderer.components.padding"
 local icons = require "nvim-tree.renderer.components.icons"
 
---- @class Builder
---- @field private index number
---- @field private depth number
---- @field private highlights table[] hl_group, line, col_start, col_end arguments for vim.api.nvim_buf_add_highlight
---- @field private lines string[] includes icons etc.
---- @field private markers boolean[] indent markers
---- @field private sign_names string[] line signs
---- @field private root_cwd string absolute path
---- @field private decorators Decorator[] in priority order
+---@class Builder
+---@field private index number
+---@field private depth number
+---@field private highlights table[] hl_group, line, col_start, col_end arguments for vim.api.nvim_buf_add_highlight
+---@field private lines string[] includes icons etc.
+---@field private markers boolean[] indent markers
+---@field private sign_names string[] line signs
+---@field private root_cwd string absolute path
+---@field private decorators Decorator[] in priority order
 local Builder = {}
 Builder.__index = Builder
 

lua/nvim-tree/renderer/decorator/bookmarks.lua

@@ -5,12 +5,12 @@ local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
 
 local Decorator = require "nvim-tree.renderer.decorator"
 
---- @class DecoratorBookmarks: Decorator
---- @field icon HighlightedString
+---@class DecoratorBookmarks: Decorator
+---@field icon HighlightedString
 local DecoratorBookmarks = Decorator:new()
 
---- @param opts table
---- @return DecoratorBookmarks
+---@param opts table
+---@return DecoratorBookmarks
 function DecoratorBookmarks:new(opts)
   local o = Decorator.new(self, {
     enabled = true,

lua/nvim-tree/renderer/decorator/copied.lua

@@ -5,13 +5,13 @@ local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
 
 local Decorator = require "nvim-tree.renderer.decorator"
 
---- @class DecoratorCopied: Decorator
---- @field enabled boolean
---- @field icon HighlightedString|nil
+---@class DecoratorCopied: Decorator
+---@field enabled boolean
+---@field icon HighlightedString|nil
 local DecoratorCopied = Decorator:new()
 
---- @param opts table
---- @return DecoratorCopied
+---@param opts table
+---@return DecoratorCopied
 function DecoratorCopied:new(opts)
   local o = Decorator.new(self, {
     enabled = true,

lua/nvim-tree/renderer/decorator/cut.lua

@@ -5,13 +5,13 @@ local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
 
 local Decorator = require "nvim-tree.renderer.decorator"
 
---- @class DecoratorCut: Decorator
---- @field enabled boolean
---- @field icon HighlightedString|nil
+---@class DecoratorCut: Decorator
+---@field enabled boolean
+---@field icon HighlightedString|nil
 local DecoratorCut = Decorator:new()
 
---- @param opts table
---- @return DecoratorCut
+---@param opts table
+---@return DecoratorCut
 function DecoratorCut:new(opts)
   local o = Decorator.new(self, {
     enabled = true,

lua/nvim-tree/renderer/decorator/diagnostics.lua

@@ -30,12 +30,12 @@ local ICON_KEYS = {
   ["hint"] = vim.diagnostic.severity.HINT,
 }
 
---- @class DecoratorDiagnostics: Decorator
---- @field icons HighlightedString[]
+---@class DecoratorDiagnostics: Decorator
+---@field icons HighlightedString[]
 local DecoratorDiagnostics = Decorator:new()
 
---- @param opts table
---- @return DecoratorDiagnostics
+---@param opts table
+---@return DecoratorDiagnostics
 function DecoratorDiagnostics:new(opts)
   local o = Decorator.new(self, {
     enabled = opts.diagnostics.enable,

lua/nvim-tree/renderer/decorator/git.lua

@@ -6,18 +6,18 @@ local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
 
 local Decorator = require "nvim-tree.renderer.decorator"
 
---- @class HighlightedStringGit: HighlightedString
---- @field ord number decreasing priority
-
---- @class DecoratorGit: Decorator
---- @field file_hl table<string, string> by porcelain status e.g. "AM"
---- @field folder_hl table<string, string> by porcelain status
---- @field icons_by_status HighlightedStringGit[] by human status
---- @field icons_by_xy table<string, HighlightedStringGit[]> by porcelain status
+---@class HighlightedStringGit: HighlightedString
+---@field ord number decreasing priority
+
+---@class DecoratorGit: Decorator
+---@field file_hl table<string, string> by porcelain status e.g. "AM"
+---@field folder_hl table<string, string> by porcelain status
+---@field icons_by_status HighlightedStringGit[] by human status
+---@field icons_by_xy table<string, HighlightedStringGit[]> by porcelain status
 local DecoratorGit = Decorator:new()
 
---- @param opts table
---- @return DecoratorGit
+---@param opts table
+---@return DecoratorGit
 function DecoratorGit:new(opts)
   local o = Decorator.new(self, {
     enabled = opts.git.enable,
@@ -46,7 +46,7 @@ function DecoratorGit:new(opts)
   return o
 end
 
---- @param glyphs table<string, string> user glyps
+---@param glyphs table<string, string> user glyps
 function DecoratorGit:build_icons_by_status(glyphs)
   self.icons_by_status = {
     staged = { str = glyphs.staged, hl = { "NvimTreeGitStagedIcon" }, ord = 1 },
@@ -138,8 +138,8 @@ function DecoratorGit:build_hl_table()
 end
 
 --- Git icons: git.enable, renderer.icons.show.git and node has status
---- @param node table
---- @return HighlightedString[]|nil modified icon
+---@param node table
+---@return HighlightedString[]|nil modified icon
 function DecoratorGit:calculate_icons(node)
   if not node or not self.enabled or not self.icons_by_xy then
     return nil

lua/nvim-tree/renderer/decorator/init.lua

@@ -1,14 +1,14 @@
 local HL_POSITION = require("nvim-tree.enum").HL_POSITION
 local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
 
---- @class Decorator
---- @field protected enabled boolean
---- @field protected hl_pos HL_POSITION
---- @field protected icon_placement ICON_PLACEMENT
+---@class Decorator
+---@field protected enabled boolean
+---@field protected hl_pos HL_POSITION
+---@field protected icon_placement ICON_PLACEMENT
 local Decorator = {}
 
---- @param o Decorator|nil
---- @return Decorator
+---@param o Decorator|nil
+---@return Decorator
 function Decorator:new(o)
   o = o or {}
   setmetatable(o, self)
@@ -18,9 +18,9 @@ function Decorator:new(o)
 end
 
 --- Maybe highlight groups
---- @param node table
---- @return string|nil icon highlight group
---- @return string|nil name highlight group
+---@param node table
+---@return string|nil icon highlight group
+---@return string|nil name highlight group
 function Decorator:groups_icon_name(node)
   local icon_hl, name_hl
 
@@ -39,8 +39,8 @@ function Decorator:groups_icon_name(node)
 end
 
 --- Maybe icon sign
---- @param node table
---- @return string|nil name
+---@param node table
+---@return string|nil name
 function Decorator:sign_name(node)
   if not self.enabled or self.icon_placement ~= ICON_PLACEMENT.signcolumn then
     return
@@ -53,8 +53,8 @@ function Decorator:sign_name(node)
 end
 
 --- Icons when ICON_PLACEMENT.before
---- @param node table
---- @return HighlightedString[]|nil icons
+---@param node table
+---@return HighlightedString[]|nil icons
 function Decorator:icons_before(node)
   if not self.enabled or self.icon_placement ~= ICON_PLACEMENT.before then
     return
@@ -64,8 +64,8 @@ function Decorator:icons_before(node)
 end
 
 --- Icons when ICON_PLACEMENT.after
---- @param node table
---- @return HighlightedString[]|nil icons
+---@param node table
+---@return HighlightedString[]|nil icons
 function Decorator:icons_after(node)
   if not self.enabled or self.icon_placement ~= ICON_PLACEMENT.after then
     return
@@ -75,24 +75,24 @@ function Decorator:icons_after(node)
 end
 
 --- Maybe icons, optionally implemented
---- @protected
---- @param _ table node
---- @return HighlightedString[]|nil icons
+---@protected
+---@param _ table node
+---@return HighlightedString[]|nil icons
 function Decorator:calculate_icons(_)
   return nil
 end
 
 --- Maybe highlight group, optionally implemented
---- @protected
---- @param _ table node
---- @return string|nil group
+---@protected
+---@param _ table node
+---@return string|nil group
 function Decorator:calculate_highlight(_)
   return nil
 end
 
 --- Define a sign
---- @protected
---- @param icon HighlightedString|nil
+---@protected
+---@param icon HighlightedString|nil
 function Decorator:define_sign(icon)
   if icon and #icon.hl > 0 then
     local name = icon.hl[1]

lua/nvim-tree/renderer/decorator/modified.lua

@@ -5,12 +5,12 @@ local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
 
 local Decorator = require "nvim-tree.renderer.decorator"
 
---- @class DecoratorModified: Decorator
---- @field icon HighlightedString|nil
+---@class DecoratorModified: Decorator
+---@field icon HighlightedString|nil
 local DecoratorModified = Decorator:new()
 
---- @param opts table
---- @return DecoratorModified
+---@param opts table
+---@return DecoratorModified
 function DecoratorModified:new(opts)
   local o = Decorator.new(self, {
     enabled = opts.modified.enable,

lua/nvim-tree/renderer/decorator/opened.lua

@@ -5,13 +5,13 @@ local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
 
 local Decorator = require "nvim-tree.renderer.decorator"
 
---- @class DecoratorOpened: Decorator
---- @field enabled boolean
---- @field icon HighlightedString|nil
+---@class DecoratorOpened: Decorator
+---@field enabled boolean
+---@field icon HighlightedString|nil
 local DecoratorOpened = Decorator:new()
 
---- @param opts table
---- @return DecoratorOpened
+---@param opts table
+---@return DecoratorOpened
 function DecoratorOpened:new(opts)
   local o = Decorator.new(self, {
     enabled = true,
@@ -24,7 +24,7 @@ function DecoratorOpened:new(opts)
 end
 
 --- Opened highlight: renderer.highlight_opened_files and node has an open buffer
---- @param node table
+---@param node table
 function DecoratorOpened:calculate_highlight(node)
   if self.hl_pos ~= HL_POSITION.none and buffers.is_opened(node) then
     return "NvimTreeOpenedHL"