Document text_len in the draw_text description.

diff --git a/include/libi3.h b/include/libi3.h
index 973c885d7997697e0bd4ec86a6b2fff670831417..7b7cf576a7f31370c9298fecda2a67048c53e8c7 100644 (file)
--- a/include/libi3.h
+++ b/include/libi3.h
@@ -224,7 +224,12 @@ void set_font_colors(xcb_gcontext_t gc, uint32_t foreground, uint32_t background
 /**
  * Draws text onto the specified X drawable (normally a pixmap) at the
  * specified coordinates (from the top left corner of the leftmost, uppermost
- * glyph) and using the provided gc. Text can be specified as UCS-2 or UTF-8.
+ * glyph) and using the provided gc.
+ *
+ * Text can be specified as UCS-2 or UTF-8. If it's specified as UCS-2, then
+ * text_len must be the number of glyphs in the string. If it's specified as
+ * UTF-8, then text_len must be the number of bytes in the string (not counting
+ * the null terminator).
  *
  */
 void draw_text(char *text, size_t text_len, bool is_ucs2, xcb_drawable_t drawable,

diff --git a/libi3/font.c b/libi3/font.c
index 3a68cb785007da51964bb61c9a104b80bf72748a..4b308efb06eaafbcb6a386bd782afa00dc55b546 100644 (file)
--- a/libi3/font.c
+++ b/libi3/font.c
@@ -108,7 +108,12 @@ void set_font_colors(xcb_gcontext_t gc, uint32_t foreground, uint32_t background
 /*
  * Draws text onto the specified X drawable (normally a pixmap) at the
  * specified coordinates (from the top left corner of the leftmost, uppermost
- * glyph) and using the provided gc. Text can be specified as UCS-2 or UTF-8.
+ * glyph) and using the provided gc.
+ *
+ * Text can be specified as UCS-2 or UTF-8. If it's specified as UCS-2, then
+ * text_len must be the number of glyphs in the string. If it's specified as
+ * UTF-8, then text_len must be the number of bytes in the string (not counting
+ * the null terminator).
  *
  */
 void draw_text(char *text, size_t text_len, bool is_ucs2, xcb_drawable_t drawable,