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

doc(awful.key) Declarative constructor parameters

This commit is contained in:
Aire-One 2021-06-12 14:38:18 +02:00
parent b63399f656
commit 948506cde1
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
lib/awful/key.lua
View File

@ -216,11 +216,13 @@ end
--
-- @constructorfct2 awful.key
-- @tparam table args
-- @tparam function args.key The key to trigger an event. It can be the character
-- itself of `#+keycode` (**mandatory**).
-- @tparam function args.modifiers A list of modifier keys. Valid modifiers are:
-- `Any`, `Mod1`, Mod2`, `Mod3`, `Mod4`, `Mod5`, `Shift`, `Lock` and `Control`.
-- This argument is (**mandatory**).
-- @tparam string args.key The key to trigger an event. It can be the character
-- itself of `#+keycode`.
-- @tparam[opt] string args.keygroup The keygroup to trigger an event. This
-- parameter must be used as a replacement for the `key` parameter. See
-- @{awful.key.keygroup}.
-- @tparam table args.modifiers A list of modifier keys. Valid modifiers are:
-- `Any`, `Mod1`, Mod2`, `Mod3`, `Mod4`, `Mod5`, `Shift`, `Lock` and `Control`.
-- @tparam function args.on_press Callback for when the key is pressed.
-- @tparam function args.on_release Callback for when the key is released.