diff --git a/docs/config.ld b/docs/config.ld index 398ef1a24..3a264f90c 100644 --- a/docs/config.ld +++ b/docs/config.ld @@ -118,10 +118,8 @@ file = { '../spawn.c', '../xkb.c', '../common/luaobject.c', - '../objects/button.c', '../objects/client.c', '../objects/drawable.c', - '../objects/key.c', '../objects/screen.c', '../objects/tag.c', '../objects/window.c', @@ -155,6 +153,11 @@ file = { '../lib/naughty/list/init.lua', '../lib/naughty/widget/_default.lua', + -- Ignore components that provide no value to users and have confusing + -- names + '../objects/button.c', + '../objects/key.c', + -- Deprecated classes for one years or more don't deserve entries -- in the index '../lib/awful/widget/graph.lua', diff --git a/lib/awful/button.lua b/lib/awful/button.lua index 39a035653..b59303f05 100644 --- a/lib/awful/button.lua +++ b/lib/awful/button.lua @@ -35,7 +35,6 @@ local ignore_modifiers = { "Lock", "Mod2" } -- will return 2 button objects: one with CapsLock on, and the other one with -- CapsLock off. -- --- @see button -- @treturn table A table with one or several button objects. function button.new(mod, _button, press, release) local ret = {} diff --git a/lib/awful/key.lua b/lib/awful/key.lua index 6e0a56919..5826a7c97 100644 --- a/lib/awful/key.lua +++ b/lib/awful/key.lua @@ -103,7 +103,7 @@ end -- ignored by default by this function), creating a key binding with this -- function will return 2 key objects: one with CapsLock on, and another one -- with CapsLock off. --- @see key.key +-- -- @tparam table mod A list of modifier keys. Valid modifiers are: Any, Mod1, -- Mod2, Mod3, Mod4, Mod5, Shift, Lock and Control. -- @tparam string _key The key to trigger an event. @@ -113,6 +113,7 @@ end -- for example {description="select next tag", group="tag"}. -- @treturn table A table with one or several key objects. -- @constructorfct awful.key + function key.new(mod, _key, press, release, data) if type(release)=='table' then data=release