ldoc return fixes

This commit is contained in:
2026-02-26 17:41:06 +01:00
parent e56662f6ad
commit 337f1fc132
21 changed files with 279 additions and 262 deletions

View File

@@ -5,14 +5,14 @@
--- @within Util
--- @param array table The array to index.
--- @param index number The desired index (can be out of bounds).
--- @return number The wrapped index within the array's bounds.
--- @return number index The wrapped index within the array's bounds.
function Util.safeindex(array, index)
return ((index - 1 + #array) % #array) + 1
end
--- Navigates to a screen by its ID.
--- @within Util
--- @param screen_id string The ID of the screen to go to.
--- @param screen_id string The ID of the screen to go to.<br/>
function Util.go_to_screen_by_id(screen_id)
local screen = Screen.get_by_id(screen_id)
if screen then
@@ -26,7 +26,8 @@ end
--- Checks if a table contains a specific value.
--- @within Util
--- @param t table The table to check.
--- @param value any The value to look for.
--- @param value any The value to look for.<br/>
--- @return boolean true if the value is found, false otherwise.
function Util.contains(t, value)
for i = 1, #t do
if t[i] == value then