[evolution-data-server] ebook: GIR annotation fixes

[Philip Withnall <pwithnall src gnome org>]

commit 9422acd953b8ba485ecd4bb03f3939254b9d8077
Author: Philip Withnall <philip tecnocode co uk>
Date:   Mon Jun 18 16:19:35 2012 +0100

    ebook: GIR annotation fixes
    
    Various documentation comment fixes and annotation additions.

 addressbook/libebook/e-book-client.c |   26 ++++++++++++++------------
 addressbook/libebook/e-book.c        |   10 +++++-----
 addressbook/libebook/e-contact.c     |    2 +-
 addressbook/libebook/e-destination.c |    2 +-
 addressbook/libebook/e-vcard.h       |    4 ++--
 5 files changed, 23 insertions(+), 21 deletions(-)
---
diff --git a/addressbook/libebook/e-book-client.c b/addressbook/libebook/e-book-client.c
index ccf5db1..c535815 100644
--- a/addressbook/libebook/e-book-client.c
+++ b/addressbook/libebook/e-book-client.c
@@ -50,7 +50,7 @@ struct _EBookClientPrivate {
 
 G_DEFINE_TYPE (EBookClient, e_book_client, E_TYPE_CLIENT)
 
-/**
+/*
  * Well-known book backend properties:
  * @BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS: Retrieves comma-separated list
  *   of required fields by the backend. Use e_client_util_parse_comma_strings()
@@ -68,7 +68,7 @@ G_DEFINE_TYPE (EBookClient, e_book_client, E_TYPE_CLIENT)
  * See also: @CLIENT_BACKEND_PROPERTY_OPENED, @CLIENT_BACKEND_PROPERTY_OPENING,
  *   @CLIENT_BACKEND_PROPERTY_ONLINE, @CLIENT_BACKEND_PROPERTY_READONLY
  *   @CLIENT_BACKEND_PROPERTY_CACHE_DIR, @CLIENT_BACKEND_PROPERTY_CAPABILITIES
- **/
+ */
 
 GQuark
 e_book_client_error_quark (void)
@@ -127,7 +127,7 @@ e_book_client_error_create (EBookClientError code,
 	return g_error_new_literal (E_BOOK_CLIENT_ERROR, code, custom_msg ? custom_msg : e_book_client_error_to_string (code));
 }
 
-/**
+/*
  * If the specified GError is a remote error, then create a new error
  * representing the remote error.  If the error is anything else, then
  * leave it alone.
@@ -1152,8 +1152,8 @@ e_book_client_add_contact_sync (EBookClient *client,
 /**
  * e_book_client_add_contacts:
  * @client: an #EBookClient
- * @contacts: a #GSList of #EContact objects to add
- * @cancellable: a #GCancellable; can be %NULL
+ * @contacts: (element-type EContact): a #GSList of #EContact objects to add
+ * @cancellable: (allow-none): a #GCancellable; can be %NULL
  * @callback: callback to call when a result is ready
  * @user_data: user data for the @callback
  *
@@ -1187,7 +1187,8 @@ e_book_client_add_contacts (EBookClient *client,
  * e_book_client_add_contacts_finish:
  * @client: an #EBookClient
  * @result: a #GAsyncResult
- * @added_uids: (out): UIDs of newly added contacts; can be %NULL
+ * @added_uids: (out) (element-type utf8) (allow-none): UIDs of newly added
+ * contacts; can be %NULL
  * @error: (out): a #GError to set an error, if any
  *
  * Finishes previous call of e_book_client_add_contacts() and
@@ -1229,8 +1230,9 @@ e_book_client_add_contacts_finish (EBookClient *client,
 /**
  * e_book_client_add_contacts_sync:
  * @client: an #EBookClient
- * @contacts: a #GSList of #EContact objects to add
- * @added_uids: (out): UIDs of newly added contacts; can be %NULL
+ * @contacts: (element-type EContact): a #GSList of #EContact objects to add
+ * @added_uids: (out) (element-type utf8) (allow-none): UIDs of newly added
+ * contacts; can be %NULL
  * @cancellable: a #GCancellable; can be %NULL
  * @error: (out): a #GError to set an error, if any
  *
@@ -1390,8 +1392,8 @@ e_book_client_modify_contact_sync (EBookClient *client,
 /**
  * e_book_client_modify_contacts:
  * @client: an #EBookClient
- * @contacts: a #GSList of #EContact objects
- * @cancellable: a #GCancellable; can be %NULL
+ * @contacts: (element-type EContact): a #GSList of #EContact objects
+ * @cancellable: (allow-none): a #GCancellable; can be %NULL
  * @callback: callback to call when a result is ready
  * @user_data: user data for the @callback
  *
@@ -1444,8 +1446,8 @@ e_book_client_modify_contacts_finish (EBookClient *client,
 /**
  * e_book_client_modify_contacts_sync:
  * @client: an #EBookClient
- * @contacts: a #GSList of #EContact objects
- * @cancellable: a #GCancellable; can be %NULL
+ * @contacts: (element-type EContact): a #GSList of #EContact objects
+ * @cancellable: (allow-none): a #GCancellable; can be %NULL
  * @error: (out): a #GError to set an error, if any
  *
  * Applies the changes made to @contacts to the stored versions in @client.
diff --git a/addressbook/libebook/e-book.c b/addressbook/libebook/e-book.c
index 16df768..e64fa61 100644
--- a/addressbook/libebook/e-book.c
+++ b/addressbook/libebook/e-book.c
@@ -1176,7 +1176,7 @@ e_book_get_supported_auth_methods_async (EBook *book,
  * e_book_get_contact:
  * @book: an #EBook
  * @id: a unique string ID specifying the contact
- * @contact: (out) (transfer: full): 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
@@ -2985,7 +2985,7 @@ e_book_new (ESource *source,
 	return book;
 }
 
-/**
+/*
  * If the GError is a remote error, extract the EBookStatus embedded inside.
  * Otherwise return DBUS_EXCEPTION (I know this is DBus...).
  */
@@ -3054,7 +3054,7 @@ get_status_from_error (GError *error)
 	}
 }
 
-/**
+/*
  * If the specified GError is a remote error, then create a new error
  * representing the remote error.  If the error is anything else, then leave it
  * alone.
@@ -3085,7 +3085,7 @@ unwrap_gerror (GError *error,
 	return FALSE;
 }
 
-/**
+/*
  * Turn a GList of strings into an array of strings. Free with g_strfreev().
  */
 static gchar **
@@ -3101,7 +3101,7 @@ flatten_stringlist (GList *list)
 	return array;
 }
 
-/**
+/*
  * Turn an array of strings into a GList.
  */
 static GList *
diff --git a/addressbook/libebook/e-contact.c b/addressbook/libebook/e-contact.c
index 9f86d5d..d0f5920 100644
--- a/addressbook/libebook/e-contact.c
+++ b/addressbook/libebook/e-contact.c
@@ -1726,7 +1726,7 @@ e_contact_get_const (EContact *contact,
 }
 
 /**
- * e_contact_set;
+ * e_contact_set:
  * @contact: an #EContact
  * @field_id: an #EContactField
  * @value: a value whose type depends on the @field_id
diff --git a/addressbook/libebook/e-destination.c b/addressbook/libebook/e-destination.c
index 5e3139c..533eb67 100644
--- a/addressbook/libebook/e-destination.c
+++ b/addressbook/libebook/e-destination.c
@@ -1603,7 +1603,7 @@ e_destination_export (const EDestination *dest)
 }
 
 /**
- * e_destination_import
+ * e_destination_import:
  * @str: an XML string
  *
  * Creates an #EDestination from an XML document.
diff --git a/addressbook/libebook/e-vcard.h b/addressbook/libebook/e-vcard.h
index 66e3c8b..f20eada 100644
--- a/addressbook/libebook/e-vcard.h
+++ b/addressbook/libebook/e-vcard.h
@@ -115,7 +115,7 @@ G_BEGIN_DECLS
 #define EVC_X_GOOGLE_TALK		"X-GOOGLE-TALK"
 
 /**
- * EVC_X_TWITTER
+ * EVC_X_TWITTER:
  * Twitter name(s).
  *
  * Since: 3.6
@@ -140,7 +140,7 @@ G_BEGIN_DECLS
 /* Constants for Evo contact lists only */
 
 /**
- * EVC_CONTACT_LIST
+ * EVC_CONTACT_LIST:
  *
  * Since: 3.2
  **/