[gtk+] Move documentation to inline comments: GtkHButtonBox



commit 8a2c942f3d2a0b5dd30c9a6e1a3e62af65ac059e
Author: Javier Jardón <jjardon gnome org>
Date:   Wed Apr 13 00:55:22 2011 +0100

    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(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 6ac20b6..8ff6499 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/gtk/gtkhbbox.c b/gtk/gtkhbbox.c
index a8b4ed6..c2164da 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)
 {



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