diff --git a/lib/awful/hotkeys_popup/init.lua b/lib/awful/hotkeys_popup/init.lua index 2e61e5cc3..182fe5abc 100644 --- a/lib/awful/hotkeys_popup/init.lua +++ b/lib/awful/hotkeys_popup/init.lua @@ -10,15 +10,22 @@ local hotkeys_popup = { widget = require("awful.hotkeys_popup.widget"), } ---- This is the same as awful.hotkeys_popup.widget.show_help +--- This is the same as awful.hotkeys_popup.widget.show_help. -- -- example usage: +-- -- local hotkeys_popup = require("awful.hotkeys_popup") -- myawesomemenu = {{ "hotkeys", function() hotkeys_popup.show_help() end }, -- -- -- } -- -- see `awful.hotkeys_popup.widget.show_help` for more information +-- @tparam[opt] client c The hostkeys for the client "c". +-- @tparam[opt] screen s The screen. +-- @tparam[opt=true] boolean show_args.show_awesome_keys Show AwesomeWM hotkeys. +-- When set to `false` only app-specific hotkeys will be shown. +-- @function awful.hotkeys_popup.show_help +-- @see awful.hotkeys_popup.widget.show_help hotkeys_popup.show_help = hotkeys_popup.widget.show_help return hotkeys_popup