[gtk+] Add docs for GtkStackSwitcher



commit 8ca73e3258dec347554bcbce824793a852324731
Author: Matthias Clasen <mclasen redhat com>
Date:   Sun Apr 21 11:05:38 2013 -0400

    Add docs for GtkStackSwitcher

 docs/reference/gtk/gtk-docs.sgml     |  2 ++
 docs/reference/gtk/gtk3-sections.txt |  9 +++++++++
 gtk/gtkstackswitcher.c               | 36 ++++++++++++++++++++++++++++++++++--
 3 files changed, 45 insertions(+), 2 deletions(-)
---
diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml
index 671c3b6..07d96a1 100644
--- a/docs/reference/gtk/gtk-docs.sgml
+++ b/docs/reference/gtk/gtk-docs.sgml
@@ -234,6 +234,8 @@
       <xi:include href="xml/gtkpaned.xml" />
       <xi:include href="xml/gtklayout.xml" />
       <xi:include href="xml/gtknotebook.xml" />
+      <xi:include href="xml/gtkstack.xml" />
+      <xi:include href="xml/gtkstackswitcher.xml" />
       <xi:include href="xml/gtkexpander.xml" />
       <xi:include href="xml/gtkoverlay.xml" />
       <xi:include href="xml/gtkheaderbar.xml" />
diff --git a/docs/reference/gtk/gtk3-sections.txt b/docs/reference/gtk/gtk3-sections.txt
index 69ca8c8..2bf72f6 100644
--- a/docs/reference/gtk/gtk3-sections.txt
+++ b/docs/reference/gtk/gtk3-sections.txt
@@ -7584,3 +7584,12 @@ GtkStackTransitionType
 gtk_stack_set_transition_type
 gtk_stack_get_transition_type
 </SECTION>
+
+<SECTION>
+<FILE>gtkstackswitcher</FILE>
+<TITLE>GtkStackSwitcher</TITLE>
+GtkStackSwitcher
+gtk_stack_switcher_new
+gtk_stack_switcher_set_stack
+gtk_stack_switcher_get_stack
+</SECTION>
diff --git a/gtk/gtkstackswitcher.c b/gtk/gtkstackswitcher.c
index 3aef9ca..d8a1030 100644
--- a/gtk/gtkstackswitcher.c
+++ b/gtk/gtkstackswitcher.c
@@ -22,6 +22,25 @@
 #include "gtkprivate.h"
 #include "gtkintl.h"
 
+/**
+ * SECTION:gtkstackswitcher
+ * @Short_decription: A controller for GtkStack
+ * @Title: GtkStackSwitcher
+ * @See_also: #GtkStack
+ *
+ * The GtkStackSwitcher widget acts as a controller for a
+ * #GtkStack; it shows a row of buttons to switch between
+ * the various pages of the associated stack widget.
+ *
+ * All the content for the buttons comes from the child properties
+ * of the #GtkStack.
+ *
+ * It is possible to associate multiple #GtkStackSwitcher widgets
+ * with the same stack widget.
+ *
+ * The GtkStackSwitcher widget was added in 3.10.
+ */
+
 struct _GtkStackSwitcherPrivate
 {
   GtkStack *stack;
@@ -281,6 +300,8 @@ connect_stack_signals (GtkStackSwitcher *switcher)
  * @stack: (allow-none): a #GtkStack
  *
  * Sets the stack to control.
+ *
+ * Since: 3.10
  */
 void
 gtk_stack_switcher_set_stack (GtkStackSwitcher *switcher,
@@ -320,11 +341,13 @@ gtk_stack_switcher_set_stack (GtkStackSwitcher *switcher,
  * gtk_stack_switcher_get_stack:
  * @switcher: a #GtkStackSwitcher
  *
- * Retrieves the stack. See
- * gtk_stack_switcher_set_stack().
+ * Retrieves the stack.
+ * See gtk_stack_switcher_set_stack().
  *
  * Return value: (transfer none): the stack, or %NULL if
  *    none has been set explicitly.
+ *
+ * Since: 3.10
  */
 GtkStack *
 gtk_stack_switcher_get_stack (GtkStackSwitcher *switcher)
@@ -406,6 +429,15 @@ gtk_stack_switcher_class_init (GtkStackSwitcherClass *class)
   g_type_class_add_private (object_class, sizeof (GtkStackSwitcherPrivate));
 }
 
+/**
+ * gtk_stack_switcher_new:
+ *
+ * Create a new #GtkStackSwitcher.
+ *
+ * Return value: a new #GtkStackSwitcher.
+ *
+ * Since: 3.10
+ */
 GtkWidget *
 gtk_stack_switcher_new (void)
 {


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