Move documentation to inline comments: GtkFrame

[~andy/gtk] / gtk / gtkframe.c

diff --git a/gtk/gtkframe.c b/gtk/gtkframe.c
index 62e0dc160e83133b32d958dcded15853771e556b..5f201cce18b1c0f5c05b894e41506cd5fbe08ab5 100644 (file)
--- a/gtk/gtkframe.c
+++ b/gtk/gtkframe.c
@@ -34,6 +34,43 @@
 #include "gtkbuildable.h"
 
 
+/**
+ * SECTION:gtkframe
+ * @Short_description: A bin with a decorative frame and optional label
+ * @Title: GtkFrame
+ *
+ * The frame widget is a Bin that surrounds its child
+ * with a decorative frame and an optional label.
+ * If present, the label is drawn in a gap in the
+ * top side of the frame. The position of the
+ * label can be controlled with gtk_frame_set_label_align().
+ *
+ * <refsect2 id="GtkFrame-BUILDER-UI">
+ * <title>GtkFrame as GtkBuildable</title>
+ * <para>
+ * The GtkFrame implementation of the GtkBuildable interface
+ * supports placing a child in the label position by specifying
+ * "label" as the "type" attribute of a &lt;child&gt; element.
+ * A normal content child can be specified without specifying
+ * a &lt;child&gt; type attribute.
+ * </para>
+ * <example>
+ * <title>A UI definition fragment with GtkFrame</title>
+ * <programlisting><![CDATA[
+ * <object class="GtkFrame">
+ *   <child type="label">
+ *     <object class="GtkLabel" id="frame-label"/>
+ *   </child>
+ *   <child>
+ *     <object class="GtkEntry" id="frame-content"/>
+ *   </child>
+ * </object>
+ * ]]></programlisting>
+ * </example>
+ * </refsect2>
+ */
+
+
 #define LABEL_PAD 1
 #define LABEL_SIDE_PAD 2