From 44365ab591f88b45cdcce52f62a9130254303cc9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Iv=C3=A1n=20Briano?= Date: Fri, 15 Oct 2010 13:24:51 +0000 Subject: [PATCH] Oh look, I had some docs to commit and forgot about them. SVN revision: 53450 --- legacy/evas/src/lib/canvas/evas_object_text.c | 32 ++++++++++++++++--- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/legacy/evas/src/lib/canvas/evas_object_text.c b/legacy/evas/src/lib/canvas/evas_object_text.c index dcd7412c02..1f9b4916ae 100644 --- a/legacy/evas/src/lib/canvas/evas_object_text.c +++ b/legacy/evas/src/lib/canvas/evas_object_text.c @@ -1316,9 +1316,21 @@ evas_font_available_list_free(Evas *e, Eina_List *available) } /** - * To be documented. + * Gets the next character in the string * - * FIXME: To be fixed. + * Given the UTF-8 string in @p str, and starting byte position in @p pos, + * this function will place in @p decoded the decoded code point at @p pos + * and return the byte index for the next character in the string. + * + * The only boundary check done is that @p pos must be >= 0. Other than that, + * no checks are performed, so passing an index value that's not within the + * length of the string will result in undefined behavior. + * + * @param str The UTF-8 string + * @param pos The byte index where to start + * @param decoded Address where to store the decoded code point. Optional. + * + * @return The byte index of the next character * * @ingroup Evas_Utils */ @@ -1336,9 +1348,21 @@ evas_string_char_next_get(const char *str, int pos, int *decoded) } /** - * To be documented. + * Gets the previous character in the string * - * FIXME: To be fixed. + * Given the UTF-8 string in @p str, and starting byte position in @p pos, + * this function will place in @p decoded the decoded code point at @p pos + * and return the byte index for the previous character in the string. + * + * The only boundary check done is that @p pos must be >= 1. Other than that, + * no checks are performed, so passing an index value that's not within the + * length of the string will result in undefined behavior. + * + * @param str The UTF-8 string + * @param pos The byte index where to start + * @param decoded Address where to store the decoded code point. Optional. + * + * @return The byte index of the previous character * * @ingroup Evas_Utils */