[evolution-data-server/gnome-2-32] Improve libebook annotations.



commit 12116eb27db8691d5fd9656a95e35cdceb07d030
Author: Raul Gutierrez Segales <raul gutierrez segales collabora co uk>
Date:   Wed Feb 2 18:17:40 2011 -0500

    Improve libebook annotations.

 addressbook/libebook/e-book.c    |   12 ++++++------
 addressbook/libebook/e-contact.c |    4 ++--
 addressbook/libebook/e-vcard.c   |    6 +++---
 3 files changed, 11 insertions(+), 11 deletions(-)
---
diff --git a/addressbook/libebook/e-book.c b/addressbook/libebook/e-book.c
index d0d7a7e..0239485 100644
--- a/addressbook/libebook/e-book.c
+++ b/addressbook/libebook/e-book.c
@@ -1238,7 +1238,7 @@ e_book_authenticate_user_async (EBook              *book,
  * e_book_get_contact:
  * @book: an #EBook
  * @id: a unique string ID specifying the contact
- * @contact: an #EContact
+ * @contact: (out) (transfer: full): an #EContact
  * @error: a #GError to set on failure
  *
  * Fills in @contact with the contents of the vcard in @book
@@ -1892,7 +1892,7 @@ get_book_view_reply (GObject *gdbus_book, GAsyncResult *res, gpointer user_data)
  * @query: an #EBookQuery
  * @requested_fields: a #GList containing the names of fields to return, or NULL for all
  * @max_results: the maximum number of contacts to show (or 0 for all)
- * @cb: a function to call when the operation finishes
+ * @cb: (scope call): a function to call when the operation finishes
  * @closure: data to pass to callback function
  *
  * Query @book with @query, creating a #EBookView with the fields
@@ -1937,7 +1937,7 @@ e_book_async_get_book_view (EBook                 *book,
  * @query: an #EBookQuery
  * @requested_fields: a #GList containing the names of fields to return, or NULL for all
  * @max_results: the maximum number of contacts to show (or 0 for all)
- * @cb: a function to call when the operation finishes
+ * @cb: (scope call): a function to call when the operation finishes
  * @closure: data to pass to callback function
  *
  * Query @book with @query, creating a #EBookView with the fields
@@ -2454,7 +2454,7 @@ open_reply (GObject *gdbus_book, GAsyncResult *res, gpointer user_data)
  * e_book_async_open:
  * @book: an #EBook
  * @only_if_exists: if %TRUE, fail if this book doesn't already exist, otherwise create it first
- * @open_response: a function to call when the operation finishes
+ * @open_response: (scope call) (closure closure): a function to call when the operation finishes
  * @closure: data to pass to callback function
  *
  * Opens the addressbook, making it ready for queries and other operations.
@@ -2490,7 +2490,7 @@ e_book_async_open (EBook                 *book,
  * e_book_open_async:
  * @book: an #EBook
  * @only_if_exists: if %TRUE, fail if this book doesn't already exist, otherwise create it first
- * @open_response: a function to call when the operation finishes
+ * @open_response: (scope call): a function to call when the operation finishes
  * @closure: data to pass to callback function
  *
  * Opens the addressbook, making it ready for queries and other operations.
@@ -3031,7 +3031,7 @@ e_book_set_default_source (ESource *source, GError **error)
 
 /**
  * e_book_get_addressbooks:
- * @addressbook_sources: A pointer to a ESourceList* to set
+ * @addressbook_sources: (out): A pointer to a #ESourceList* to set
  * @error: A pointer to a GError* to set on error
  *
  * Populate *addressbook_sources with the list of all sources which have been
diff --git a/addressbook/libebook/e-contact.c b/addressbook/libebook/e-contact.c
index d1c53c8..9875103 100644
--- a/addressbook/libebook/e-contact.c
+++ b/addressbook/libebook/e-contact.c
@@ -1394,7 +1394,7 @@ e_contact_field_id_from_vcard (const gchar *vcard_field)
  *
  * Gets the value of @contact's field specified by @field_id.
  *
- * Returns: Depends on the field's type, owned by the caller.
+ * Returns: (transfer full): Depends on the field's type, owned by the caller.
  **/
 gpointer
 e_contact_get (EContact *contact, EContactField field_id)
@@ -1634,7 +1634,7 @@ e_contact_set (EContact *contact, EContactField field_id, gconstpointer value)
  *
  * Gets a list of the vcard attributes for @contact's @field_id.
  *
- * Returns: A #GList of pointers to #EVCardAttribute, owned by the caller.
+ * Returns: (element-type EVCardAttribute) (transfer: full): A #GList of pointers to #EVCardAttribute, owned by the caller.
  **/
 GList*
 e_contact_get_attributes (EContact *contact, EContactField field_id)
diff --git a/addressbook/libebook/e-vcard.c b/addressbook/libebook/e-vcard.c
index d6719a9..8fae7f0 100644
--- a/addressbook/libebook/e-vcard.c
+++ b/addressbook/libebook/e-vcard.c
@@ -1860,7 +1860,7 @@ e_vcard_attribute_get_values (EVCardAttribute *attr)
  * necessary. The list and its contents are owned by @attr,
  * and must not be freed.
  *
- * Returns: A list of values of type #GString.
+ * Returns: (transfer: none) (element-type: GString): A list of values of type #GString.
  **/
 GList*
 e_vcard_attribute_get_values_decoded (EVCardAttribute *attr)
@@ -2030,7 +2030,7 @@ e_vcard_attribute_get_params (EVCardAttribute *attr)
  * Gets the list of values for the paramater @name from @attr. The list and its
  * contents are owned by @attr, and must not be freed.
  *
- * Returns: A list of string elements representing the parameter's values.
+ * Returns: (transfer: none) (element-type: utf8): A list of string elements representing the parameter's values.
  **/
 GList *
 e_vcard_attribute_get_param (EVCardAttribute *attr, const gchar *name)
@@ -2075,7 +2075,7 @@ e_vcard_attribute_param_get_name (EVCardAttributeParam *param)
  * Gets the list of values from @param. The list and its
  * contents are owned by @param, and must not be freed.
  *
- * Returns: A list of string elements representing the parameter's values.
+ * Returns: (transfer:none) (element-type: utf8): A list of string elements representing the parameter's values.
  **/
 GList*
 e_vcard_attribute_param_get_values (EVCardAttributeParam *param)



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