Adding more documentation to length parameter at atspi_editable_text_insert_text
authorAline Bessa <alibezz@gmail.com>
Thu, 11 Aug 2011 04:22:12 +0000 (01:22 -0300)
committerMike Gorse <mgorse@novell.com>
Wed, 24 Aug 2011 02:26:00 +0000 (21:26 -0500)
atspi/atspi-editabletext.c

index 58ac715..6bbff91 100644 (file)
@@ -88,7 +88,8 @@ atspi_editable_text_set_text_contents (AtspiEditableText *obj,
  * @text: a string representing the text to insert, in UTF-8 encoding.
  * @length:  the number of characters of text to insert. If the character
  * count of text is less than or equal to length, the entire contents
- * of text will be inserted.
+ * of text will be inserted. Passing -1 indicates that the whole string
+ * should be inserted.
  *
  * Inserts text into an #AtspiEditableText object.
  * As with all character offsets, the specified @position may not be the