Improve CSW docs

2009-08-31 00:55:32 -04:00
parent 97d4b25d02
commit 5e5ab90a57
3 changed files with 71 additions and 26 deletions
--- a/gdk/gdkoffscreenwindow.c
+++ b/gdk/gdkoffscreenwindow.c
@ -1161,6 +1161,13 @@ gdk_offscreen_window_queue_translation (GdkWindow *window,
 * @window: a #GdkWindow
 * @embedder: the #GdkWindow that @window gets embedded in
 *
+ * Sets @window to be embedded in @embedder.
+ *
+ * To fully embed an offscreen window, in addition to calling this
+ * function, it is also necessary to handle the #GdkWindow::pick-embedded-child
+ * signal on the @embedder and the #GdkWindow::to-embedder and
+ * #GdkWindow::from-embedder signals on @window.
+ *
 * Since: 2.18
 */
 void