From f8678d39a4586906b0455250a5eb689556d9e39d Mon Sep 17 00:00:00 2001 From: Uli Schlachter Date: Sat, 8 Apr 2017 11:15:03 +0200 Subject: [PATCH 1/2] Fix parameters docs in awful.hotkeys_popup.widget This fixes broken API docs introduced in commit c183588ba1b9ad0e77c. Signed-off-by: Uli Schlachter --- lib/awful/hotkeys_popup/widget.lua | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/awful/hotkeys_popup/widget.lua b/lib/awful/hotkeys_popup/widget.lua index 5403219b..79121dc7 100644 --- a/lib/awful/hotkeys_popup/widget.lua +++ b/lib/awful/hotkeys_popup/widget.lua @@ -556,8 +556,8 @@ function widget.new(args) end --- Add hotkey group rules for third-party applications. - -- @tparam group hotkeys group name, - -- @tparam data rule data for the group + -- @tparam string group hotkeys group name, + -- @tparam table data rule data for the group -- see `awful.hotkeys_popup.key.vim` as an example. function widget_instance:add_group_rules(group, data) self.group_rules[group] = data @@ -590,11 +590,11 @@ end --- Add hotkey group rules for third-party applications -- (default widget instance will be used). --- @tparam string hotkeys group name, --- @tparam table rule data for the group +-- @tparam string group rule group name, +-- @tparam table data rule data for the group -- see `awful.hotkeys_popup.key.vim` as an example. -function widget.add_group_rules(...) - return get_default_widget():add_group_rules(...) +function widget.add_group_rules(group, data) + return get_default_widget():add_group_rules(group, data) end return widget From 87e69e867702eda70bdb0ee77a7aec8312c0dda1 Mon Sep 17 00:00:00 2001 From: Uli Schlachter Date: Sat, 8 Apr 2017 11:18:07 +0200 Subject: [PATCH 2/2] Add a header to hotkeys_popup.keys.firefox to make LDoc happy Signed-off-by: Uli Schlachter --- lib/awful/hotkeys_popup/keys/firefox.lua | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/lib/awful/hotkeys_popup/keys/firefox.lua b/lib/awful/hotkeys_popup/keys/firefox.lua index 5385db67..2c8aa6ed 100644 --- a/lib/awful/hotkeys_popup/keys/firefox.lua +++ b/lib/awful/hotkeys_popup/keys/firefox.lua @@ -1,3 +1,11 @@ +--------------------------------------------------------------------------- +--- Firefox hotkeys for awful.hotkeys_widget +-- +-- @author Jonathan <jonathan@tinypulse.com> +-- @copyright 2017 Jonathan +-- @module awful.hotkeys_popup.keys.firefox +--------------------------------------------------------------------------- + local hotkeys_popup = require("awful.hotkeys_popup.widget") local fire_rule = { class = { "Firefox" } } for group_name, group_data in pairs({