ListBox: Avoid ::row-activated/Row::activate ambig

…uity, by adding a doc comment to Row::activate explaining what it does
and why it is probably not what the user reading that is looking for.

https://bugzilla.gnome.org/show_bug.cgi?id=794008

diff --git a/gtk/gtklistbox.c b/gtk/gtklistbox.c
index 186fda861f4f5948de2d9e9e9723ff6288bc395d..6fc931498a253b66862483e113e96cea743aab27 100644 (file)
--- a/gtk/gtklistbox.c
+++ b/gtk/gtklistbox.c
@@ -3872,6 +3872,16 @@ gtk_list_box_row_class_init (GtkListBoxRowClass *klass)
 
   klass->activate = gtk_list_box_row_activate;
 
+  /**
+   * GtkListBoxRow::activate:
+   *
+   * This is a keybinding signal, which will cause this row to be activated.
+   *
+   * If you want to be notified when the user activates a row (by key or not),
+   * use the #GtkListBox::row-activated signal on the row’s parent #GtkListBox.
+   *
+   * Since: 3.10
+   */
   row_signals[ROW__ACTIVATE] =
     g_signal_new (I_("activate"),
                   G_OBJECT_CLASS_TYPE (object_class),