From 8a2c942f3d2a0b5dd30c9a6e1a3e62af65ac059e Mon Sep 17 00:00:00 2001
From: =?utf8?q?Javier=20Jard=C3=B3n?= <jjardon@gnome.org>
Date: Wed, 13 Apr 2011 00:55:22 +0100
Subject: [PATCH] Move documentation to inline comments: GtkHButtonBox

---
 docs/reference/gtk/tmpl/.gitignore    |  1 +
 docs/reference/gtk/tmpl/gtkhbbox.sgml | 68 ---------------------------
 gtk/gtkhbbox.c                        | 34 ++++++++++++++
 3 files changed, 35 insertions(+), 68 deletions(-)
 delete mode 100644 docs/reference/gtk/tmpl/gtkhbbox.sgml

diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 6ac20b648..8ff6499eb 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -38,6 +38,7 @@ gtkfilechooserwidget.sgml
 gtkfilefilter.sgml
 gtkfontbutton.sgml
 gtkframe.sgml
+gtkhbbox.sgml
 gtkhbox.sgml
 gtkhpaned.sgml
 gtkhscale.sgml
diff --git a/docs/reference/gtk/tmpl/gtkhbbox.sgml b/docs/reference/gtk/tmpl/gtkhbbox.sgml
deleted file mode 100644
index 1fd2dcc9f..000000000
--- a/docs/reference/gtk/tmpl/gtkhbbox.sgml
+++ /dev/null
@@ -1,68 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkHButtonBox
-
-<!-- ##### SECTION Short_Description ##### -->
-A container for arranging buttons horizontally
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-A button box should be used to provide a consistent layout of buttons
-throughout your application. The layout/spacing can be altered by the
-programmer, or if desired, by the user to alter the 'feel' of a
-program to a small degree.
-</para>
-<para>
-A #GtkHButtonBox is created with gtk_hbutton_box_new(). Buttons are
-packed into a button box the same way widgets are added to any other
-container, using gtk_container_add(). You can also use
-gtk_box_pack_start() or gtk_box_pack_end(), but for button boxes both
-these functions work just like gtk_container_add(), ie., they pack the
-button in a way that depends on the current layout style and on
-whether the button has had gtk_button_box_set_child_secondary() called
-on it.
-</para>
-
-<para>
-The spacing between buttons can be set with gtk_box_set_spacing(). The
-arrangement and layout of the buttons can be changed with
-gtk_button_box_set_layout().
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-<variablelist>
-<varlistentry>
-<term>#GtkBox</term>
-<listitem><para>Used to pack widgets into button boxes.</para></listitem>
-</varlistentry><varlistentry>
-<term>#GtkButtonBox</term>
-<listitem><para>Provides functions for controlling button boxes.</para></listitem>
-</varlistentry>
-<varlistentry>
-<term>#GtkVButtonBox</term>
-<listitem><para>Pack buttons vertically</para></listitem>
-</varlistentry>
-</variablelist>
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GtkHButtonBox ##### -->
-<para>
-GtkHButtonBox does not contain any public fields.
-</para>
-
-
-<!-- ##### FUNCTION gtk_hbutton_box_new ##### -->
-<para>
-Creates a new horizontal button box.
-</para>
-
-@void: 
-@Returns: a new button box #GtkWidget.
-
-
diff --git a/gtk/gtkhbbox.c b/gtk/gtkhbbox.c
index a8b4ed676..c2164da64 100644
--- a/gtk/gtkhbbox.c
+++ b/gtk/gtkhbbox.c
@@ -29,6 +29,33 @@
 #include "gtkorientable.h"
 #include "gtkintl.h"
 
+
+/**
+ * SECTION:gtkhbbox
+ * @Short_description: A container for arranging buttons horizontally
+ * @Title: GtkHButtonBox
+ * @See_also: #GtkBox, #GtkButtonBox, #GtkVButtonBox
+ *
+ * A button box should be used to provide a consistent layout of buttons
+ * throughout your application. The layout/spacing can be altered by the
+ * programmer, or if desired, by the user to alter the 'feel' of a
+ * program to a small degree.
+ *
+ * A #GtkHButtonBox is created with gtk_hbutton_box_new(). Buttons are
+ * packed into a button box the same way widgets are added to any other
+ * container, using gtk_container_add(). You can also use
+ * gtk_box_pack_start() or gtk_box_pack_end(), but for button boxes both
+ * these functions work just like gtk_container_add(), ie., they pack the
+ * button in a way that depends on the current layout style and on
+ * whether the button has had gtk_button_box_set_child_secondary() called
+ * on it.
+ *
+ * The spacing between buttons can be set with gtk_box_set_spacing(). The
+ * arrangement and layout of the buttons can be changed with
+ * gtk_button_box_set_layout().
+ */
+
+
 G_DEFINE_TYPE (GtkHButtonBox, gtk_hbutton_box, GTK_TYPE_BUTTON_BOX)
 
 static void
@@ -43,6 +70,13 @@ gtk_hbutton_box_init (GtkHButtonBox *hbutton_box)
                                   GTK_ORIENTATION_HORIZONTAL);
 }
 
+/**
+ * gtk_hbutton_box_new:
+ *
+ * Creates a new horizontal button box.
+ *
+ * Returns: a new button box #GtkWidget.
+ */
 GtkWidget *
 gtk_hbutton_box_new (void)
 {
-- 
2.43.2