awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc: Make sure all client.focus functions are in the same section. 

Some were in the @staticfct and some in the @function sections.
This commit is contained in:
Emmanuel Lepage Vallee 2021-10-17 19:55:20 -07:00
parent ae71158093
commit cbec148540
2 changed files with 21 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
lib/awful/client.lua
View File

@ -1857,12 +1857,7 @@ end
-- Connect to "focus" signal, and allow to disable tracking. -- Connect to "focus" signal, and allow to disable tracking.
do do
local disabled_count = 1 local disabled_count = 1
--- Disable history tracking.
--
-- See `awful.client.focus.history.enable_tracking` to enable it again.
-- @treturn int The internal value of `disabled_count` (calls to this
-- function without calling `awful.client.focus.history.enable_tracking`).
-- @staticfct awful.client.focus.history.disable_tracking
function client.focus.history.disable_tracking() function client.focus.history.disable_tracking()
disabled_count = disabled_count + 1 disabled_count = disabled_count + 1
if disabled_count == 1 then if disabled_count == 1 then
@ -1871,12 +1866,6 @@ do
return disabled_count return disabled_count
end end
--- Enable history tracking.
--
-- This is the default, but can be disabled
-- through `awful.client.focus.history.disable_tracking`.
-- @treturn boolean True if history tracking has been enabled.
-- @staticfct awful.client.focus.history.enable_tracking
function client.focus.history.enable_tracking() function client.focus.history.enable_tracking()
assert(disabled_count > 0) assert(disabled_count > 0)
disabled_count = disabled_count - 1 disabled_count = disabled_count - 1
@ -1886,10 +1875,6 @@ do
return disabled_count == 0 return disabled_count == 0
end end
--- Is history tracking enabled?
-- @treturn bool True if history tracking is enabled.
-- @treturn int The number of times that tracking has been disabled.
-- @staticfct awful.client.focus.history.is_enabled
function client.focus.history.is_enabled() function client.focus.history.is_enabled()
return disabled_count == 0, disabled_count return disabled_count == 0, disabled_count
end end

20
lib/awful/client/focus.lua
View File

@ -218,6 +218,26 @@ function focus.global_bydirection(dir, c, stacked)
end end
end end
--- Is history tracking enabled?
-- @treturn bool True if history tracking is enabled.
-- @treturn int The number of times that tracking has been disabled.
-- @function awful.client.focus.history.is_enabled
--- Enable history tracking.
--
-- This is the default, but can be disabled
-- through `awful.client.focus.history.disable_tracking`.
-- @treturn boolean True if history tracking has been enabled.
-- @function awful.client.focus.history.enable_tracking
--- Disable history tracking.
--
-- See `awful.client.focus.history.enable_tracking` to enable it again.
-- @treturn int The internal value of `disabled_count` (calls to this
-- function without calling `awful.client.focus.history.enable_tracking`).
-- @function awful.client.focus.history.disable_tracking
return focus return focus
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80 -- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80