[gdl] Add instrospection annotations
- From: Sebastien Granjoux <sgranjoux src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gdl] Add instrospection annotations
- Date: Mon, 21 May 2012 21:02:32 +0000 (UTC)
commit f87e6e73b96f7c84640b0eb71cd704b0cdc8d49a
Author: SÃbastien Granjoux <seb sfo free fr>
Date: Mon May 21 23:02:09 2012 +0200
Add instrospection annotations
gdl/gdl-dock-item.c | 4 ++--
gdl/gdl-dock-master.c | 8 ++++----
gdl/gdl-dock-object.c | 16 ++++++++--------
gdl/gdl-dock.c | 16 ++++++++--------
gdl/gdl-dock.h | 2 +-
5 files changed, 23 insertions(+), 23 deletions(-)
---
diff --git a/gdl/gdl-dock-item.c b/gdl/gdl-dock-item.c
index 3a7edbd..fa8ec8e 100644
--- a/gdl/gdl-dock-item.c
+++ b/gdl/gdl-dock-item.c
@@ -2001,7 +2001,7 @@ gdl_dock_item_set_orientation (GdlDockItem *item,
* only visible when the "switcher-style" property of the #GdlDockMaster
* is set to #GDL_SWITCHER_STYLE_TABS
*
- * Returns: Returns the tab label widget.
+ * Returns: (transfer none): Returns the tab label widget.
**/
GtkWidget *
gdl_dock_item_get_tablabel (GdlDockItem *item)
@@ -2065,7 +2065,7 @@ gdl_dock_item_set_tablabel (GdlDockItem *item,
*
* This function returns the dock item's grip label widget.
*
- * Returns: Returns the current label widget.
+ * Returns: (allow-none) (transfer none): Returns the current label widget.
**/
GtkWidget *
gdl_dock_item_get_grip(GdlDockItem *item)
diff --git a/gdl/gdl-dock-master.c b/gdl/gdl-dock-master.c
index 8cbb83b..c2b5157 100644
--- a/gdl/gdl-dock-master.c
+++ b/gdl/gdl-dock-master.c
@@ -918,7 +918,7 @@ gdl_dock_master_remove (GdlDockMaster *master,
/**
* gdl_dock_master_foreach:
* @master: a #GdlDockMaster
- * @function: the function to call with each element's data
+ * @function: (scope call): the function to call with each element's data
* @user_data: user data to pass to the function
*
* Call @function on each dock widget of the master.
@@ -944,7 +944,7 @@ gdl_dock_master_foreach (GdlDockMaster *master,
* gdl_dock_master_foreach_toplevel:
* @master: a #GdlDockMaster
* @include_controller: %TRUE to include the controller
- * @function: the function to call with each element's data
+ * @function: (scope call): the function to call with each element's data
* @user_data: user data to pass to the function
*
* Call @function on each top level dock widget of the master, including or not
@@ -975,7 +975,7 @@ gdl_dock_master_foreach_toplevel (GdlDockMaster *master,
*
* Looks for a #GdlDockObject named @nick_name.
*
- * Returns: A #GdlDockObject named @nick_name or %NULL if it does not exist.
+ * Returns: (allow-none) (transfer none): A #GdlDockObject named @nick_name or %NULL if it does not exist.
*/
GdlDockObject *
gdl_dock_master_get_object (GdlDockMaster *master,
@@ -999,7 +999,7 @@ gdl_dock_master_get_object (GdlDockMaster *master,
*
* Retrieves the #GdlDockObject acting as the controller.
*
- * Returns: A #GdlDockObject.
+ * Returns: (transfer none): A #GdlDockObject.
*/
GdlDockObject *
gdl_dock_master_get_controller (GdlDockMaster *master)
diff --git a/gdl/gdl-dock-object.c b/gdl/gdl-dock-object.c
index fdac720..2b6b08f 100644
--- a/gdl/gdl-dock-object.c
+++ b/gdl/gdl-dock-object.c
@@ -130,7 +130,7 @@ gdl_dock_object_class_init (GdlDockObjectClass *klass)
g_object_class->finalize = gdl_dock_object_finalize;
/**
- * GdlDockObject:name
+ * GdlDockObject:name:
*
* The object name. If the object is manual the name can be used
* to recall the object from any other object in the ring
@@ -144,7 +144,7 @@ gdl_dock_object_class_init (GdlDockObjectClass *klass)
GDL_DOCK_PARAM_EXPORT));
/**
- * GdlDockObject:long-name
+ * GdlDockObject:long-name:
*
* A long descriptive name.
*/
@@ -156,7 +156,7 @@ gdl_dock_object_class_init (GdlDockObjectClass *klass)
G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
/**
- * GdlDockObject:stock-id
+ * GdlDockObject:stock-id:
*
* A stock id to use for the icon of the dock object.
*/
@@ -168,7 +168,7 @@ gdl_dock_object_class_init (GdlDockObjectClass *klass)
G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
/**
- * GdlDockObject:pixbuf-icon
+ * GdlDockObject:pixbuf-icon:
*
* A GdkPixbuf to use for the icon of the dock object.
*
@@ -181,7 +181,7 @@ gdl_dock_object_class_init (GdlDockObjectClass *klass)
G_PARAM_READWRITE));
/**
- * GdlDockObject:master
+ * GdlDockObject:master:
*
* The master which manages all the objects in a dock ring
*/
@@ -560,7 +560,7 @@ gdl_dock_object_detach (GdlDockObject *object,
*
* Returns a parent #GdlDockObject if it exists.
*
- * Returns: a #GdlDockObject or %NULL if such object does not exist.
+ * Returns: (allow-none) (transfer none): a #GdlDockObject or %NULL if such object does not exist.
*/
GdlDockObject *
gdl_dock_object_get_parent_object (GdlDockObject *object)
@@ -830,7 +830,7 @@ gdl_dock_object_reorder (GdlDockObject *object,
/**
* gdl_dock_object_present:
* @object: A #GdlDockObject
- * @child: The child widget to present or %NULL
+ * @child: (allow-none): The child widget to present or %NULL
*
* Presents the GDL object to the user. By example, this will select the
* corresponding page if the object is in a notebook. If @child is missing,
@@ -857,7 +857,7 @@ gdl_dock_object_present (GdlDockObject *object,
* gdl_dock_object_child_placement:
* @object: the dock object we are asking for child placement
* @child: the child of the @object we want the placement for
- * @placement: where to return the placement information
+ * @placement: (allow-none): where to return the placement information
*
* This function returns information about placement of a child dock
* object inside another dock object. The function returns %TRUE if
diff --git a/gdl/gdl-dock.c b/gdl/gdl-dock.c
index 02b019c..d84cef2 100644
--- a/gdl/gdl-dock.c
+++ b/gdl/gdl-dock.c
@@ -1087,7 +1087,7 @@ gdl_dock_present (GdlDockObject *object,
*
* Create a new dock.
*
- * Returns: A new #GdlDock widget.
+ * Returns: (transfer full): A new #GdlDock widget.
*/
GtkWidget *
gdl_dock_new (void)
@@ -1107,7 +1107,7 @@ gdl_dock_new (void)
*
* Create a new dock widget having the same master than @original.
*
- * Returns: A new #GdlDock widget
+ * Returns: (transfer full): A new #GdlDock widget
*/
GtkWidget *
gdl_dock_new_from (GdlDock *original,
@@ -1371,14 +1371,14 @@ gdl_dock_add_floating_item (GdlDock *dock,
}
/**
- * gdl_dock_get_item_by_name
+ * gdl_dock_get_item_by_name:
* @dock: A #GdlDock widget
* @name: An item name
*
* Looks for an #GdlDockItem widget bound to the master of the dock item. It
* does not search only in the children of this particular dock widget.
*
- * Returns: A #GdlDockItem widget or %NULL
+ * Returns: (transfer none): A #GdlDockItem widget or %NULL
*/
GdlDockItem *
gdl_dock_get_item_by_name (GdlDock *dock,
@@ -1395,14 +1395,14 @@ gdl_dock_get_item_by_name (GdlDock *dock,
}
/**
- * gdl_dock_get_placeholder_by_name
+ * gdl_dock_get_placeholder_by_name:
* @dock: A #GdlDock widget
* @name: An item name
*
* Looks for an #GdlDockPlaceholder object bound to the master of the dock item.
* It does not search only in the children of this particular dock widget.
*
- * Returns: A #GdlDockPlaceholder object or %NULL
+ * Returns: (transfer none): A #GdlDockPlaceholder object or %NULL
*/
GdlDockPlaceholder *
gdl_dock_get_placeholder_by_name (GdlDock *dock,
@@ -1426,7 +1426,7 @@ gdl_dock_get_placeholder_by_name (GdlDock *dock,
* Returns a list of all item bound to the master of the dock, not only
* the children of this particular dock widget.
*
- * Returns: A list of #GdlDockItem. The list should be freedwith g_list_free(),
+ * Returns: (element-type GdlDockObject) (transfer container): A list of #GdlDockItem. The list should be freedwith g_list_free(),
* but the item still belong to the master.
*/
GList *
@@ -1448,7 +1448,7 @@ gdl_dock_get_named_items (GdlDock *dock)
*
* Get the top level #GdlDock widget of @object or %NULL if cannot be found.
*
- * Returns: A #GdlDock or %NULL.
+ * Returns: (allow-none) (transfer none): A #GdlDock or %NULL.
*/
GdlDock *
gdl_dock_object_get_toplevel (GdlDockObject *object)
diff --git a/gdl/gdl-dock.h b/gdl/gdl-dock.h
index 0e10e86..419a4f7 100644
--- a/gdl/gdl-dock.h
+++ b/gdl/gdl-dock.h
@@ -78,7 +78,7 @@ GType gdl_dock_get_type (void);
void gdl_dock_add_item (GdlDock *dock,
GdlDockItem *item,
- GdlDockPlacement place);
+ GdlDockPlacement placement);
void gdl_dock_add_floating_item (GdlDock *dock,
GdlDockItem *item,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]