doc: Updated type definitions

Author: OXY2DEV

lua/bars.lua

@@ -1,26 +1,16 @@
 local bars = {};
 
----@class bars.config
----
---- When true, all options are set
---- globally.
---- Can be used to prevent visible
---- changes to the bars & lines when
---- opening Neovim or new windows.
----@field global boolean
----
----@field statusline statusline.config
----@field statuscolumn statuscolumn.config
----@field winbar winbar.config
----
----@field tabline tabline.config
+---@type bars.config
 bars.config = {
 	global = true
 };
 
+--- Setup function.
+--- Should be optional.
+---@param config bars.config | nil
 bars.setup = function (config)
+	--- Update the configuration.
 	if type(config) == "table" then
-		--- Update configuration.
 		bars.config = vim.tbl_deep_extend("force", bars.config, config);
 	end
 

lua/definitions/bars.lua

@@ -0,0 +1,15 @@
+--- Primary configuration table.
+---@class bars.config
+---
+--- When true, all options are set
+--- **globally**.
+--- Can be used to prevent visible
+--- changes to the bars & lines when
+--- opening Neovim or new windows.
+---@field global? boolean
+---
+---@field statusline? statusline.config Statusline configuration.
+---@field statuscolumn? statuscolumn.config Statuscolumn configuration.
+---@field winbar? winbar.config Winbar configuration.
+---
+---@field tabline? tabline.config Tabline configuration.

lua/definitions/statuscolumn.lua

@@ -83,42 +83,97 @@
 ---@field hl? string | string[]
 
 
+--- Empty section.
 ---@class statuscolumn.parts.empty
 ---
+--- Condition for this component.
+---@field condition? fun(buffer: integer, window: integer, statuscolumn: string): boolean
+---
+--- What kind of part is this?
 ---@field kind "empty"
+---
+--- How many columns should this span?
 ---@field len integer
 ---
+--- Highlight group for this section.
 ---@field hl? string
 
 
+--- Border for the statuscolumn.
 ---@class statuscolumn.parts.border
 ---
+--- What kind of component is this?
 ---@field kind "border"
 ---
+--- Text to use for the border.
+--- Can be a list to create a gradient.
 ---@field text string | string[]
+---
+--- Highlight group for the border.
+--- Can be a list to create a gradient.
 ---@field hl? string | string[]
 
 
+--- Fold column for the statuscolumn.
 ---@class statuscolumn.parts.folds
 ---
+--- What kind of component is this?
 ---@field kind "folds"
 ---
+--- Text to show for closed fold.
+--- Can be a list to use a different
+--- text for different levels of folds.
 ---@field close_text string | string[]
+---
+--- Highlight group for the `close_text`.
+--- Can be a list to assign different
+--- colors to different fold level.
 ---@field close_hl? string | string[]
 ---
+--- Text to show for opened fold.
+--- Can be a list to use a different
+--- text for different levels of folds.
 ---@field open_text string | string[]
+---
+--- Highlight group for the `open_text`.
+--- Can be a list to assign different
+--- colors to different fold level.
 ---@field open_hl? string | string[]
 ---
+--- Text to show the scope of opened fold.
+--- Can be a list to use a different
+--- text for different levels of folds.
 ---@field scope_text string | string[]
+---
+--- Highlight group for the `scope_text`.
+--- Can be a list to assign different
+--- colors to different fold level.
 ---@field scope_hl? string | string[]
 ---
+--- Text to show at the end of opened fold.
+--- Can be a list to use a different
+--- text for different levels of folds.
 ---@field scope_end_text string | string[]
+---
+--- Highlight group for the `scope_end_text`.
+--- Can be a list to assign different
+--- colors to different fold level.
 ---@field scope_end_hl? string | string[]
 ---
+--- Text to show where fold level changes.
+--- Can be a list to use a different
+--- text for different levels of folds.
 ---@field scope_merge_text string | string[]
+---
+--- Highlight group for the `scope_merge_text`.
+--- Can be a list to assign different
+--- colors to different fold level.
 ---@field scope_merge_hl? string | string[]
 ---
----@field fill_text string | string[]
+--- Text for normal lines.
+---@field fill_text string
+---
+--- Highlight group for `fill_text`.
 ---@field fill_hl? string