diff options
| author | Alejandro Piñeiro <apinheiro@igalia.com> | 2011-06-02 20:35:58 +0200 |
|---|---|---|
| committer | Alejandro Piñeiro <apinheiro@igalia.com> | 2011-06-02 20:35:58 +0200 |
| commit | f38ed368327449e91531b3716fbd0510a4ca49a1 (patch) | |
| tree | f7e8b927080223c45585a61158c6c703020b9ba7 | |
| parent | 85df8c434cbab8d51d76bb0bb648fc987272ef9d (diff) | |
| download | atk-f38ed368327449e91531b3716fbd0510a4ca49a1.tar.gz | |
Improve atktext documentation
Previous documentation for these methods:
atk_text_get_text
atk_text_get_text_after_offset
atk_text_get_text_at_offset
atk_text_get_text_before_offset
atk_text_get_selection
Were not clear if the returned string should be freed by the user or not.
Fixes: https://bugzilla.gnome.org/show_bug.cgi?id=588083
| -rwxr-xr-x | atk/atktext.c | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/atk/atktext.c b/atk/atktext.c index 3674aad..3fe5870 100755 --- a/atk/atktext.c +++ b/atk/atktext.c @@ -241,7 +241,8 @@ atk_text_base_init (AtkTextIface *class) * * Gets the specified text. * - * Returns: the text from @start_offset up to, but not including @end_offset. + * Returns: a newly allocated string containing the text from @start_offset up + * to, but not including @end_offset. Use g_free() to free the returned string. **/ gchar* atk_text_get_text (AtkText *text, @@ -335,7 +336,8 @@ atk_text_get_character_at_offset (AtkText *text, * If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string * is from the line end at or after the offset to the next line end. * - * Returns: the text after @offset bounded by the specified @boundary_type. + * Returns: a newly allocated string containing the text after @offset bounded + * by the specified @boundary_type. Use g_free() to free the returned string. **/ gchar* atk_text_get_text_after_offset (AtkText *text, @@ -424,7 +426,8 @@ atk_text_get_text_after_offset (AtkText *text, * is from the line end before the offset to the line end at or after * the offset. * - * Returns: the text at @offset bounded by the specified @boundary_type. + * Returns: a newly allocated string containing the text at @offset bounded by + * the specified @boundary_type. Use g_free() to free the returned string. **/ gchar* atk_text_get_text_at_offset (AtkText *text, @@ -508,7 +511,8 @@ atk_text_get_text_at_offset (AtkText *text, * is from the line end before the line end before the offset to the * line end before the offset. * - * Returns: the text before @offset bounded by the specified @boundary_type. + * Returns: a newly allocated string containing the text before @offset bounded + * by the specified @boundary_type. Use g_free() to free the returned string. **/ gchar* atk_text_get_text_before_offset (AtkText *text, @@ -805,7 +809,8 @@ atk_text_get_n_selections (AtkText *text) * * Gets the text from the specified selection. * - * Returns: the selected text. + * Returns: a newly allocated string containing the selected text. Use g_free() + * to free the returned string. **/ gchar* atk_text_get_selection (AtkText *text, |