GtkTickCallback: document use of G_SOURCE_CONTINUE/REMOVE for return value

[~andy/gtk] / gtk / gtkwidget.h

diff --git a/gtk/gtkwidget.h b/gtk/gtkwidget.h
index c082c13510d2051dbfcde5836164f681dc2c2650..064fb078785ed8d1b156d80b1728ffab322c3bb7 100644 (file)
--- a/gtk/gtkwidget.h
+++ b/gtk/gtkwidget.h
@@ -94,8 +94,8 @@ typedef void    (*GtkCallback)     (GtkWidget        *widget,
  *
  * Callback type for adding a function to update animations. See gtk_widget_add_tick_callback().
  *
- * Returns: %TRUE if the tick callback should continue to be called,
- *  %FALSE if the tick callback should be removed.
+ * Returns: %G_SOURCE_CONTINUE if the tick callback should continue to be called,
+ *  %G_SOURCE_REMOVE if the tick callback should be removed.
  */
 typedef gboolean (*GtkTickCallback) (GtkWidget     *widget,
                                      GdkFrameClock *frame_clock,