summaryrefslogtreecommitdiff
authorRan Benita <ran234@gmail.com>2012-11-06 21:00:55 (GMT)
committer Ran Benita <ran234@gmail.com>2012-11-06 21:01:44 (GMT)
commiteea0eaebfaf088d151af284c15359fd91639ed08 (patch) (side-by-side diff)
treec4ff2e850c5cb04c86e1ad32278c7b9bec433563
parentd9317d5f328a95b6188eecf09d5acfbbe46004b6 (diff)
downloadlibxkbcommon-eea0eaebfaf088d151af284c15359fd91639ed08.zip
libxkbcommon-eea0eaebfaf088d151af284c15359fd91639ed08.tar.gz
doc: clarify that keysym_to_utf8 returns size including '\0'
Signed-off-by: Ran Benita <ran234@gmail.com>
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--xkbcommon/xkbcommon.h6
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
@@ -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);