doc: Remove capi.button/capi.key from the official doc.

`awful.button` is always the one used and it's confusing.
This commit is contained in:
Emmanuel Lepage Vallee 2018-12-25 00:49:22 -05:00
parent fa6c050be3
commit 96c4d001f1
3 changed files with 7 additions and 4 deletions

View File

@ -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',

View File

@ -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 = {}

View File

@ -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