Docs Update

src/elements/BaseFrame.lua

@@ -2,11 +2,14 @@ local elementManager = require("elementManager")
 local Container = elementManager.getElement("Container")
 local Render = require("render")
 
+--- This is the base frame class. It is the root element of all elements and the only element without a parent.
 ---@class BaseFrame : Container
+---@field _render Render The render object
+---@field _renderUpdate boolean Whether the render object needs to be updated
 local BaseFrame = setmetatable({}, Container)
 BaseFrame.__index = BaseFrame
 
----@property text term term nil text
+---@property text term nil The terminal object to render to
 BaseFrame.defineProperty(BaseFrame, "term", {default = nil, type = "table", setter = function(self, value)
     if value == nil or value.setCursorPos == nil then
         return value
@@ -19,6 +22,10 @@ BaseFrame.defineProperty(BaseFrame, "term", {default = nil, type = "table", sett
     return value
 end})
 
+--- Creates a new Frame instance
+--- @shortDescription Creates a new Frame instance
+--- @return BaseFrame object The newly created Frame instance
+--- @usage local element = BaseFrame.new()
 function BaseFrame.new()
     local self = setmetatable({}, BaseFrame):__init()
     self.set("term", term.current())
@@ -26,32 +33,73 @@ function BaseFrame.new()
     return self
 end
 
+--- Initializes the Frame instance
+--- @shortDescription Initializes the Frame instance
+--- @param props table The properties to initialize the element with
+--- @param basalt table The basalt instance
+--- @return table self The initialized instance
 function BaseFrame:init(props, basalt)
     Container.init(self, props, basalt)
     self.set("type", "BaseFrame")
+    return self
 end
 
+--- Renders a multiBlit to the render Object
+--- @shortDescription Renders a multiBlit to the render Object
+--- @param x number The x position to render to
+--- @param y number The y position to render to
+--- @param width number The width of the text
+--- @param height number The height of the text
+--- @param text string The text to render
+--- @param fg string The foreground color
+--- @param bg string The background color
 function BaseFrame:multiBlit(x, y, width, height, text, fg, bg)
     self._render:multiBlit(x, y, width, height, text, fg, bg)
 end
 
+--- Renders a text with a foreground color to the render Object
+--- @shortDescription Renders a text with a foreground color to the render Object
+--- @param x number The x position to render to
+--- @param y number The y position to render to
+--- @param text string The text to render
+--- @param fg colors The foreground color
 function BaseFrame:textFg(x, y, text, fg)
     self._render:textFg(x, y, text, fg)
 end
 
+--- Renders a text with a background color to the render Object
+--- @shortDescription Renders a text with a background color to the render Object
+--- @param x number The x position to render to
+--- @param y number The y position to render to
+--- @param text string The text to render
+--- @param bg colors The background color
 function BaseFrame:textBg(x, y, text, bg)
     self._render:textBg(x, y, text, bg)
 end
 
+--- Renders a text with a foreground and background color to the render Object
+--- @shortDescription Renders a text with a foreground and background color to the render Object
+--- @param x number The x position to render to
+--- @param y number The y position to render to
+--- @param text string The text to render
+--- @param fg string The foreground color
+--- @param bg string The background color
 function BaseFrame:blit(x, y, text, fg, bg)
     self._render:blit(x, y, text, fg, bg)
 end
 
+--- Sets the cursor position
+--- @shortDescription Sets the cursor position
+--- @param x number The x position to set the cursor to
+--- @param y number The y position to set the cursor to
+--- @param blink boolean Whether the cursor should blink
 function BaseFrame:setCursor(x, y, blink)
     local term = self.get("term")
     self._render:setCursor(x, y, blink)
 end
 
+--- Renders the Frame
+--- @shortDescription Renders the Frame
 function BaseFrame:render()
     if(self._renderUpdate) then
         if self._render ~= nil then