Doc fix: keycode is not necessarily the same as the X keycode.

This commit is contained in:
Daiki Ueno
2011-02-01 11:07:39 +09:00
parent 7055f5fa50
commit f66d20972d

View File

@ -393,9 +393,11 @@ eek_key_init (EekKey *self)
* @key: an #EekKey * @key: an #EekKey
* @keycode: keycode * @keycode: keycode
* *
* Set the keycode of @key to @keycode. The keycode values are * Set the keycode of @key to @keycode. Since typically the keycode
* identical to the X keycode name, if the keyboard is built with * value is used to find a key in a keyboard by calling
* #EekXkbLayout or #EekXklLayout. * 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 void
eek_key_set_keycode (EekKey *key, eek_key_set_keycode (EekKey *key,