GNOME.org
 

[evolution-data-server] Fixed annotations in libedataserver

commit d5bc106979c8e39a7930742a457f0a3d1b9457d9
Author: Raul Gutierrez Segales <raul gutierrez segales collabora co uk>
Date:   Mon May 16 14:19:26 2011 +0100

    Fixed annotations in libedataserver

 libedataserver/e-categories.c     |   10 +++++-----
 libedataserver/e-iterator.c       |    2 ++
 libedataserver/e-list.c           |   28 ++++++++++++++++++++++++++++
 libedataserver/e-source-group.c   |   13 +++++++++++++
 libedataserver/e-source-list.c    |   25 ++++++++++++++++++++++---
 libedataserver/e-source.c         |    6 +++---
 libedataserver/e-xml-hash-utils.c |    7 ++++---
 7 files changed, 77 insertions(+), 14 deletions(-)
---
diff --git a/libedataserver/e-categories.c b/libedataserver/e-categories.c
index 436952f..88dfa97 100644
--- a/libedataserver/e-categories.c
+++ b/libedataserver/e-categories.c
@@ -552,9 +552,9 @@ initialize_categories (void)
  *
  * Returns a sorted list of all the category names currently configured.
  *
- * Returns: a sorted GList containing the names of the categories. The
- * list should be freed using g_list_free, but the names of the categories
- * should not be touched at all, they are internal strings.
+ * Returns: (transfer container): a sorted GList containing the names of the
+ * categories.The list should be freed using g_list_free, but the names of
+ * the categories should not be touched at all, they are internal strings.
  */
 GList *
 e_categories_get_list (void)
@@ -726,7 +726,7 @@ e_categories_is_searchable (const gchar *category)
 
 /**
  * e_categories_register_change_listener:
- * @listener: the callback to be called on any category change.
+ * @listener: (scope async): the callback to be called on any category change.
  * @user_data: used data passed to the @listener when called.
  *
  * Registers callback to be called on change of any category.
@@ -746,7 +746,7 @@ e_categories_register_change_listener (GCallback listener, gpointer user_data)
 
 /**
  * e_categories_unregister_change_listener:
- * @listener: Callback to be removed.
+ * @listener: (scope async): Callback to be removed.
  * @user_data: User data as passed with call to @e_categories_register_change_listener.
  *
  * Removes previously registered callback from the list of listeners on changes.
diff --git a/libedataserver/e-iterator.c b/libedataserver/e-iterator.c
index e7ccb50..46a4e8e 100644
--- a/libedataserver/e-iterator.c
+++ b/libedataserver/e-iterator.c
@@ -57,6 +57,8 @@ e_iterator_init (EIterator *card)
 
 /*
  * Virtual functions:
+ *
+ * Returns: (transfer none): the iterator.
  */
 gconstpointer
 e_iterator_get      (EIterator *iterator)
diff --git a/libedataserver/e-list.c b/libedataserver/e-list.c
index 53fc275..22a96d6 100644
--- a/libedataserver/e-list.c
+++ b/libedataserver/e-list.c
@@ -35,6 +35,14 @@ e_list_init (EList *list)
 	list->iterators = NULL;
 }
 
+/**
+ * e_list_new:
+ * @copy: (scope call): the copy func
+ * @free: (scope call): the free func
+ * @closure: user data
+ *
+ * Returns: (transfer full): The new #EList.
+ **/
 EList *
 e_list_new (EListCopyFunc copy, EListFreeFunc free, gpointer closure)
 {
@@ -43,6 +51,14 @@ e_list_new (EListCopyFunc copy, EListFreeFunc free, gpointer closure)
 	return list;
 }
 
+/**
+ * e_list_construct:
+ * @list: The #EList.
+ * @copy: (scope call): the copy func
+ * @free: (scope call): the free func
+ * @closure: user data
+ *
+ **/
 void
 e_list_construct (EList *list, EListCopyFunc copy, EListFreeFunc free, gpointer closure)
 {
@@ -51,6 +67,12 @@ e_list_construct (EList *list, EListCopyFunc copy, EListFreeFunc free, gpointer
 	list->closure = closure;
 }
 
+/**
+ * e_list_duplicate:
+ * @old: The #EList object.
+ *
+ * Returns: (transfer full): The duplicated #EList.
+ **/
 EList *
 e_list_duplicate (EList *old)
 {
@@ -69,6 +91,12 @@ e_list_duplicate (EList *old)
 	return list;
 }
 
+/**
+ * e_list_get_iterator:
+ * @list: The #EList object.
+ *
+ * Returns: (transfer none): the #EIterator.
+ **/
 EIterator *
 e_list_get_iterator (EList *list)
 {
diff --git a/libedataserver/e-source-group.c b/libedataserver/e-source-group.c
index 5c2e80b..054f32c 100644
--- a/libedataserver/e-source-group.c
+++ b/libedataserver/e-source-group.c
@@ -672,6 +672,11 @@ e_source_group_peek_sources (ESourceGroup *group)
 	return group->priv->sources;
 }
 
+/**
+ * e_source_group_peek_source_by_uid:
+ *
+ * Returns: (transfer none): the #ESource
+ */
 ESource *
 e_source_group_peek_source_by_uid (ESourceGroup *group,
 				   const gchar *uid)
@@ -686,6 +691,11 @@ e_source_group_peek_source_by_uid (ESourceGroup *group,
 	return NULL;
 }
 
+/**
+ * e_source_group_peek_source_by_name:
+ *
+ * Returns: (transfer none): the #ESource
+ */
 ESource *
 e_source_group_peek_source_by_name (ESourceGroup *group,
 				    const gchar *name)
@@ -968,6 +978,9 @@ e_source_group_set_property (ESourceGroup *source_group,
 
 /**
  * e_source_group_foreach_property:
+ * @source_group: the #ESourceGroup
+ * @func: (scope call): the func to call on each property
+ * @data: the user data
  *
  * Since: 1.12
  **/
diff --git a/libedataserver/e-source-list.c b/libedataserver/e-source-list.c
index 3979d4c..4d0c636 100644
--- a/libedataserver/e-source-list.c
+++ b/libedataserver/e-source-list.c
@@ -405,6 +405,12 @@ e_source_list_peek_groups (ESourceList *list)
 	return list->priv->groups;
 }
 
+
+/**
+ * e_source_list_peek_group_by_uid:
+ *
+ * Return value: (transfer none): the #ESourceGroup
+ */
 ESourceGroup *
 e_source_list_peek_group_by_uid (ESourceList *list,
 				 const gchar *uid)
@@ -433,7 +439,7 @@ e_source_list_peek_group_by_uid (ESourceList *list,
  * The base URI is usually just the URI scheme, such as "http://";.
  * If no such group is present in @list, the function returns %NULL.
  *
- * Returns: an #ESourceGroup with a matching base URI, or %NULL
+ * Returns: (transfer none): an #ESourceGroup with a matching base URI, or %NULL
  *
  * Since: 2.28
  **/
@@ -488,6 +494,8 @@ check_group_property (const gchar *property_name, const gchar *property_value, s
  * is returned only if matches all the properties. Values are compared
  * case insensitively.
  *
+ * Returns: (transfer none): the #ESourceGroup
+ *
  * Since: 2.28
  **/
 ESourceGroup *
@@ -533,6 +541,11 @@ e_source_list_peek_group_by_properties (ESourceList *list, const gchar *property
 	return NULL;
 }
 
+/**
+ * e_source_list_peek_source_by_uid:
+ *
+ * Return value: (transfer none): the #ESource
+ */
 ESource *
 e_source_list_peek_source_by_uid (ESourceList *list,
 				  const gchar *uid)
@@ -554,6 +567,11 @@ e_source_list_peek_source_by_uid (ESourceList *list,
 	return NULL;
 }
 
+/**
+ * e_source_list_peek_source_any:
+ *
+ * Returns: (transfer none): the #ESource
+ */
 ESource *
 e_source_list_peek_source_any (ESourceList *list)
 {
@@ -582,7 +600,7 @@ e_source_list_peek_source_any (ESourceList *list)
  * property named "system".  If no such #ESource exists, the function
  * returns %NULL.
  *
- * Returns: the default #ESource in @source_list, or %NULL
+ * Returns: (transfer none): the default #ESource in @source_list, or %NULL
  *
  * Since: 2.32
  **/
@@ -727,7 +745,8 @@ e_source_list_remove_group_by_uid (ESourceList *list,
  * renames its to the given name.  If @ret_it is %TRUE, the matching group
  * will be returned and should be unreferenced with g_object_unref().
  *
- * Returns: the matching #ESourceGroup if @ret_it is %TRUE, otherwise %NULL
+ * Returns: (transfer full): the matching #ESourceGroup if @ret_it is %TRUE,
+ *          otherwise %NULL
  *
  * Since: 2.28
  **/
diff --git a/libedataserver/e-source.c b/libedataserver/e-source.c
index 6db0abe..bbcaad4 100644
--- a/libedataserver/e-source.c
+++ b/libedataserver/e-source.c
@@ -715,7 +715,7 @@ e_source_set_color_spec (ESource *source,
  * Returns the #ESourceGroup to which @source belongs, or %NULL if it
  * does not belong to a group.
  *
- * Returns: the group to which the source belongs
+ * Returns: (transfer none): the group to which the source belongs
  **/
 ESourceGroup *
 e_source_peek_group (ESource *source)
@@ -1164,7 +1164,7 @@ e_source_set_property (ESource *source,
 /**
  * e_source_foreach_property:
  * @source: an #ESource
- * @func: the function to call for each property
+ * @func: (scope call): the function to call for each property
  * @user_data: user data to pass to the function
  *
  * Calls the given function for each property in @source.  The function
@@ -1197,7 +1197,7 @@ copy_property (const gchar *key,
  * Creates a new #ESource instance from @source, such that passing @source
  * and the newly created instance to e_source_equal() would return %TRUE.
  *
- * Returns: a newly-created #ESource
+ * Returns: (transfer full): a newly-created #ESource
  **/
 ESource *
 e_source_copy (ESource *source)
diff --git a/libedataserver/e-xml-hash-utils.c b/libedataserver/e-xml-hash-utils.c
index 28b6d22..9b2f025 100644
--- a/libedataserver/e-xml-hash-utils.c
+++ b/libedataserver/e-xml-hash-utils.c
@@ -44,7 +44,8 @@
  * %E_XML_HASH_TYPE_OBJECT_UID, then XML objects will be indexed in
  * the hash by their UID (other nodes will still be indexed by name).
  *
- * Returns: The newly-created #GHashTable representation of @doc.
+ * Returns: (transfer full): The newly-created #GHashTable representation
+ * of @doc.
  **/
 GHashTable *
 e_xml_to_hash (xmlDoc *doc, EXmlHashType type)
@@ -307,7 +308,7 @@ foreach_hash_func (gpointer  key, gpointer value, gpointer user_data)
 /**
  * e_xmlhash_foreach_key:
  * @hash: an #EXmlHash
- * @func: the #EXmlHashFunc to execute on the data in @hash
+ * @func: (scope async): the #EXmlHashFunc to execute on the data in @hash
  * @user_data: the data to pass to @func
  *
  * Executes @func against each key/value pair in @hash.
@@ -330,7 +331,7 @@ e_xmlhash_foreach_key (EXmlHash *hash,
 /**
  * e_xmlhash_foreach_key_remove:
  * @hash: an #EXmlHash
- * @func: the #EXmlHashFunc to execute on the data in @hash
+ * @func: (scope async): the #EXmlHashFunc to execute on the data in @hash
  * @user_data: the data to pass to @func
  *
  * Calls g_hash_table_foreach_remove() on @hash<!-- -->'s internal hash
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]