Aire-One
/
awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: Upgrade the keygrabber to the newest standards.

This commit is contained in:
Emmanuel Lepage-Vallee 2019-12-21 21:27:21 -08:00
parent 3af095e4b0
commit c32c2bf43d
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
lib/awful/keygrabber.lua
View File

@ -406,7 +406,7 @@ end
-- poluting the original object of having extra boilerplate code. -- poluting the original object of having extra boilerplate code.
-- --
-- @tfield keygrabber current_instance -- @tfield keygrabber current_instance
-- @see property::current_instance -- @emits property::current_instance
--- The global signal used to track the `current_instance`. --- The global signal used to track the `current_instance`.
-- --
@ -422,6 +422,8 @@ end
-- --
-- @method start -- @method start
-- @treturn boolean If the keygrabber was successfully started. -- @treturn boolean If the keygrabber was successfully started.
-- @emits started
-- @emits property::current_instance
function keygrabber:start() function keygrabber:start()
if self.grabber or keygrab.current_instance then if self.grabber or keygrab.current_instance then
return false return false
@ -473,6 +475,8 @@ end
--- Stop the keygrabber. --- Stop the keygrabber.
-- @method stop -- @method stop
-- @emits stopped
-- @emits property::current_instance
function keygrabber:stop(_stop_key, _stop_mods) -- (at)function disables ldoc params function keygrabber:stop(_stop_key, _stop_mods) -- (at)function disables ldoc params
keygrab.stop(self.grabber) keygrab.stop(self.grabber)