From c32c2bf43d87862cbf83f5ccb386fccd975c1840 Mon Sep 17 00:00:00 2001 From: Emmanuel Lepage-Vallee Date: Sat, 21 Dec 2019 21:27:21 -0800 Subject: [PATCH] doc: Upgrade the keygrabber to the newest standards. --- lib/awful/keygrabber.lua | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lib/awful/keygrabber.lua b/lib/awful/keygrabber.lua index 6d5c45ae9..eca79fa18 100644 --- a/lib/awful/keygrabber.lua +++ b/lib/awful/keygrabber.lua @@ -406,7 +406,7 @@ end -- poluting the original object of having extra boilerplate code. -- -- @tfield keygrabber current_instance --- @see property::current_instance +-- @emits property::current_instance --- The global signal used to track the `current_instance`. -- @@ -422,6 +422,8 @@ end -- -- @method start -- @treturn boolean If the keygrabber was successfully started. +-- @emits started +-- @emits property::current_instance function keygrabber:start() if self.grabber or keygrab.current_instance then return false @@ -473,6 +475,8 @@ end --- Stop the keygrabber. -- @method stop +-- @emits stopped +-- @emits property::current_instance function keygrabber:stop(_stop_key, _stop_mods) -- (at)function disables ldoc params keygrab.stop(self.grabber)