[gtk+] entry completion: Clarify index in documentation



commit 18dddddbabab9f7cd7afa9bd2cd3ddff6b94f972
Author: Christian Dywan <christian twotoasts de>
Date:   Fri Sep 4 12:32:00 2009 +0000

    entry completion: Clarify index in documentation
    
    https://bugzilla.gnome.org/show_bug.cgi?id=579466

 gtk/gtkentrycompletion.c |    6 ++++++
 1 files changed, 6 insertions(+), 0 deletions(-)
---
diff --git a/gtk/gtkentrycompletion.c b/gtk/gtkentrycompletion.c
index fb6e558..b60942a 100644
--- a/gtk/gtkentrycompletion.c
+++ b/gtk/gtkentrycompletion.c
@@ -1343,6 +1343,9 @@ gtk_entry_completion_insert_action (GtkEntryCompletion *completion,
  * with text @text. If you want the action item to have markup, use
  * gtk_entry_completion_insert_action_markup().
  *
+ * Note that @index_ is a relative position in the list of actions and
+ * the position of an action can change when deleting a different action.
+ *
  * Since: 2.4
  */
 void
@@ -1385,6 +1388,9 @@ gtk_entry_completion_insert_action_markup (GtkEntryCompletion *completion,
  *
  * Deletes the action at @index_ from @completion’s action list.
  *
+ * Note that @index_ is a relative position and the position of an
+ * action may have changed since it was inserted.
+ *
  * Since: 2.4
  */
 void


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