[gtk+] Move documentation to inline comments: GtkPlug



commit 7ab2155aef8e2069a9e5680ca2cd68f70eec43fd
Author: Patrick Bernaud <patrickb chez com>
Date:   Fri Mar 5 05:34:16 2010 +0100

    Move documentation to inline comments: GtkPlug
    
    https://bugzilla.gnome.org/show_bug.cgi?id=611707
    
    Signed-off-by: Javier Jardón <jjardon gnome org>

 docs/reference/gtk/tmpl/gtkplug.sgml |  126 ----------------------------------
 gtk/gtkplug.c                        |   21 ++++++
 2 files changed, 21 insertions(+), 126 deletions(-)
---
diff --git a/gtk/gtkplug.c b/gtk/gtkplug.c
index 95e6224..45352f2 100644
--- a/gtk/gtkplug.c
+++ b/gtk/gtkplug.c
@@ -36,6 +36,27 @@
 
 #include "gtkalias.h"
 
+/**
+ * SECTION:gtkplug
+ * @Short_description: Toplevel for embedding into other processes
+ * @Title: GtkPlug
+ * @See_also: #GtkSocket
+ *
+ * Together with #GtkSocket, #GtkPlug provides the ability
+ * to embed widgets from one process into another process
+ * in a fashion that is transparent to the user. One
+ * process creates a #GtkSocket widget and passes the
+ * ID of that widget's window to the other process,
+ * which then creates a #GtkPlug with that window ID.
+ * Any widgets contained in the #GtkPlug then will appear
+ * inside the first application's window.
+ *
+ * <note>
+ * The #GtkPlug and #GtkSocket widgets are currently not available
+ * on all platforms supported by GTK+.
+ * </note>
+ */
+
 static void            gtk_plug_get_property          (GObject     *object,
 						       guint        prop_id,
 						       GValue      *value,



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]