diff --git a/src/elements/Accordion.lua b/src/elements/Accordion.lua index 434f53a..a3e8f14 100644 --- a/src/elements/Accordion.lua +++ b/src/elements/Accordion.lua @@ -3,6 +3,7 @@ local VisualElement = require("elements/VisualElement") local Container = elementManager.getElement("Container") local tHex = require("libraries/colorHex") ---@configDescription An Accordion element that provides collapsible panels with headers. +---@configDefault false --- The Accordion is a container that provides collapsible panel functionality --- @run [[ diff --git a/src/elements/BaseFrame.lua b/src/elements/BaseFrame.lua index 1703fa2..7a4eb49 100644 --- a/src/elements/BaseFrame.lua +++ b/src/elements/BaseFrame.lua @@ -1,6 +1,5 @@ local elementManager = require("elementManager") local Container = elementManager.getElement("Container") -local errorManager = require("errorManager") local Render = require("render") ---@configDescription This is the base frame class. It is the root element of all elements and the only element without a parent. diff --git a/src/elements/Breadcrumb.lua b/src/elements/Breadcrumb.lua index 7c16b7e..6dca8ea 100644 --- a/src/elements/Breadcrumb.lua +++ b/src/elements/Breadcrumb.lua @@ -1,6 +1,7 @@ local elementManager = require("elementManager") local VisualElement = elementManager.getElement("VisualElement") -local tHex = require("libraries/colorHex") +---@configDescription A breadcrumb navigation element that displays the current path. +---@configDefault false ---@class Breadcrumb : VisualElement local Breadcrumb = setmetatable({}, VisualElement) diff --git a/src/elements/ComboBox.lua b/src/elements/ComboBox.lua index 2edac04..5298521 100644 --- a/src/elements/ComboBox.lua +++ b/src/elements/ComboBox.lua @@ -2,7 +2,6 @@ local VisualElement = require("elements/VisualElement") local List = require("elements/List") local DropDown = require("elements/DropDown") local tHex = require("libraries/colorHex") - ---@configDescription A ComboBox that combines dropdown selection with editable text input ---@configDefault false diff --git a/src/elements/ContextMenu.lua b/src/elements/ContextMenu.lua index 6721d3c..3e4d1f5 100644 --- a/src/elements/ContextMenu.lua +++ b/src/elements/ContextMenu.lua @@ -3,6 +3,7 @@ local VisualElement = require("elements/VisualElement") local Container = elementManager.getElement("Container") local tHex = require("libraries/colorHex") ---@configDescription A ContextMenu element that displays a menu with items and submenus. +---@configDefault false --- The ContextMenu displays a list of clickable items with optional submenus --- @run [[ diff --git a/src/elements/Dialog.lua b/src/elements/Dialog.lua index ed8803d..264d97d 100644 --- a/src/elements/Dialog.lua +++ b/src/elements/Dialog.lua @@ -1,7 +1,7 @@ local elementManager = require("elementManager") local Frame = elementManager.getElement("Frame") - ---@configDescription A dialog overlay system with common presets (alert, confirm, prompt). +---@configDefault false --- A dialog overlay system that provides common dialog types such as alert, confirm, and prompt. ---@class Dialog : Frame diff --git a/src/elements/Display.lua b/src/elements/Display.lua index a2b52d1..47f0265 100644 --- a/src/elements/Display.lua +++ b/src/elements/Display.lua @@ -1,8 +1,5 @@ local elementManager = require("elementManager") local VisualElement = elementManager.getElement("VisualElement") -local getCenteredPosition = require("libraries/utils").getCenteredPosition -local deepcopy = require("libraries/utils").deepcopy -local colorHex = require("libraries/colorHex") ---@configDescription The Display is a special element which uses the CC Window API which you can use. ---@configDefault false diff --git a/src/elements/DropDown.lua b/src/elements/DropDown.lua index 5228ed0..936f92d 100644 --- a/src/elements/DropDown.lua +++ b/src/elements/DropDown.lua @@ -1,7 +1,6 @@ local VisualElement = require("elements/VisualElement") local List = require("elements/List") local tHex = require("libraries/colorHex") - ---@configDescription A DropDown menu that shows a list of selectable items ---@configDefault false diff --git a/src/elements/Image.lua b/src/elements/Image.lua index 6ad0405..80c79ca 100644 --- a/src/elements/Image.lua +++ b/src/elements/Image.lua @@ -1,8 +1,7 @@ local elementManager = require("elementManager") local VisualElement = elementManager.getElement("VisualElement") -local tHex = require("libraries/colorHex") ----@configDescription An element that displays an image in bimg format ----@configDefault false +--- @configDescription An element that displays an image in bimg format +--- @configDefault false --- This is the Image element class which can be used to display bimg formatted images. Bimg is a universal ComputerCraft image format. See: https://github.com/SkyTheCodeMaster/bimg ---@class Image : VisualElement diff --git a/src/elements/Label.lua b/src/elements/Label.lua index 679a6d7..22a3e1a 100644 --- a/src/elements/Label.lua +++ b/src/elements/Label.lua @@ -3,8 +3,7 @@ local VisualElement = elementManager.getElement("VisualElement") local wrapText = require("libraries/utils").wrapText ---@configDescription A simple text display element that automatically resizes its width based on the text content. ---- This is the label class. It provides a simple text display element that automatically ---- resizes its width based on the text content. +--- This is the label class. It provides a simple text display element that automatically resizes its width based on the text content. ---@class Label : VisualElement local Label = setmetatable({}, VisualElement) Label.__index = Label diff --git a/src/elements/LineChart.lua b/src/elements/LineChart.lua index 0e6fc91..db20619 100644 --- a/src/elements/LineChart.lua +++ b/src/elements/LineChart.lua @@ -3,7 +3,7 @@ local VisualElement = elementManager.getElement("VisualElement") local Graph = elementManager.getElement("Graph") local tHex = require("libraries/colorHex") --- @configDescription A line chart element based on the graph element ----@configDefault false +--- @configDefault false --- The Line Chart element visualizes data series as connected line graphs. It plots points on a coordinate system and connects them with lines. --- @usage [[ diff --git a/src/elements/Program.lua b/src/elements/Program.lua index 903219d..287e7c4 100644 --- a/src/elements/Program.lua +++ b/src/elements/Program.lua @@ -1,8 +1,8 @@ local elementManager = require("elementManager") local VisualElement = elementManager.getElement("VisualElement") local errorManager = require("errorManager") - --- @configDescription A program that runs in a window +---@configDefault false --- This is the program class. It provides a program that runs in a window. ---@class Program : VisualElement diff --git a/src/elements/ScrollBar.lua b/src/elements/ScrollBar.lua index bf4e616..51eeffa 100644 --- a/src/elements/ScrollBar.lua +++ b/src/elements/ScrollBar.lua @@ -1,6 +1,7 @@ local VisualElement = require("elements/VisualElement") local tHex = require("libraries/colorHex") ---@configDescription A ScrollBar element that can be attached to other elements to control their scroll properties. +---@configDefault false ---A ScrollBar element that can be attached to other elements to control their scroll properties ---@class ScrollBar : VisualElement diff --git a/src/elements/ScrollFrame.lua b/src/elements/ScrollFrame.lua index 8993d76..2f682c0 100644 --- a/src/elements/ScrollFrame.lua +++ b/src/elements/ScrollFrame.lua @@ -2,6 +2,7 @@ local elementManager = require("elementManager") local Container = elementManager.getElement("Container") local tHex = require("libraries/colorHex") ---@configDescription A scrollable container that automatically displays scrollbars when content overflows. +---@configDefault false --- A container that provides automatic scrolling capabilities with visual scrollbars. Displays vertical and/or horizontal scrollbars when child content exceeds the container's dimensions. --- @run [[ diff --git a/src/elements/SideNav.lua b/src/elements/SideNav.lua index 29000b2..ef8089d 100644 --- a/src/elements/SideNav.lua +++ b/src/elements/SideNav.lua @@ -3,6 +3,7 @@ local VisualElement = require("elements/VisualElement") local Container = elementManager.getElement("Container") local tHex = require("libraries/colorHex") ---@configDescription A SideNav element that provides sidebar navigation with multiple content areas. +---@configDefault false --- The SideNav is a container that provides sidebar navigation functionality --- @run [[ diff --git a/src/elements/Slider.lua b/src/elements/Slider.lua index 610cc6b..fe73f9a 100644 --- a/src/elements/Slider.lua +++ b/src/elements/Slider.lua @@ -1,5 +1,6 @@ local VisualElement = require("elements/VisualElement") -local tHex = require("libraries/colorHex") +---@configDescription A slider control element for selecting a value within a range. +---@configDefault false --- This is the slider class. It provides a draggable slider control that can be either horizontal or vertical, --- with customizable colors and value ranges. diff --git a/src/elements/Switch.lua b/src/elements/Switch.lua index aa5e9e8..a0d8c5d 100644 --- a/src/elements/Switch.lua +++ b/src/elements/Switch.lua @@ -2,6 +2,7 @@ local elementManager = require("elementManager") local VisualElement = elementManager.getElement("VisualElement") local tHex = require("libraries/colorHex") ---@configDescription The Switch is a standard Switch element with click handling and state management. +---@configDefault false --- The Switch is a standard Switch element with click handling and state management. ---@class Switch : VisualElement diff --git a/src/elements/TabControl.lua b/src/elements/TabControl.lua index 24a5146..7ed7d53 100644 --- a/src/elements/TabControl.lua +++ b/src/elements/TabControl.lua @@ -2,8 +2,8 @@ local elementManager = require("elementManager") local VisualElement = require("elements/VisualElement") local Container = elementManager.getElement("Container") local tHex = require("libraries/colorHex") -local log = require("log") ---@configDescription A TabControl element that provides tabbed interface with multiple content areas. +---@configDefault false --- The TabControl is a container that provides tabbed interface functionality --- @run [[ diff --git a/src/elements/Table.lua b/src/elements/Table.lua index 8b6ec30..5133332 100644 --- a/src/elements/Table.lua +++ b/src/elements/Table.lua @@ -1,5 +1,7 @@ local Collection = require("elements/Collection") local tHex = require("libraries/colorHex") +---@configDescription The Table is a sortable data grid with customizable columns, row selection, and scrolling capabilities. +---@configDefault false --- This is the table class. It provides a sortable data grid with customizable columns, row selection, and scrolling capabilities. Built on Collection for consistent item management. --- @usage [[ diff --git a/src/elements/Timer.lua b/src/elements/Timer.lua index 229b03b..c8fd129 100644 --- a/src/elements/Timer.lua +++ b/src/elements/Timer.lua @@ -1,6 +1,7 @@ local elementManager = require("elementManager") local BaseElement = elementManager.getElement("BaseElement") ---@cofnigDescription The Timer is a non-visual element that can be used to perform actions at specific intervals. +---@configDefault false --- The Timer is a non-visual element that can be used to perform actions at specific intervals. ---@class Timer : BaseElement diff --git a/src/elements/Toast.lua b/src/elements/Toast.lua index 636ed92..1eefbb1 100644 --- a/src/elements/Toast.lua +++ b/src/elements/Toast.lua @@ -1,8 +1,7 @@ local elementManager = require("elementManager") local VisualElement = elementManager.getElement("VisualElement") -local tHex = require("libraries/colorHex") - ---@configDescription A toast notification element that displays temporary messages. +---@configDefault false --- A toast notification element that displays temporary messages with optional icons and auto-hide functionality. --- The element is always visible but only renders content when a message is shown. diff --git a/src/elements/Tree.lua b/src/elements/Tree.lua index fdf1843..ebbff6f 100644 --- a/src/elements/Tree.lua +++ b/src/elements/Tree.lua @@ -2,6 +2,7 @@ local VisualElement = require("elements/VisualElement") local sub = string.sub local tHex = require("libraries/colorHex") ---@cofnigDescription The tree element provides a hierarchical view of nodes that can be expanded and collapsed, with support for selection and scrolling. +---@configDefault false local function flattenTree(nodes, expandedNodes, level, result) result = result or {} diff --git a/src/plugins/animation.lua b/src/plugins/animation.lua index c29039a..b998b7d 100644 --- a/src/plugins/animation.lua +++ b/src/plugins/animation.lua @@ -1,3 +1,5 @@ +---@configDefault false + local registeredAnimations = {} local easings = { linear = function(progress) diff --git a/src/plugins/benchmark.lua b/src/plugins/benchmark.lua index 933dc89..6d98b41 100644 --- a/src/plugins/benchmark.lua +++ b/src/plugins/benchmark.lua @@ -1,5 +1,5 @@ local log = require("log") - +---@configDefault false local activeProfiles = setmetatable({}, {__mode = "k"}) diff --git a/src/plugins/canvas.lua b/src/plugins/canvas.lua index 0b5b04d..43010ee 100644 --- a/src/plugins/canvas.lua +++ b/src/plugins/canvas.lua @@ -2,6 +2,7 @@ local tHex = require("libraries/colorHex") local errorManager = require("errorManager") local Canvas = {} Canvas.__index = Canvas +---@configDefault false local sub, rep = string.sub, string.rep diff --git a/src/plugins/debug.lua b/src/plugins/debug.lua index 1b389d8..6c9a83d 100644 --- a/src/plugins/debug.lua +++ b/src/plugins/debug.lua @@ -1,5 +1,6 @@ local log = require("log") local tHex = require("libraries/colorHex") +---@configDefault false local maxLines = 10 local isVisible = false diff --git a/src/plugins/reactive.lua b/src/plugins/reactive.lua index 2fb70f2..bf0b1e2 100644 --- a/src/plugins/reactive.lua +++ b/src/plugins/reactive.lua @@ -1,5 +1,6 @@ local errorManager = require("errorManager") local PropertySystem = require("propertySystem") +---@configDefault false local protectedNames = { colors = true, diff --git a/src/plugins/theme.lua b/src/plugins/theme.lua index f151fab..020d062 100644 --- a/src/plugins/theme.lua +++ b/src/plugins/theme.lua @@ -1,4 +1,7 @@ local errorManager = require("errorManager") +---@configDefault false + + local defaultTheme = { default = { background = colors.lightGray, diff --git a/src/plugins/xml.lua b/src/plugins/xml.lua index 8852b73..115b652 100644 --- a/src/plugins/xml.lua +++ b/src/plugins/xml.lua @@ -1,5 +1,8 @@ local errorManager = require("errorManager") local log = require("log") +---@configDefault false + + local XMLNode = { new = function(tag) return {