widget: Clarify add_tick_callback docs
authorTimm Bäder <mail@baedert.org>
Sat, 5 May 2018 05:38:56 +0000 (07:38 +0200)
committerTimm Bäder <mail@baedert.org>
Sat, 5 May 2018 05:39:55 +0000 (07:39 +0200)
You don't pass the callback to remove_tick_callback, but the id returned
from add_tick_callback.

gtk/gtkwidget.c

index 15c8384bbfc329975c8b9694f8f06a6977d4c78d..59b6409c9808f5aa79ff3e90d10d79ce1591a6d5 100644 (file)
@@ -3602,7 +3602,8 @@ static guint tick_callback_id;
  * have to worry about when a #GdkFrameClock is assigned to a widget.
  *
  * Returns: an id for the connection of this callback. Remove the callback
- *     by passing it to gtk_widget_remove_tick_callback()
+ *     by passing the id returned from this function to
+ *     gtk_widget_remove_tick_callback()
  */
 guint
 gtk_widget_add_tick_callback (GtkWidget       *widget,