doc: Document the naughty.action "invoked" signal.

This commit is contained in:
Emmanuel Lepage Vallee 2021-09-16 17:25:46 -07:00
parent 17bd5fb036
commit e27b908ca0
1 changed files with 6 additions and 0 deletions

View File

@ -57,7 +57,13 @@ local action = {}
-- @propemits true false
--- When a notification is invoked.
--
-- Note that it is possible to call `:invoke()` without a notification object.
-- It is possible the `notification` parameter will be nil.
--
-- @signal invoked
-- @tparam naughty.action action The action.
-- @tparam naughty.notification|nil notification The notification, if known.
function action:get_selected()
return self._private.selected