[atk] doc: Update atk_text_get_text_{at/before/after}_offset documentation



commit 35df1a5ba7265607a07391ad2636da1287da2689
Author: Alejandro Piñeiro <apinheiro igalia com>
Date:   Mon Jun 17 16:35:09 2013 +0200

    doc: Update atk_text_get_text_{at/before/after}_offset documentation
    
    https://bugzilla.gnome.org/show_bug.cgi?id=697968

 atk/atktext.c |  103 ++-------------------------------------------------------
 1 files changed, 3 insertions(+), 100 deletions(-)
---
diff --git a/atk/atktext.c b/atk/atktext.c
index 33f4c07..34655b5 100755
--- a/atk/atktext.c
+++ b/atk/atktext.c
@@ -301,42 +301,6 @@ atk_text_get_character_at_offset (AtkText      *text,
  *
  * Gets the specified text.
  *
- * If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character after the 
- * offset is returned.
- *
- * If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
- * is from the word start after the offset to the next word start.
- *
- * The returned string will contain the word after the offset if the offset 
- * is inside a word or if the offset is not inside a word.
- *
- * If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string
- * is from the word end at or after the offset to the next work end.
- *
- * The returned string will contain the word after the offset if the offset
- * is inside a word and will contain the word after the word after the offset
- * if the offset is not inside a word.
- *
- * If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
- * string is from the sentence start after the offset to the next sentence
- * start.
- *
- * The returned string will contain the sentence after the offset if the offset
- * is inside a sentence or if the offset is not inside a sentence.
- *
- * If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string
- * is from the sentence end at or after the offset to the next sentence end.
- *
- * The returned string will contain the sentence after the offset if the offset
- * is inside a sentence and will contain the sentence after the sentence
- * after the offset if the offset is not inside a sentence.
- *
- * If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
- * string is from the line start after the offset to the next line start.
- *
- * 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.
- *
  * Deprecated: This method is deprecated since ATK version
  * 2.9.3. Please use atk_text_get_at_offset() instead.
  *
@@ -391,19 +355,11 @@ atk_text_get_text_after_offset (AtkText          *text,
  * offset is returned.
  *
  * If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
- * is from the word start at or before the offset to the word start after 
+ * is from the word start at or before the offset to the word start after
  * the offset.
  *
  * The returned string will contain the word at the offset if the offset
- * is inside a word and will contain the word before the offset if the 
- * offset is not inside a word.
- *
- * If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string
- * is from the word end before the offset to the word end at or after the
- * offset.
- *
- * The returned string will contain the word at the offset if the offset
- * is inside a word and will contain the word after to the offset if the 
+ * is inside a word and will contain the word before the offset if the
  * offset is not inside a word.
  *
  * If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
@@ -411,25 +367,13 @@ atk_text_get_text_after_offset (AtkText          *text,
  * start after the offset.
  *
  * The returned string will contain the sentence at the offset if the offset
- * is inside a sentence and will contain the sentence before the offset 
- * if the offset is not inside a sentence.
- *
- * If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string
- * is from the sentence end before the offset to the sentence end at or
- * after the offset.
- *
- * The returned string will contain the sentence at the offset if the offset
- * is inside a sentence and will contain the sentence after the offset 
+ * is inside a sentence and will contain the sentence before the offset
  * if the offset is not inside a sentence.
  *
  * If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
  * string is from the line start at or before the offset to the line
  * start after the offset.
  *
- * If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string
- * is from the line end before the offset to the line end at or after
- * the offset.
- *
  * Returns: a newly allocated string containing the text at @offset bounded by
  *   the specified @boundary_type. Use g_free() to free the returned string.
  **/
@@ -474,47 +418,6 @@ atk_text_get_text_at_offset (AtkText          *text,
  *
  * Gets the specified text.
  *
- * If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character before the
- * offset is returned.
- *
- * If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
- * is from the word start before the word start before or at the offset to 
- * the word start before or at the offset.
- *
- * The returned string will contain the word before the offset if the offset
- * is inside a word and will contain the word before the word before the 
- * offset if the offset is not inside a word.
- *
- * If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string
- * is from the word end before the word end before the offset to the word
- * end before the offset.
- *
- * The returned string will contain the word before the offset if the offset
- * is inside a word or if the offset is not inside a word.
- *
- * If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
- * string is from the sentence start before the sentence start before 
- * the offset to the sentence start before the offset.
- *
- * The returned string will contain the sentence before the offset if the 
- * offset is inside a sentence and will contain the sentence before the 
- * sentence before the offset if the offset is not inside a sentence.
- *
- * If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string
- * is from the sentence end before the sentence end at or before the offset to 
- * the sentence end at or before the offset.
- *
- * The returned string will contain the sentence before the offset if the 
- * offset is inside a sentence or if the offset is not inside a sentence.
- *
- * If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
- * string is from the line start before the line start ar or before the offset 
- * to the line start ar or before the offset.
- *
- * If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string
- * is from the line end before the line end before the offset to the 
- * line end before the offset.
- *
  * Deprecated: This method is deprecated since ATK version
  * 2.9.3. Please use atk_text_get_at_offset() instead.
  *


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]