aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-unicode.c
diff options
context:
space:
mode:
Diffstat (limited to 'e-util/e-unicode.c')
-rw-r--r--e-util/e-unicode.c10
1 files changed, 6 insertions, 4 deletions
diff --git a/e-util/e-unicode.c b/e-util/e-unicode.c
index 2e8969f718..aa1281fc3b 100644
--- a/e-util/e-unicode.c
+++ b/e-util/e-unicode.c
@@ -212,12 +212,14 @@ e_utf8_from_locale_string_sized (const gchar *string, gint bytes)
/**
* e_utf8_ensure_valid:
- * @string String to make valid UTF-8.
+ * @string: string to make valid UTF-8
*
- * Ensures the returned string will be valid UTF-8 string, thus gtk functions expecting
- * only valid UTF-8 texts will not crash.
+ * Ensures the returned string will be valid UTF-8 string, thus GTK+
+ * functions expecting only valid UTF-8 text will not crash.
*
- * Returned pointer should be freed with g_free.
+ * Returned pointer should be freed with g_free().
+ *
+ * Returns: a newly-allocated UTF-8 string
**/
gchar *
e_utf8_ensure_valid (const gchar *string)