From: Fernando Tarlá Cardoso Lemos <fernandotcl@gmail.com>
Date: Tue, 21 Feb 2012 16:51:31 +0000 (-0200)
Subject: Document text_len in the draw_text description.
X-Git-Tag: 4.2~43
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=484c2a697b4f1531b2732ec745e3290e11989ba8;p=i3%2Fi3

Document text_len in the draw_text description.
---

diff --git a/include/libi3.h b/include/libi3.h
index 973c885d..7b7cf576 100644
--- 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 3a68cb78..4b308efb 100644
--- 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,