summaryrefslogtreecommitdiff
path: root/include/xkbcommon/xkbcommon.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/xkbcommon/xkbcommon.h')
-rw-r--r--include/xkbcommon/xkbcommon.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/include/xkbcommon/xkbcommon.h b/include/xkbcommon/xkbcommon.h
index 31d0dcf..14d5045 100644
--- a/include/xkbcommon/xkbcommon.h
+++ b/include/xkbcommon/xkbcommon.h
@@ -140,12 +140,14 @@ extern "C" {
/*
* Returns the name for a keysym as a string; will return unknown Unicode
* codepoints as "Ua1b2", and other unknown keysyms as "0xabcd1234".
+ * If the buffer passed is too small, the string is truncated; a size of
+ * at least 32 bytes is recommended.
*/
void
xkb_keysym_get_name(xkb_keysym_t ks, char *buffer, size_t size);
/*
- * See xkb_keysym_to_string comments: this function will accept any string
+ * See xkb_keysym_get_name comments: this function will accept any string
* from that function.
*/
xkb_keysym_t