[gdl] Document GdlSwitcher



commit 9bb8be48d7c68a5566ed5ce5d50cd6b8f76f1949
Author: SÃbastien Granjoux <seb sfo free fr>
Date:   Sun May 27 23:03:37 2012 +0200

    Document GdlSwitcher

 gdl/gdl-dock-notebook.c |    2 +-
 gdl/gdl-switcher.c      |   23 +++++++++++++++++++++++
 2 files changed, 24 insertions(+), 1 deletions(-)
---
diff --git a/gdl/gdl-dock-notebook.c b/gdl/gdl-dock-notebook.c
index fe39ce2..a89917d 100644
--- a/gdl/gdl-dock-notebook.c
+++ b/gdl/gdl-dock-notebook.c
@@ -33,7 +33,7 @@
  * @title: GdlDockNotebook
  * @short_description: Arrange dock widgets in a tabbed notebook
  * @stability: Unstable
- * @see_also: #GdlDockPaned, #GdlDockMaster
+ * @see_also: #GdlDockPaned, #GdlDockMaster, #GdlSwitcher
  *
  * A #GdlDockNotebook is a compound dock widget like #GdlDockPaned.
  * Other dock widgets can be added to it, simply by dropping them on the
diff --git a/gdl/gdl-switcher.c b/gdl/gdl-switcher.c
index 6da854e..e7167ed 100644
--- a/gdl/gdl-switcher.c
+++ b/gdl/gdl-switcher.c
@@ -37,6 +37,20 @@
 
 #include <gtk/gtk.h>
 
+/**
+ * SECTION:gdl-switcher
+ * @title: GdlSwitcher
+ * @short_description: An improved notebook widget.
+ * @stability: Unstable
+ * @see_also: #GdlDockNotebook
+ *
+ * A #GdlSwitcher widget is an improved version of the #GtkNotebook. The
+ * tab labels could have different style and could be layouted on several lines.
+ *
+ * It is used by the #GdlDockNotebook widget to dock other widgets.
+ */
+
+
 static void gdl_switcher_set_property  (GObject            *object,
                                         guint               prop_id,
                                         const GValue       *value,
@@ -822,6 +836,13 @@ gdl_switcher_init (GdlSwitcher *switcher)
                       G_CALLBACK (gdl_switcher_notify_cb), switcher);
 }
 
+/**
+ * gdl_switcher_new:
+ *
+ * Creates a new notebook widget with no pages.
+ *
+ * Returns: The newly created #GdlSwitcher
+ */
 GtkWidget *
 gdl_switcher_new (void)
 {
@@ -967,6 +988,8 @@ gdl_switcher_select_button (GdlSwitcher *switcher, gint switcher_id)
  * %GTK_STOCK_NEW stock icon is used.  The text label for the button is specified
  * using the @label parameter.  If it is %NULL then a default incrementally
  * numbered label is used instead.
+ *
+ * Returns: The index (starting from 0) of the appended page in the notebook, or -1 if function fails
  */
 gint
 gdl_switcher_insert_page (GdlSwitcher *switcher, GtkWidget *page,



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