naughty: do not export documentation of local functions
[awesome.git] / keybinding.c
blobbb03a5ffee297d1d8d55ceeaa8450aa21f6d05df
1 /*
2 * keybinding.c - Key bindings configuration management
4 * Copyright © 2008 Julien Danjou <julien@danjou.info>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include "key.h"
24 /** Define a global key binding. This key binding will always be available.
25 * (DEPRECATED, see key).
26 * \param L The Lua VM state.
27 * \luastack
28 * \lparam A table with modifier keys.
29 * \lparam A key name.
30 * \lparam A function to execute on key press.
31 * \lparam A function to execute on key release.
32 * \lreturn The key.
34 static int
35 luaA_keybinding_new(lua_State *L)
37 luaA_deprecate(L, "key");
38 return luaA_key_new(L);
41 const struct luaL_reg awesome_keybinding_methods[] =
43 { "__call", luaA_keybinding_new },
44 { NULL, NULL }