From f66d20972dc690b62ed02f0b14035f613e7dd525 Mon Sep 17 00:00:00 2001 From: Daiki Ueno Date: Tue, 1 Feb 2011 11:07:39 +0900 Subject: [PATCH] Doc fix: keycode is not necessarily the same as the X keycode. --- eek/eek-key.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/eek/eek-key.c b/eek/eek-key.c index d830217e..65f6954d 100644 --- a/eek/eek-key.c +++ b/eek/eek-key.c @@ -393,9 +393,11 @@ eek_key_init (EekKey *self) * @key: an #EekKey * @keycode: keycode * - * Set the keycode of @key to @keycode. The keycode values are - * identical to the X keycode name, if the keyboard is built with - * #EekXkbLayout or #EekXklLayout. + * Set the keycode of @key to @keycode. Since typically the keycode + * value is used to find a key in a keyboard by calling + * eek_keyboard_find_key_by_keycode, it is not necessarily the same as + * the X keycode but it should be unique in the keyboard @key belongs + * to. */ void eek_key_set_keycode (EekKey *key,