From e56662f6ad34857ea2e16a13879585bfdbb729e7 Mon Sep 17 00:00:00 2001 From: Zsolt Tasnadi Date: Thu, 26 Feb 2026 16:21:25 +0100 Subject: [PATCH] linter and doc fix for Focus --- .luacheckrc | 1 + inc/system/system.focus.lua | 12 ++++++------ 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/.luacheckrc b/.luacheckrc index 277703e..73a56b4 100644 --- a/.luacheckrc +++ b/.luacheckrc @@ -2,6 +2,7 @@ -- Configuration for luacheck globals = { + "Focus", "Util", "Decision", "Situation", diff --git a/inc/system/system.focus.lua b/inc/system/system.focus.lua index 308b836..d37d00f 100644 --- a/inc/system/system.focus.lua +++ b/inc/system/system.focus.lua @@ -21,8 +21,8 @@ end --- Starts a focus overlay that reveals content through an expanding circle. --- @within Focus ---- @param center_x number The x-coordinate of the circle center. ---- @param center_y number The y-coordinate of the circle center. +--- @param cx number The x-coordinate of the circle center. +--- @param cy number The y-coordinate of the circle center. --- @param[opt] params table Optional parameters: `speed` (number) expansion rate in pixels/frame, `initial_radius` (number) starting radius in pixels (default 0), `on_complete` (function) callback when overlay disperses. function Focus.start(cx, cy, params) params = params or {} @@ -38,8 +38,8 @@ end --- Starts a closing focus overlay that hides content by shrinking the visible circle. --- @within Focus ---- @param center_x number The x-coordinate of the circle center. ---- @param center_y number The y-coordinate of the circle center. +--- @param cx number The x-coordinate of the circle center. +--- @param cy number The y-coordinate of the circle center. --- @param[opt] params table Optional parameters: `speed` (number) shrink rate in pixels/frame, `on_complete` (function) callback when screen is fully covered. function Focus.close(cx, cy, params) params = params or {} @@ -56,8 +56,8 @@ end --- Starts a driven focus overlay whose radius is controlled externally via Focus.set_percentage(). --- The radius maps linearly from initial_radius (at 0%) to the screen corner distance (at 100%). --- @within Focus ---- @param center_x number The x-coordinate of the circle center. ---- @param center_y number The y-coordinate of the circle center. +--- @param cx number The x-coordinate of the circle center. +--- @param cy number The y-coordinate of the circle center. --- @param[opt] params table Optional parameters: `initial_radius` (number) radius at 0% (default 0). function Focus.start_driven(cx, cy, params) params = params or {}