GNOME.org
 

[gdl] Add GTK-Doc comments

commit b7932823fa74332e22d28bd00224a91d842ae929
Author: Alex Valavanis <a valavanis leeds ac uk>
Date:   Sun Jan 1 02:44:06 2012 +0000

    Add GTK-Doc comments

 docs/reference/gdl-sections.txt |  485 ++++++++++++++++++++-------------------
 gdl/gdl-dock-item-grip.c        |   14 ++
 gdl/gdl-dock-item.c             |   14 ++
 gdl/gdl-dock-object.c           |    7 +
 gdl/gdl-switcher.c              |   34 +++
 5 files changed, 315 insertions(+), 239 deletions(-)
---
diff --git a/docs/reference/gdl-sections.txt b/docs/reference/gdl-sections.txt
index cb8f418..6a4bf59 100644
--- a/docs/reference/gdl-sections.txt
+++ b/docs/reference/gdl-sections.txt
@@ -1,353 +1,360 @@
 <SECTION>
+<FILE>gdl</FILE>
+
+</SECTION>
+
+<SECTION>
 <FILE>gdl-dock</FILE>
 <TITLE>GdlDock</TITLE>
 GdlDock
 GdlDockClass
-GDL_DOCK_IS_CONTROLLER
-gdl_dock_new
-gdl_dock_new_from
-gdl_dock_add_item
 gdl_dock_add_floating_item
+gdl_dock_add_item
 gdl_dock_get_item_by_name
-gdl_dock_get_placeholder_by_name
 gdl_dock_get_named_items
+gdl_dock_get_placeholder_by_name
+gdl_dock_new
+gdl_dock_new_from
 gdl_dock_object_get_toplevel
 gdl_dock_xor_rect
 gdl_dock_xor_rect_hide
-GdlDockPrivate
 <SUBSECTION Standard>
 GDL_DOCK
+GDL_DOCK_CLASS
+GDL_DOCK_GET_CLASS
+GDL_DOCK_IS_CONTROLLER
 GDL_IS_DOCK
+GDL_IS_DOCK_CLASS
 GDL_TYPE_DOCK
+GdlDockPrivate
 gdl_dock_get_type
-GDL_DOCK_CLASS
-GDL_IS_DOCK_CLASS
-GDL_DOCK_GET_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>gdl-dock-master</FILE>
-<TITLE>GdlDockMaster</TITLE>
-GdlSwitcherStyle
-GdlDockMaster
-GdlDockMasterClass
-GDL_DOCK_OBJECT_GET_MASTER
-gdl_dock_master_add
-gdl_dock_master_remove
-gdl_dock_master_foreach
-gdl_dock_master_foreach_toplevel
-gdl_dock_master_get_object
-gdl_dock_master_get_controller
-gdl_dock_master_set_controller
-GdlDockMasterPrivate
+<FILE>gdl-dock-bar</FILE>
+<TITLE>GdlDockBar</TITLE>
+GdlDockBar
+GdlDockBarClass
+GdlDockBarStyle
+gdl_dock_bar_get_orientation
+gdl_dock_bar_get_style
+gdl_dock_bar_new
+gdl_dock_bar_set_orientation
+gdl_dock_bar_set_style
 <SUBSECTION Standard>
-GDL_DOCK_MASTER
-GDL_IS_DOCK_MASTER
-GDL_TYPE_DOCK_MASTER
-gdl_dock_master_get_type
-GDL_DOCK_MASTER_CLASS
-GDL_IS_DOCK_MASTER_CLASS
-GDL_DOCK_MASTER_GET_CLASS
+GDL_DOCK_BAR
+GDL_DOCK_BAR_CLASS
+GDL_DOCK_BAR_GET_CLASS
+GDL_IS_DOCK_BAR
+GDL_IS_DOCK_BAR_CLASS
+GDL_TYPE_DOCK_BAR
+GdlDockBarPrivate
+gdl_dock_bar_get_type
 </SECTION>
 
 <SECTION>
 <FILE>gdl-dock-item</FILE>
 <TITLE>GdlDockItem</TITLE>
-GdlDockItemBehavior
-GdlDockItemFlags
-GdlDockItem
-GdlDockItemClass
+GDL_DOCK_ITEM_CANT_CLOSE
+GDL_DOCK_ITEM_CANT_ICONIFY
 GDL_DOCK_ITEM_FLAGS
+GDL_DOCK_ITEM_HAS_GRIP
+GDL_DOCK_ITEM_ICONIFIED
 GDL_DOCK_ITEM_IN_DRAG
 GDL_DOCK_ITEM_IN_PREDRAG
-GDL_DOCK_ITEM_ICONIFIED
-GDL_DOCK_ITEM_USER_ACTION
 GDL_DOCK_ITEM_NOT_LOCKED
 GDL_DOCK_ITEM_NO_GRIP
 GDL_DOCK_ITEM_SET_FLAGS
 GDL_DOCK_ITEM_UNSET_FLAGS
-GDL_DOCK_ITEM_HAS_GRIP
-GDL_DOCK_ITEM_CANT_CLOSE
-GDL_DOCK_ITEM_CANT_ICONIFY
-gdl_dock_item_new
-gdl_dock_item_new_with_stock
+GDL_DOCK_ITEM_USER_ACTION
+GdlDockItem
+GdlDockItemBehavior
+GdlDockItemClass
+GdlDockItemClassPrivate
+GdlDockItemFlags
+gdl_dock_item_bind
 gdl_dock_item_dock_to
-gdl_dock_item_set_orientation
-gdl_dock_item_get_tablabel
-gdl_dock_item_set_tablabel
 gdl_dock_item_get_grip
+gdl_dock_item_get_tablabel
 gdl_dock_item_hide_grip
-gdl_dock_item_show_grip
-gdl_dock_item_notify_selected
-gdl_dock_item_notify_deselected
-gdl_dock_item_bind
-gdl_dock_item_unbind
 gdl_dock_item_hide_item
 gdl_dock_item_iconify_item
-gdl_dock_item_show_item
 gdl_dock_item_lock
-gdl_dock_item_unlock
-gdl_dock_item_set_default_position
+gdl_dock_item_new
+gdl_dock_item_new_with_pixbuf_icon
+gdl_dock_item_new_with_stock
+gdl_dock_item_notify_deselected
+gdl_dock_item_notify_selected
 gdl_dock_item_preferred_size
-GdlDockItemClassPrivate
-GdlDockItemPrivate
+gdl_dock_item_set_default_position
+gdl_dock_item_set_orientation
+gdl_dock_item_set_tablabel
+gdl_dock_item_show_grip
+gdl_dock_item_show_item
+gdl_dock_item_unbind
+gdl_dock_item_unlock
 <SUBSECTION Standard>
 GDL_DOCK_ITEM
+GDL_DOCK_ITEM_CLASS
+GDL_DOCK_ITEM_GET_CLASS
 GDL_IS_DOCK_ITEM
+GDL_IS_DOCK_ITEM_CLASS
 GDL_TYPE_DOCK_ITEM
+GdlDockItemPrivate
 gdl_dock_item_get_type
-GDL_DOCK_ITEM_CLASS
-GDL_IS_DOCK_ITEM_CLASS
-GDL_DOCK_ITEM_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>gdl-dock-tablabel</FILE>
-<TITLE>GdlDockTablabel</TITLE>
-GdlDockTablabel
-GdlDockTablabelClass
-gdl_dock_tablabel_new
-gdl_dock_tablabel_activate
-gdl_dock_tablabel_deactivate
-<SUBSECTION Standard>
-GDL_DOCK_TABLABEL
-GDL_IS_DOCK_TABLABEL
-GDL_TYPE_DOCK_TABLABEL
-gdl_dock_tablabel_get_type
-GDL_DOCK_TABLABEL_CLASS
-GDL_IS_DOCK_TABLABEL_CLASS
-GDL_DOCK_TABLABEL_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>gdl-dock-notebook</FILE>
-<TITLE>GdlDockNotebook</TITLE>
-GdlDockNotebook
-GdlDockNotebookClass
-gdl_dock_notebook_new
-GdlDockNotebookClassPrivate
-<SUBSECTION Standard>
-GDL_DOCK_NOTEBOOK
-GDL_IS_DOCK_NOTEBOOK
-GDL_TYPE_DOCK_NOTEBOOK
-gdl_dock_notebook_get_type
-GDL_DOCK_NOTEBOOK_CLASS
-GDL_IS_DOCK_NOTEBOOK_CLASS
-GDL_DOCK_NOTEBOOK_GET_CLASS
 </SECTION>
 
 <SECTION>
 <FILE>gdl-dock-item-button-image</FILE>
 <TITLE>GdlDockItemButtonImage</TITLE>
-GdlDockItemButtonImageType
 GdlDockItemButtonImage
 GdlDockItemButtonImageClass
+GdlDockItemButtonImageType
 gdl_dock_item_button_image_new
 <SUBSECTION Standard>
 GDL_DOCK_ITEM_BUTTON_IMAGE
+GDL_DOCK_ITEM_BUTTON_IMAGE_CLASS
+GDL_DOCK_ITEM_BUTTON_IMAGE_GET_CLASS
 GDL_IS_DOCK_ITEM_BUTTON_IMAGE
+GDL_IS_DOCK_ITEM_BUTTON_IMAGE_CLASS
 GDL_TYPE_DOCK_ITEM_BUTTON_IMAGE
 gdl_dock_item_button_image_get_type
-GDL_DOCK_ITEM_BUTTON_IMAGE_CLASS
-GDL_IS_DOCK_ITEM_BUTTON_IMAGE_CLASS
-GDL_DOCK_ITEM_BUTTON_IMAGE_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>gdl-switcher</FILE>
-<TITLE>GdlSwitcher</TITLE>
-GdlSwitcher
-GdlSwitcherClass
-gdl_switcher_new
-gdl_switcher_insert_page
-GdlSwitcherPrivate
-GdlSwitcherClassPrivate
-<SUBSECTION Standard>
-GDL_SWITCHER
-GDL_IS_SWITCHER
-GDL_TYPE_SWITCHER
-gdl_switcher_get_type
-GDL_SWITCHER_CLASS
-GDL_IS_SWITCHER_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>gdl-dock-placeholder</FILE>
-<TITLE>GdlDockPlaceholder</TITLE>
-GdlDockPlaceholder
-GdlDockPlaceholderClass
-gdl_dock_placeholder_new
-gdl_dock_placeholder_attach
-GdlDockPlaceholderPrivate
+<FILE>gdl-dock-item-grip</FILE>
+<TITLE>GdlDockItemGrip</TITLE>
+GdlDockItemGrip
+GdlDockItemGripClass
+gdl_dock_item_grip_hide_handle
+gdl_dock_item_grip_new
+gdl_dock_item_grip_set_label
+gdl_dock_item_grip_show_handle
 <SUBSECTION Standard>
-GDL_DOCK_PLACEHOLDER
-GDL_IS_DOCK_PLACEHOLDER
-GDL_TYPE_DOCK_PLACEHOLDER
-gdl_dock_placeholder_get_type
-GDL_DOCK_PLACEHOLDER_CLASS
-GDL_IS_DOCK_PLACEHOLDER_CLASS
-GDL_DOCK_PLACEHOLDER_GET_CLASS
+GDL_DOCK_ITEM_GRIP
+GDL_DOCK_ITEM_GRIP_CLASS
+GDL_DOCK_ITEM_GRIP_GET_CLASS
+GDL_IS_DOCK_ITEM_GRIP
+GDL_IS_DOCK_ITEM_GRIP_CLASS
+GDL_TYPE_DOCK_ITEM_GRIP
+GdlDockItemGripPrivate
+gdl_dock_item_grip_get_type
 </SECTION>
 
 <SECTION>
-<FILE>gdl-dock-paned</FILE>
-<TITLE>GdlDockPaned</TITLE>
-GdlDockPaned
-GdlDockPanedClass
-gdl_dock_paned_new
+<FILE>gdl-dock-layout</FILE>
+<TITLE>GdlDockLayout</TITLE>
+GdlDockLayout
+GdlDockLayoutClass
+gdl_dock_layout_attach
+gdl_dock_layout_delete_layout
+gdl_dock_layout_get_layouts
+gdl_dock_layout_get_layouts_ui
+gdl_dock_layout_is_dirty
+gdl_dock_layout_load_from_file
+gdl_dock_layout_load_layout
+gdl_dock_layout_new
+gdl_dock_layout_save_layout
+gdl_dock_layout_save_to_file
 <SUBSECTION Standard>
-GDL_DOCK_PANED
-GDL_IS_DOCK_PANED
-GDL_TYPE_DOCK_PANED
-gdl_dock_paned_get_type
-GDL_DOCK_PANED_CLASS
-GDL_IS_DOCK_PANED_CLASS
-GDL_DOCK_PANED_GET_CLASS
+GDL_DOCK_LAYOUT
+GDL_DOCK_LAYOUT_CLASS
+GDL_DOCK_LAYOUT_GET_CLASS
+GDL_IS_DOCK_LAYOUT
+GDL_IS_DOCK_LAYOUT_CLASS
+GDL_TYPE_DOCK_LAYOUT
+GdlDockLayoutPrivate
+gdl_dock_layout_get_type
 </SECTION>
 
 <SECTION>
-<FILE>gdl-dock-bar</FILE>
-<TITLE>GdlDockBar</TITLE>
-GdlDockBarStyle
-GdlDockBar
-GdlDockBarClass
-gdl_dock_bar_new
-gdl_dock_bar_get_orientation
-gdl_dock_bar_set_orientation
-gdl_dock_bar_set_style
-gdl_dock_bar_get_style
-GdlDockBarPrivate
+<FILE>gdl-dock-master</FILE>
+<TITLE>GdlDockMaster</TITLE>
+GDL_DOCK_OBJECT_GET_MASTER
+GdlDockMaster
+GdlDockMasterClass
+GdlSwitcherStyle
+gdl_dock_master_add
+gdl_dock_master_foreach
+gdl_dock_master_foreach_toplevel
+gdl_dock_master_get_controller
+gdl_dock_master_get_object
+gdl_dock_master_remove
+gdl_dock_master_set_controller
 <SUBSECTION Standard>
-GDL_DOCK_BAR
-GDL_IS_DOCK_BAR
-GDL_TYPE_DOCK_BAR
-gdl_dock_bar_get_type
-GDL_DOCK_BAR_CLASS
-GDL_IS_DOCK_BAR_CLASS
-GDL_DOCK_BAR_GET_CLASS
+GDL_DOCK_MASTER
+GDL_DOCK_MASTER_CLASS
+GDL_DOCK_MASTER_GET_CLASS
+GDL_IS_DOCK_MASTER
+GDL_IS_DOCK_MASTER_CLASS
+GDL_TYPE_DOCK_MASTER
+GdlDockMasterPrivate
+gdl_dock_master_get_type
 </SECTION>
 
 <SECTION>
-<FILE>gdl-dock-item-grip</FILE>
-<TITLE>GdlDockItemGrip</TITLE>
-GdlDockItemGrip
-GdlDockItemGripClass
-gdl_dock_item_grip_new
-gdl_dock_item_grip_set_label
-gdl_dock_item_grip_hide_handle
-gdl_dock_item_grip_show_handle
-GdlDockItemGripPrivate
+<FILE>gdl-dock-notebook</FILE>
+<TITLE>GdlDockNotebook</TITLE>
+GdlDockNotebook
+GdlDockNotebookClass
+GdlDockNotebookClassPrivate
+gdl_dock_notebook_new
 <SUBSECTION Standard>
-GDL_DOCK_ITEM_GRIP
-GDL_IS_DOCK_ITEM_GRIP
-GDL_TYPE_DOCK_ITEM_GRIP
-gdl_dock_item_grip_get_type
-GDL_DOCK_ITEM_GRIP_CLASS
-GDL_IS_DOCK_ITEM_GRIP_CLASS
-GDL_DOCK_ITEM_GRIP_GET_CLASS
+GDL_DOCK_NOTEBOOK
+GDL_DOCK_NOTEBOOK_CLASS
+GDL_DOCK_NOTEBOOK_GET_CLASS
+GDL_IS_DOCK_NOTEBOOK
+GDL_IS_DOCK_NOTEBOOK_CLASS
+GDL_TYPE_DOCK_NOTEBOOK
+gdl_dock_notebook_get_type
 </SECTION>
 
 <SECTION>
 <FILE>gdl-dock-object</FILE>
 <TITLE>GdlDockObject</TITLE>
-GdlDockParamFlags
-GDL_DOCK_NAME_PROPERTY
 GDL_DOCK_MASTER_PROPERTY
-GdlDockObjectFlags
-GDL_DOCK_OBJECT_FLAGS_SHIFT
-GdlDockPlacement
-GdlDockRequest
-GdlDockObject
-GdlDockObjectClass
-GDL_DOCK_OBJECT_FLAGS
-GDL_DOCK_OBJECT_AUTOMATIC
+GDL_DOCK_NAME_PROPERTY
 GDL_DOCK_OBJECT_ATTACHED
-GDL_DOCK_OBJECT_IN_REFLOW
+GDL_DOCK_OBJECT_AUTOMATIC
+GDL_DOCK_OBJECT_FLAGS
+GDL_DOCK_OBJECT_FLAGS_SHIFT
+GDL_DOCK_OBJECT_FROZEN
 GDL_DOCK_OBJECT_IN_DETACH
+GDL_DOCK_OBJECT_IN_REFLOW
 GDL_DOCK_OBJECT_SET_FLAGS
 GDL_DOCK_OBJECT_UNSET_FLAGS
-GDL_DOCK_OBJECT_FROZEN
-gdl_dock_object_is_compound
+GDL_TRACE_OBJECT
+GdlDockObject
+GdlDockObjectClass
+GdlDockObjectFlags
+GdlDockParamFlags
+GdlDockPlacement
+GdlDockRequest
+gdl_dock_object_bind
+gdl_dock_object_child_placement
 gdl_dock_object_detach
-gdl_dock_object_get_parent_object
-gdl_dock_object_freeze
-gdl_dock_object_thaw
-gdl_dock_object_reduce
-gdl_dock_object_dock_request
 gdl_dock_object_dock
-gdl_dock_object_bind
-gdl_dock_object_unbind
+gdl_dock_object_dock_request
+gdl_dock_object_freeze
+gdl_dock_object_get_parent_object
 gdl_dock_object_is_bound
-gdl_dock_object_reorder
-gdl_dock_object_present
-gdl_dock_object_child_placement
-GDL_TYPE_DOCK_PARAM
-gdl_dock_param_get_type
+gdl_dock_object_is_compound
 gdl_dock_object_nick_from_type
-gdl_dock_object_type_from_nick
+gdl_dock_object_present
+gdl_dock_object_reduce
+gdl_dock_object_reorder
 gdl_dock_object_set_type_for_nick
-GDL_TRACE_OBJECT
+gdl_dock_object_thaw
+gdl_dock_object_type_from_nick
+gdl_dock_object_unbind
 <SUBSECTION Standard>
 GDL_DOCK_OBJECT
+GDL_DOCK_OBJECT_CLASS
+GDL_DOCK_OBJECT_GET_CLASS
 GDL_IS_DOCK_OBJECT
+GDL_IS_DOCK_OBJECT_CLASS
 GDL_TYPE_DOCK_OBJECT
+GDL_TYPE_DOCK_PARAM
 gdl_dock_object_get_type
-GDL_DOCK_OBJECT_CLASS
-GDL_IS_DOCK_OBJECT_CLASS
-GDL_DOCK_OBJECT_GET_CLASS
+gdl_dock_param_get_type
 </SECTION>
 
 <SECTION>
-<FILE>gdl-dock-layout</FILE>
-<TITLE>GdlDockLayout</TITLE>
-GdlDockLayout
-GdlDockLayoutClass
-gdl_dock_layout_new
-gdl_dock_layout_attach
-gdl_dock_layout_load_layout
-gdl_dock_layout_save_layout
-gdl_dock_layout_delete_layout
-gdl_dock_layout_get_layouts
-gdl_dock_layout_load_from_file
-gdl_dock_layout_save_to_file
-gdl_dock_layout_is_dirty
-gdl_dock_layout_get_layouts_ui
-GdlDockLayoutPrivate
+<FILE>gdl-dock-paned</FILE>
+<TITLE>GdlDockPaned</TITLE>
+GdlDockPaned
+GdlDockPanedClass
+gdl_dock_paned_new
 <SUBSECTION Standard>
-GDL_DOCK_LAYOUT
-GDL_IS_DOCK_LAYOUT
-GDL_TYPE_DOCK_LAYOUT
-gdl_dock_layout_get_type
-GDL_DOCK_LAYOUT_CLASS
-GDL_IS_DOCK_LAYOUT_CLASS
-GDL_DOCK_LAYOUT_GET_CLASS
+GDL_DOCK_PANED
+GDL_DOCK_PANED_CLASS
+GDL_DOCK_PANED_GET_CLASS
+GDL_IS_DOCK_PANED
+GDL_IS_DOCK_PANED_CLASS
+GDL_TYPE_DOCK_PANED
+gdl_dock_paned_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gdl-dock-placeholder</FILE>
+<TITLE>GdlDockPlaceholder</TITLE>
+GdlDockPlaceholder
+GdlDockPlaceholderClass
+gdl_dock_placeholder_attach
+gdl_dock_placeholder_new
+<SUBSECTION Standard>
+GDL_DOCK_PLACEHOLDER
+GDL_DOCK_PLACEHOLDER_CLASS
+GDL_DOCK_PLACEHOLDER_GET_CLASS
+GDL_IS_DOCK_PLACEHOLDER
+GDL_IS_DOCK_PLACEHOLDER_CLASS
+GDL_TYPE_DOCK_PLACEHOLDER
+GdlDockPlaceholderPrivate
+gdl_dock_placeholder_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gdl-dock-tablabel</FILE>
+<TITLE>GdlDockTablabel</TITLE>
+GdlDockTablabel
+GdlDockTablabelClass
+gdl_dock_tablabel_activate
+gdl_dock_tablabel_deactivate
+gdl_dock_tablabel_new
+<SUBSECTION Standard>
+GDL_DOCK_TABLABEL
+GDL_DOCK_TABLABEL_CLASS
+GDL_DOCK_TABLABEL_GET_CLASS
+GDL_IS_DOCK_TABLABEL
+GDL_IS_DOCK_TABLABEL_CLASS
+GDL_TYPE_DOCK_TABLABEL
+gdl_dock_tablabel_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gdl-switcher</FILE>
+<TITLE>GdlSwitcher</TITLE>
+GdlSwitcher
+GdlSwitcherClass
+GdlSwitcherClassPrivate
+gdl_switcher_insert_page
+gdl_switcher_new
+<SUBSECTION Standard>
+GDL_IS_SWITCHER
+GDL_IS_SWITCHER_CLASS
+GDL_SWITCHER
+GDL_SWITCHER_CLASS
+GDL_TYPE_SWITCHER
+GdlSwitcherPrivate
+gdl_switcher_get_type
 </SECTION>
 
 <SECTION>
 <FILE>libgdlmarshal</FILE>
-gdl_marshal_VOID__VOID
-gdl_marshal_VOID__INT_INT
-gdl_marshal_VOID__UINT_UINT
 gdl_marshal_VOID__BOOLEAN
-gdl_marshal_VOID__OBJECT_ENUM_BOXED
 gdl_marshal_VOID__BOXED
+gdl_marshal_VOID__INT_INT
+gdl_marshal_VOID__OBJECT_ENUM_BOXED
+gdl_marshal_VOID__UINT_UINT
+gdl_marshal_VOID__VOID
 </SECTION>
 
 <SECTION>
 <FILE>libgdltypebuiltins</FILE>
-GDL_TYPE_DOCK_PARAM_FLAGS
-gdl_dock_param_flags_get_type
+<SUBSECTION Standard>
+GDL_TYPE_DOCK_BAR_STYLE
+GDL_TYPE_DOCK_ITEM_BEHAVIOR
+GDL_TYPE_DOCK_ITEM_FLAGS
 GDL_TYPE_DOCK_OBJECT_FLAGS
-gdl_dock_object_flags_get_type
+GDL_TYPE_DOCK_PARAM_FLAGS
 GDL_TYPE_DOCK_PLACEMENT
-gdl_dock_placement_get_type
 GDL_TYPE_SWITCHER_STYLE
-gdl_switcher_style_get_type
-GDL_TYPE_DOCK_ITEM_BEHAVIOR
+gdl_dock_bar_style_get_type
 gdl_dock_item_behavior_get_type
-GDL_TYPE_DOCK_ITEM_FLAGS
 gdl_dock_item_flags_get_type
-GDL_TYPE_DOCK_BAR_STYLE
-gdl_dock_bar_style_get_type
+gdl_dock_object_flags_get_type
+gdl_dock_param_flags_get_type
+gdl_dock_placement_get_type
+gdl_switcher_style_get_type
 </SECTION>
 
diff --git a/gdl/gdl-dock-item-grip.c b/gdl/gdl-dock-item-grip.c
index b127152..2896959 100644
--- a/gdl/gdl-dock-item-grip.c
+++ b/gdl/gdl-dock-item-grip.c
@@ -59,6 +59,20 @@ struct _GdlDockItemGripPrivate {
  
 G_DEFINE_TYPE (GdlDockItemGrip, gdl_dock_item_grip, GTK_TYPE_CONTAINER);
                        
+/**
+ * gdl_dock_item_create_label_widget:
+ * @grip: The GdlDockItemGrip for which to create a label widget
+ *
+ * Creates a label for a given grip, containing an icon and title
+ * text if applicable.  The icon is created using either the 
+ * #GdlDockObject:stock-id or #GdlDockObject:pixbuf-icon properties, 
+ * depending on how the grip was created.  If both properties are %NULL, 
+ * then the icon is omitted.  The title is taken from the 
+ * #GdlDockObject:long-name property.  Again, if the property is %NULL,
+ * then the title is omitted.
+ *
+ * Returns: The newly-created label box for the grip.
+ */
 GtkWidget*
 gdl_dock_item_create_label_widget(GdlDockItemGrip *grip)
 {
diff --git a/gdl/gdl-dock-item.c b/gdl/gdl-dock-item.c
index 47730e8..189f781 100644
--- a/gdl/gdl-dock-item.c
+++ b/gdl/gdl-dock-item.c
@@ -1747,6 +1747,20 @@ gdl_dock_item_new_with_stock (const gchar         *name,
     return GTK_WIDGET (item);
 }
 
+/**
+ * gdl_dock_item_new_with_pixbuf_icon:
+ * @name: Unique name for identifying the dock object.
+ * @long_name: Human readable name for the dock object.
+ * @pixbuf_icon: Pixbuf icon for the dock object.
+ * @behavior: General behavior for the dock item (i.e. whether it can
+ *            float, if it's locked, etc.), as specified by
+ *            #GdlDockItemBehavior flags.
+ * 
+ * Creates a new dock item grip widget with a given pixbuf icon.
+ * Returns: The newly created dock item grip widget.
+ *
+ * Since: 3.3.2
+ **/
 GtkWidget *
 gdl_dock_item_new_with_pixbuf_icon (const gchar         *name,
                                     const gchar         *long_name,
diff --git a/gdl/gdl-dock-object.c b/gdl/gdl-dock-object.c
index 984388e..53f53a4 100644
--- a/gdl/gdl-dock-object.c
+++ b/gdl/gdl-dock-object.c
@@ -133,6 +133,13 @@ gdl_dock_object_class_init (GdlDockObjectClass *klass)
                              NULL,
                              G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 
+    /**
+     * GdlDockObject:pixbuf-icon
+     *
+     * A GdkPixbuf to use for the icon of the dock object.
+     *
+     * Since: 3.3.2
+     */ 
     g_object_class_install_property (
         g_object_class, PROP_PIXBUF_ICON,
         g_param_spec_pointer ("pixbuf-icon", _("Pixbuf Icon"),
diff --git a/gdl/gdl-switcher.c b/gdl/gdl-switcher.c
index 2b085a6..fa8900e 100644
--- a/gdl/gdl-switcher.c
+++ b/gdl/gdl-switcher.c
@@ -828,6 +828,22 @@ gdl_switcher_new (void)
     return g_object_new (gdl_switcher_get_type (), NULL);
 }
 
+/** 
+ * gdl_switcher_add_button:
+ * @switcher: The #GdlSwitcher to which a button will be added
+ * @label: The label for the button
+ * @tooltips: The tooltip for the button
+ * @stock_id: The stock ID for the button
+ * @pixbuf_icon: The pixbuf to use for the button icon
+ * @switcher_id: The ID of the switcher
+ * @page: The notebook page
+ *
+ * Adds a button to a #GdlSwitcher.  The button icon is taken preferentially
+ * from the @stock_id parameter.  If this is %NULL, then the @pixbuf_icon
+ * parameter is used.  Failing that, the %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.
+ */
 void
 gdl_switcher_add_button (GdlSwitcher *switcher, const gchar *label,
                          const gchar *tooltips, const gchar *stock_id,
@@ -934,6 +950,24 @@ gdl_switcher_select_button (GdlSwitcher *switcher, gint switcher_id)
 }
    
 
+/**
+ * gdl_switcher_insert_page:
+ * @switcher: The switcher to which a page will be added
+ * @page: The page to add to the switcher
+ * @tab_widget: The  to add to the switcher
+ * @label: The label text for the button
+ * @tooltips: The tooltip for the button
+ * @stock_id: The stock ID for the button icon
+ * @pixbuf_icon: The pixbuf to use for the button icon
+ * @position: The position at which to create the page
+ *
+ * Adds a page to a #GdlSwitcher.  A button is created in the switcher, with its
+ * icon taken preferentially from the @stock_id parameter.  If this parameter is 
+ * %NULL, then the @pixbuf_icon parameter is used.  Failing that, the 
+ * %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.
+ */
 gint
 gdl_switcher_insert_page (GdlSwitcher *switcher, GtkWidget *page,
                           GtkWidget *tab_widget, const gchar *label,
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]