From 3368407d9eb0fa10db910e2f7f054983fe56c31c Mon Sep 17 00:00:00 2001
From: John Mark Bell <jmb@netsurf-browser.org>
Date: Sun, 9 Jan 2011 00:02:47 +0000
Subject: Document font APIs -- specifically, string lengths are specified in
 bytes, not characters

svn path=/trunk/netsurf/; revision=11261
---
 desktop/plotters.h | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

(limited to 'desktop/plotters.h')

diff --git a/desktop/plotters.h b/desktop/plotters.h
index 4edec321b..076baf242 100644
--- a/desktop/plotters.h
+++ b/desktop/plotters.h
@@ -114,7 +114,16 @@ struct plotter_table {
 			struct bitmap *bitmap, colour bg,
 			bitmap_flags_t flags);
 
-	/* text */
+	/**
+	 * Text.
+	 *
+	 * \param  x       x coordinate
+	 * \param  y       y coordinate
+	 * \param  text    UTF-8 string to plot
+	 * \param  length  length of string, in bytes
+	 * \param  fstyle  plot style for this text
+	 * \return  true on success, false on error and error reported
+	 */
 	bool (*text)(int x, int y, const char *text, size_t length,
 			const plot_font_style_t *fstyle);
 
-- 
cgit v1.2.3