[gdl] Document GdlDockTablabel

[Sebastien Granjoux <sgranjoux src gnome org>]

commit 5013ddb4aa4bda0a5a0a82738a37cb94ff68d711
Author: SÃbastien Granjoux <seb sfo free fr>
Date:   Sun May 27 19:06:17 2012 +0200

    Document GdlDockTablabel

 docs/reference/Makefile.am       |    2 +-
 gdl/gdl-dock-bar.h               |    2 ++
 gdl/gdl-dock-item-button-image.c |    2 +-
 gdl/gdl-dock-item-grip.c         |    2 +-
 gdl/gdl-dock-tablabel.c          |   36 ++++++++++++++++++++++++++++++++++++
 gdl/gdl-preview-window.c         |    2 +-
 6 files changed, 42 insertions(+), 4 deletions(-)
---
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index a6fb678..d5864b5 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -28,7 +28,7 @@ SCANGOBJ_OPTIONS=
 
 # Extra options to supply to gtkdoc-scan.
 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS= --rebuild-types
+SCAN_OPTIONS= --rebuild-types --deprecated-guards="GDL_DISABLE_DEPRECATED"
 
 # Extra options to supply to gtkdoc-mkdb.
 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
diff --git a/gdl/gdl-dock-bar.h b/gdl/gdl-dock-bar.h
index d73d453..2d78789 100644
--- a/gdl/gdl-dock-bar.h
+++ b/gdl/gdl-dock-bar.h
@@ -80,9 +80,11 @@ void           gdl_dock_bar_set_style       (GdlDockBar *dockbar,
                                              GdlDockBarStyle style);
 GdlDockBarStyle gdl_dock_bar_get_style      (GdlDockBar *dockbar);
 
+#ifndef GDL_DISABLE_DEPRECATED
 GtkOrientation gdl_dock_bar_get_orientation (GdlDockBar *dockbar) G_GNUC_DEPRECATED_FOR(gtk_orientable_get_orientation);
 void           gdl_dock_bar_set_orientation (GdlDockBar *dockbar,
                                              GtkOrientation orientation) G_GNUC_DEPRECATED_FOR(gtk_orientable_set_orientation);
+#endif
 
 G_END_DECLS
 
diff --git a/gdl/gdl-dock-item-button-image.c b/gdl/gdl-dock-item-button-image.c
index 9553456..963fa55 100644
--- a/gdl/gdl-dock-item-button-image.c
+++ b/gdl/gdl-dock-item-button-image.c
@@ -28,7 +28,7 @@
  * SECTION:gdl-dock-item-button-image
  * @title: GdlDockItemButtonImage
  * @short_description: A widget displaying an image used in dock grip
- * @stability: Internal
+ * @stability: Private
  * @see_also: GtlDockItemGrip
  *
  * The #GdlDockItemButtonImage displays a small image which could be a cross
diff --git a/gdl/gdl-dock-item-grip.c b/gdl/gdl-dock-item-grip.c
index fa563ed..8ea8e36 100644
--- a/gdl/gdl-dock-item-grip.c
+++ b/gdl/gdl-dock-item-grip.c
@@ -45,7 +45,7 @@
  * @title: GdlDockItemGrip
  * @short_description: A grip for dock widgets.
  * @see_also: GtlDockItem, GdlDockItemButtonImage
- * @stability: Internal
+ * @stability: Private
  *
  * This widget contains an area where the user can click to drag the dock item
  * and two buttons. The first button allows to iconify the dock item.
diff --git a/gdl/gdl-dock-tablabel.c b/gdl/gdl-dock-tablabel.c
index b4f6a0d..b6fd0f9 100644
--- a/gdl/gdl-dock-tablabel.c
+++ b/gdl/gdl-dock-tablabel.c
@@ -32,6 +32,15 @@
 #include "gdl-dock-item.h"
 #include "libgdlmarshal.h"
 
+/**
+ * SECTION:gdl-dock-tablabel
+ * @title: GdlDockTablabel
+ * @short_description: A custom label widget.
+ * @stability: Unstable
+ *
+ * This is a deprecated label widget.
+ */
+
 
 /* ----- Private prototypes ----- */
 
@@ -130,6 +139,13 @@ gdl_dock_tablabel_class_init (GdlDockTablabelClass *klass)
                              GDL_TYPE_DOCK_ITEM,
                              G_PARAM_READWRITE));
 
+    /**
+     * GdlDockTablabel::button-pressed-handle:
+     * @label: The #GdlDockTablabel
+     * @event: A #GdkEvent
+     *
+     * This signal is emitted when the user clicks on the label.
+     */
     dock_tablabel_signals [BUTTON_PRESSED_HANDLE] =
         g_signal_new ("button_pressed_handle",
                       G_TYPE_FROM_CLASS (klass),
@@ -625,6 +641,14 @@ gdl_dock_tablabel_unmap (GtkWidget *widget)
 
 /* ----- Public interface ----- */
 
+/**
+ * gdl_dock_tablabel_new:
+ * @item: The dock item that associated with this label widget.
+ *
+ * Creates a new GDL tab label widget.
+ *
+ * Returns: a new #GdlDockTablabel.
+ */
 GtkWidget *
 gdl_dock_tablabel_new (GdlDockItem *item)
 {
@@ -637,6 +661,12 @@ gdl_dock_tablabel_new (GdlDockItem *item)
     return GTK_WIDGET (tablabel);
 }
 
+/**
+ * gdl_dock_tablabel_activate:
+ * @tablabel:  A #GdlDockTablabel widget
+ *
+ * Set the widget in "activated" state.
+ */
 void
 gdl_dock_tablabel_activate (GdlDockTablabel *tablabel)
 {
@@ -646,6 +676,12 @@ gdl_dock_tablabel_activate (GdlDockTablabel *tablabel)
     gtk_widget_set_state (GTK_WIDGET (tablabel), GTK_STATE_NORMAL);
 }
 
+/**
+ * gdl_dock_tablabel_deactivate:
+ * @tablabel:  A #GdlDockTablabel widget
+ *
+ * Set the widget in "deactivated" state.
+ */
 void
 gdl_dock_tablabel_deactivate (GdlDockTablabel *tablabel)
 {
diff --git a/gdl/gdl-preview-window.c b/gdl/gdl-preview-window.c
index 63f07f6..a8fe4ac 100644
--- a/gdl/gdl-preview-window.c
+++ b/gdl/gdl-preview-window.c
@@ -23,7 +23,7 @@
  * SECTION:gdl-preview-window
  * @title: GdlPreviewWindow
  * @short_description: show destination docking site.
- * @stability: Internal
+ * @stability: Private
  *
  *The #GdlPreviewWindow is used to indicate the position where the widget
  * will be dropped. Depending on the capability of the screen it can use