From eea0eaebfaf088d151af284c15359fd91639ed08 Mon Sep 17 00:00:00 2001 From: Ran Benita Date: Tue, 6 Nov 2012 23:00:55 +0200 Subject: doc: clarify that keysym_to_utf8 returns size including '\0' Signed-off-by: Ran Benita --- xkbcommon/xkbcommon.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'xkbcommon') diff --git a/xkbcommon/xkbcommon.h b/xkbcommon/xkbcommon.h index f8b3d8b..4e0abc4 100644 --- a/xkbcommon/xkbcommon.h +++ b/xkbcommon/xkbcommon.h @@ -375,9 +375,9 @@ xkb_keysym_from_name(const char *name, enum xkb_keysym_flags flags); * @param[out] buffer A buffer to write the UTF-8 string into. * @param[in] size The size of buffer. Must be at least 7. * - * @returns The number of bytes written to the buffer. If the keysym does - * not have a Unicode representation, returns 0. If the buffer is too small, - * returns -1. + * @returns The number of bytes written to the buffer (including the + * terminating byte). If the keysym does not have a Unicode + * representation, returns 0. If the buffer is too small, returns -1. */ int xkb_keysym_to_utf8(xkb_keysym_t keysym, char *buffer, size_t size); -- cgit v1.2.3