Adding note to docs of gtk_widget_set_window()

gtk_widget_set_window() does not add a reference to the
owned window... this is an exception to most gtk_foo_set_bar()
functions where as it acts as if it were named gtk_widget_take_window().

Adding note to the docs to avoid people giving the window to the
widget and naturally proceeding to unref the window.

diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c
index 2a1c98002436cadab6fd8c64cad95e42d56bc444..d749118059742f08d1d83bf9c559d18a613c5ec5 100644 (file)
--- a/gtk/gtkwidget.c
+++ b/gtk/gtkwidget.c
@@ -11616,6 +11616,8 @@ gtk_widget_get_requisition (GtkWidget      *widget,
  * by calling gtk_widget_set_has_window(). This is usually done in the
  * widget's init() function.
  *
+ * <note><para>This function does not add any reference to @window.</para></note>
+ *
  * Since: 2.18
  */
 void