diff options
| author | Matthew Barnes <mbarnes@redhat.com> | 2010-02-10 07:02:51 +0800 |
|---|---|---|
| committer | Matthew Barnes <mbarnes@redhat.com> | 2010-02-10 07:02:51 +0800 |
| commit | 1040078ce60b4641e5a3cdad6a2cef14660e63a3 (patch) | |
| tree | 0c59410ca87afb492bfa60cf43668b7af6f72533 /e-util/e-unicode.c | |
| parent | 64984ad5b86bb5c97868107d462825cbfa301e30 (diff) | |
| download | gsoc2013-evolution-1040078ce60b4641e5a3cdad6a2cef14660e63a3.tar gsoc2013-evolution-1040078ce60b4641e5a3cdad6a2cef14660e63a3.tar.gz gsoc2013-evolution-1040078ce60b4641e5a3cdad6a2cef14660e63a3.tar.bz2 gsoc2013-evolution-1040078ce60b4641e5a3cdad6a2cef14660e63a3.tar.lz gsoc2013-evolution-1040078ce60b4641e5a3cdad6a2cef14660e63a3.tar.xz gsoc2013-evolution-1040078ce60b4641e5a3cdad6a2cef14660e63a3.tar.zst gsoc2013-evolution-1040078ce60b4641e5a3cdad6a2cef14660e63a3.zip | |
Update API documentation.
Also, start fixing some Gtk-Doc warnings. There's a lot.
Diffstat (limited to 'e-util/e-unicode.c')
| -rw-r--r-- | e-util/e-unicode.c | 10 |
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) |