doc: clarify that keysym_to_utf8 returns size including '\0'

Signed-off-by: Ran Benita <ran234@gmail.com>

1 files changed, 3 insertions, 3 deletions

diff --git a/xkbcommon/xkbcommon.h b/xkbcommon/xkbcommon.h
index f8b3d8b..4e0abc4 100644
--- a/xkbcommon/xkbcommon.h
+++ b/xkbcommon/xkbcommon.h
@@ -372,15 +372,15 @@ xkb_keysym_from_name(const char *name, enum xkb_keysym_flags flags);
  * Get the Unicode/UTF-8 representation of a keysym.
  *
  * @param[in]  keysym The keysym.
  * @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);
 
 /**
  * Get the Unicode/UTF-32 representation of a keysym.