summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVincent Sanders <vince@kyllikki.org>2016-03-22 17:52:24 +0000
committerVincent Sanders <vince@kyllikki.org>2016-03-22 17:52:24 +0000
commit9faef114ec589182d941c1b563887c4950e22730 (patch)
tree0e5eb864dd4950419f605cc5284bb55dde9df72b
parentafc1d2c3c7631ea50cf94791e9cb20b8ea1f2051 (diff)
downloadnetsurf-9faef114ec589182d941c1b563887c4950e22730.tar.gz
netsurf-9faef114ec589182d941c1b563887c4950e22730.tar.bz2
Update font interface documentation to include parameter direction
-rw-r--r--desktop/browser.c2
-rw-r--r--desktop/font.h22
2 files changed, 12 insertions, 12 deletions
diff --git a/desktop/browser.c b/desktop/browser.c
index 938ef51e5..04e8efbf7 100644
--- a/desktop/browser.c
+++ b/desktop/browser.c
@@ -1301,7 +1301,7 @@ static void browser_window_convert_to_download(struct browser_window *bw,
/**
- * Callback handler for content event messages.
+ * Browser window content event callback handler.
*/
static nserror browser_window_callback(hlcache_handle *c,
const hlcache_event *event, void *pw)
diff --git a/desktop/font.h b/desktop/font.h
index 4ebd75d73..c883f8a28 100644
--- a/desktop/font.h
+++ b/desktop/font.h
@@ -42,11 +42,11 @@ struct font_functions
/**
* Measure the width of a string.
*
- * \param fstyle plot style for this text
- * \param string UTF-8 string to measure
- * \param length length of string, in bytes
- * \param width updated to width of string[0..length)
- * \return true on success, false on error and error reported
+ * \param[in] fstyle plot style for this text
+ * \param[in] string UTF-8 string to measure
+ * \param[in] length length of string, in bytes
+ * \param[out] width updated to width of string[0..length)
+ * \return true on success and width updated else false.
*/
bool (*font_width)(const plot_font_style_t *fstyle,
const char *string, size_t length,
@@ -54,12 +54,12 @@ struct font_functions
/**
* Find the position in a string where an x coordinate falls.
*
- * \param fstyle style for this text
- * \param string UTF-8 string to measure
- * \param length length of string, in bytes
- * \param x x coordinate to search for
- * \param char_offset updated to offset in string of actual_x, [0..length]
- * \param actual_x updated to x coordinate of character closest to x
+ * \param[in] fstyle style for this text
+ * \param[in] string UTF-8 string to measure
+ * \param[in] length length of string, in bytes
+ * \param[in] x coordinate to search for
+ * \param[out] char_offset updated to offset in string of actual_x, [0..length]
+ * \param[out] actual_x updated to x coordinate of character closest to x
* \return true on success, false on error and error reported
*/
bool (*font_position_in_string)(const plot_font_style_t *fstyle,