Move documentation to inline comments: GtkButtonBox

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=612349

Signed-off-by: Javier Jardón <jjardon@gnome.org>

diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 14c568ae7289e141f4e78042e76948be9543b0a5..3250e6dcc9bd136ed2a4d14d5ad5ecb5ad6501b5 100644 (file)
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -1,3 +1,4 @@
+gtkbbox.sgml
 gtkbox.sgml
 gtkhbox.sgml
 gtkmessagedialog.sgml

diff --git a/docs/reference/gtk/tmpl/gtkbbox.sgml b/docs/reference/gtk/tmpl/gtkbbox.sgml
deleted file mode 100644 (file)
index 74c3c6d..0000000
--- a/docs/reference/gtk/tmpl/gtkbbox.sgml
+++ /dev/null
@@ -1,210 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkButtonBox
-
-<!-- ##### SECTION Short_Description ##### -->
-Base class for GtkHButtonBox and GtkVButtonBox
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-The primary purpose of this class is to keep track of the various properties
-of #GtkHButtonBox and #GtkVButtonBox widgets.
-</para>
-<para>
-gtk_button_box_get_child_size() retrieves the minimum width and height 
-for widgets in a given button box.
-</para>
-<para>
-The internal padding of buttons can be retrieved and changed per button box using
-gtk_button_box_get_child_ipadding() and gtk_button_box_set_child_ipadding()
-respectively.
-</para>
-<para>
-gtk_button_box_get_spacing() and gtk_button_box_set_spacing() retrieve and
-change default number of pixels between buttons, respectively.
-</para>
-<para>
-gtk_button_box_get_layout() and gtk_button_box_set_layout() retrieve and alter the method
-used to spread the buttons in a button box across the container, respectively.
-</para>
-
-<para>
-The main purpose of GtkButtonBox is to make sure the children have all the same size.
-Therefore it ignores the homogeneous property which it inherited from GtkBox, and always
-behaves as if homogeneous was %TRUE.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-<variablelist>
-<varlistentry>
-<term>#GtkVButtonBox</term>
-<listitem><para>Vertical sub-class of #GtkButtonBox.</para></listitem>
-</varlistentry>
-<varlistentry>
-<term>#GtkHButtonBox</term>
-<listitem><para>Horizontal sub-class of #GtkButtonBox.</para></listitem>
-</varlistentry>
-</variablelist>
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### STRUCT GtkButtonBox ##### -->
-<para>
-This is a read-only struct; no members should be modified directly.
-</para>
-
-
-<!-- ##### ARG GtkButtonBox:layout-style ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButtonBox:secondary ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButtonBox:child-internal-pad-x ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButtonBox:child-internal-pad-y ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButtonBox:child-min-height ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkButtonBox:child-min-width ##### -->
-<para>
-
-</para>
-
-<!-- ##### MACRO GTK_BUTTONBOX_DEFAULT ##### -->
-<para>
-Used internally only.
-</para>
-
-
-
-<!-- ##### MACRO gtk_button_box_get_spacing ##### -->
-<para>
-Retrieves how much space a button box is placing between each child button.
-</para>
-
-@b: a #GtkButtonBox
-@Returns: the current spacing applied to the buttons in @widget
-@Deprecated: Use gtk_box_get_spacing() instead.
-
-
-<!-- ##### FUNCTION gtk_button_box_get_layout ##### -->
-<para>
-Retrieves the method being used to arrange the buttons in a button box.
-</para>
-
-@widget: a #GtkButtonBox.
-@Returns: the method used to layout buttons in @widget.
-
-
-<!-- ##### FUNCTION gtk_button_box_get_child_size ##### -->
-<para>
-Retrieves the current width and height of all child widgets in a button box.
-@min_width and @min_height are filled with those values, respectively.
-</para>
-
-@widget: a #GtkButtonBox.
-@min_width: the width of the buttons contained by @widget.
-@min_height: the height of the buttons contained by @widget.
-@Deprecated: Use the style properties
-<literal>"child-min-width/-height"</literal> instead.
-
-
-<!-- ##### FUNCTION gtk_button_box_get_child_ipadding ##### -->
-<para>
-Gets the default number of pixels that pad the buttons in a given button box.
-</para>
-
-@widget: a #GtkButtonBox.
-@ipad_x: the horizontal padding used by buttons in @widget.
-@ipad_y: the vertical padding used by buttons in @widget.
-@Deprecated: Use the style properties 
-  "<link linkend="GtkButtonBox--s-child-internal-pad-x">child-internal-pad-x</link>"
-  and
-  "<link linkend="GtkButtonBox--s-child-internal-pad-y">child-internal-pad-y</link>"
-  instead.
-
-
-<!-- ##### FUNCTION gtk_button_box_get_child_secondary ##### -->
-<para>
-
-</para>
-
-@widget: 
-@child: 
-@Returns: 
-
-
-<!-- ##### MACRO gtk_button_box_set_spacing ##### -->
-<para>
-Sets the amount of spacing between buttons in a given button box.
-</para>
-
-@b: a #GtkButtonBox
-@s: the number of pixels of spacing
-@Deprecated: Use gtk_box_set_spacing() instead.
-
-
-<!-- ##### FUNCTION gtk_button_box_set_layout ##### -->
-<para>
-Changes the way buttons are arranged in their container.
-</para>
-
-@widget: a #GtkButtonBox.
-@layout_style: the new layout style.
-
-
-<!-- ##### FUNCTION gtk_button_box_set_child_size ##### -->
-<para>
-Sets a new default size for the children of a given button box.
-</para>
-
-@widget: a #GtkButtonBox
-@min_width: a default width for buttons in @widget
-@min_height: a default height for buttons in @widget
-@Deprecated: This is not supported anymore and can only be set through the theme
-  changing the style properties:
-  "<link linkend="GtkButtonBox--s-child-min-width">child-min-width</link>"
-  and
-  "<link linkend="GtkButtonBox--s-child-min-height">child-min-height</link>"
-  instead.
-
-
-<!-- ##### FUNCTION gtk_button_box_set_child_ipadding ##### -->
-<para>
-Changes the amount of internal padding used by all buttons in a given button
-box.
-</para>
-
-@widget: a #GtkButtonBox.
-@ipad_x: the horizontal padding that should be used by each button in @widget.
-@ipad_y: the vertical padding that should be used by each button in @widget.
-@Deprecated: Use the style properties
-<literal>"child-internal-pad-x/-y"</literal> instead.
-
-
-<!-- ##### FUNCTION gtk_button_box_set_child_secondary ##### -->
-<para>
-
-</para>
-
-@widget: 
-@child: 
-@is_secondary: 
-
-

diff --git a/gtk/gtkbbox.c b/gtk/gtkbbox.c
index 5760509f1b83fb2204abb65af6b34fac055e4928..6272e0e9421198f43c899263b03d6bc8cfec2497 100644 (file)
--- a/gtk/gtkbbox.c
+++ b/gtk/gtkbbox.c
@@ -24,6 +24,34 @@
  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  */
 
+/**
+ * SECTION:gtkbbox
+ * @Short_description: Base class for GtkHButtonBox and GtkVButtonBox
+ * @Title: GtkButtonBox
+ * @See_also: #GtkVButtonBox, #GtkHButtonBox
+ *
+ * The primary purpose of this class is to keep track of the various properties
+ * of #GtkHButtonBox and #GtkVButtonBox widgets.
+ *
+ * gtk_button_box_get_child_size() retrieves the minimum width and height
+ * for widgets in a given button box.
+ *
+ * The internal padding of buttons can be retrieved and changed per button box
+ * using gtk_button_box_get_child_ipadding() and
+ * gtk_button_box_set_child_ipadding() respectively.
+ *
+ * gtk_button_box_get_spacing() and gtk_button_box_set_spacing() retrieve and
+ * change default number of pixels between buttons, respectively.
+ *
+ * gtk_button_box_get_layout() and gtk_button_box_set_layout() retrieve and
+ * alter the method used to spread the buttons in a button box across the
+ * container, respectively.
+ *
+ * The main purpose of GtkButtonBox is to make sure the children have all the
+ * same size. Therefore it ignores the homogeneous property which it inherited
+ * from GtkBox, and always behaves as if homogeneous was %TRUE.
+ */
+
 #include "config.h"
 #include "gtkbbox.h"
 #include "gtkhbbox.h"
@@ -236,6 +264,21 @@ gtk_button_box_get_child_property (GtkContainer *container,
 
 /* set per widget values for spacing, child size and child internal padding */
 
+/**
+ * gtk_button_box_set_child_size:
+ * @widget: a #GtkButtonBox
+ * @min_width: a default width for buttons in @widget
+ * @min_height: a default height for buttons in @widget
+ *
+ * Sets a new default size for the children of a given button box.
+ *
+ * Deprecated: This is not supported anymore and can only be set through the
+ * theme changing the style properties:
+ *  "<link linkend="GtkButtonBox--s-child-min-width">child-min-width</link>"
+ *  and
+ *  "<link linkend="GtkButtonBox--s-child-min-height">child-min-height</link>"
+ *  instead.
+ */
 void 
 gtk_button_box_set_child_size (GtkButtonBox *widget, 
                                gint width, gint height)
@@ -246,6 +289,18 @@ gtk_button_box_set_child_size (GtkButtonBox *widget,
   widget->child_min_height = height;
 }
 
+/**
+ * gtk_button_box_set_child_ipadding:
+ * @widget: a #GtkButtonBox
+ * @ipad_x: the horizontal padding that should be used by each button in @widget
+ * @ipad_y: the vertical padding that should be used by each button in @widget
+ *
+ * Changes the amount of internal padding used by all buttons in a given button
+ * box.
+ *
+ * Deprecated: Use the style properties
+ *  <literal>"child-internal-pad-x/-y"</literal> instead.
+ */
 void 
 gtk_button_box_set_child_ipadding (GtkButtonBox *widget,
                                    gint ipad_x, gint ipad_y)
@@ -256,6 +311,13 @@ gtk_button_box_set_child_ipadding (GtkButtonBox *widget,
   widget->child_ipad_y = ipad_y;
 }
 
+/**
+ * gtk_button_box_set_layout:
+ * @widget: a #GtkButtonBox
+ * @layout_style: the new layout style
+ *
+ * Changes the way buttons are arranged in their container.
+ */
 void
 gtk_button_box_set_layout (GtkButtonBox      *widget, 
                            GtkButtonBoxStyle  layout_style)
@@ -275,6 +337,18 @@ gtk_button_box_set_layout (GtkButtonBox      *widget,
 
 /* get per widget values for spacing, child size and child internal padding */
 
+/**
+ * gtk_button_box_get_child_size:
+ * @widget: a #GtkButtonBox
+ * @min_width: the width of the buttons contained by @widget
+ * @min_height: the height of the buttons contained by @widget
+ *
+ * Retrieves the current width and height of all child widgets in a button box.
+ * @min_width and @min_height are filled with those values, respectively.
+ *
+ * Deprecated: Use the style properties
+ *  <literal>"child-min-width/-height"</literal> instead.
+ */
 void 
 gtk_button_box_get_child_size (GtkButtonBox *widget,
                                gint *width, gint *height)
@@ -287,6 +361,20 @@ gtk_button_box_get_child_size (GtkButtonBox *widget,
   *height = widget->child_min_height;
 }
 
+/**
+ * gtk_button_box_get_child_ipadding:
+ * @widget: a #GtkButtonBox
+ * @ipad_x: the horizontal padding used by buttons in @widget
+ * @ipad_y: the vertical padding used by buttons in @widget
+ *
+ * Gets the default number of pixels that pad the buttons in a given button box.
+ *
+ * Deprecated: Use the style properties
+ *  "<link linkend="GtkButtonBox--s-child-internal-pad-x">child-internal-pad-x</link>"
+ *  and
+ *  "<link linkend="GtkButtonBox--s-child-internal-pad-y">child-internal-pad-y</link>"
+ *  instead.
+ */
 void
 gtk_button_box_get_child_ipadding (GtkButtonBox *widget,
                                    gint* ipad_x, gint *ipad_y)
@@ -299,6 +387,14 @@ gtk_button_box_get_child_ipadding (GtkButtonBox *widget,
   *ipad_y = widget->child_ipad_y;
 }
 
+/**
+ * gtk_button_box_get_layout:
+ * @widget: a #GtkButtonBox
+ *
+ * Retrieves the method being used to arrange the buttons in a button box.
+ *
+ * Returns: the method used to layout buttons in @widget.
+ */
 GtkButtonBoxStyle 
 gtk_button_box_get_layout (GtkButtonBox *widget)
 {

diff --git a/gtk/gtkbbox.h b/gtk/gtkbbox.h
index f0666a210fc985b03323a476d00fc3d041393f8e..7a2d823e23222abbc7f1d93ecb8d128c100807b2 100644 (file)
--- a/gtk/gtkbbox.h
+++ b/gtk/gtkbbox.h
@@ -77,7 +77,26 @@ void              gtk_button_box_set_child_secondary (GtkButtonBox      *widget,
                                                      gboolean           is_secondary);
 
 #ifndef GTK_DISABLE_DEPRECATED
+/**
+ * gtk_button_box_set_spacing:
+ * @b: a #GtkButtonBox
+ * @s: the number of pixels of spacing
+ *
+ * Sets the amount of spacing between buttons in a given button box.
+ *
+ * Deprecated: Use gtk_box_set_spacing() instead.
+ */
 #define gtk_button_box_set_spacing(b,s) gtk_box_set_spacing (GTK_BOX (b), s)
+
+/**
+ * gtk_button_box_get_spacing:
+ * @b: a #GtkButtonBox
+ *
+ * Retrieves how much space a button box is placing between each child button.
+ *
+ * Deprecated: Use gtk_box_get_spacing() instead.
+ * Returns: the current spacing applied to the buttons in @widget
+ */
 #define gtk_button_box_get_spacing(b)   gtk_box_get_spacing (GTK_BOX (b))
 
 void gtk_button_box_set_child_size     (GtkButtonBox *widget,