GNOME.org
 

[evolution-data-server] Update libebook API docs.

commit 24b12b57dbbd374e282f0f32db94bd9bfd292038
Author: Matthew Barnes <mbarnes redhat com>
Date:   Sun Oct 16 17:22:20 2011 -0400

    Update libebook API docs.

 addressbook/libebook/e-book-client.c               |    6 +-
 addressbook/libebook/e-book.c                      |    4 +-
 addressbook/libebook/e-contact.c                   |    9 ++-
 addressbook/libebook/e-vcard.c                     |   31 ++++++---
 .../addressbook/libebook/libebook-sections.txt     |   11 +++-
 .../addressbook/libebook/tmpl/e-book-client.sgml   |   72 ++++++++++++++++++++
 .../addressbook/libebook/tmpl/e-contact.sgml       |   10 +++
 .../addressbook/libebook/tmpl/e-vcard.sgml         |   29 ++++++++
 .../addressbook/libebook/tmpl/libebook-unused.sgml |    8 --
 9 files changed, 152 insertions(+), 28 deletions(-)
---
diff --git a/addressbook/libebook/e-book-client.c b/addressbook/libebook/e-book-client.c
index eb72a2b..2794e4c 100644
--- a/addressbook/libebook/e-book-client.c
+++ b/addressbook/libebook/e-book-client.c
@@ -1513,7 +1513,7 @@ e_book_client_add_contacts_finish (EBookClient *client,
  * Since: 3.4
  **/
 gboolean
-e_book_client_add_contacts_sync	(EBookClient *client,
+e_book_client_add_contacts_sync (EBookClient *client,
                                  /* const */ GSList *contacts,
                                  GSList **added_uids,
                                  GCancellable *cancellable,
@@ -1533,7 +1533,7 @@ e_book_client_add_contacts_sync	(EBookClient *client,
 
 	array = contact_slist_to_utf8_vcard_array (contacts);
 
-	res = e_client_proxy_call_sync_strv__strv (E_CLIENT (client), (const gchar * const*) array, &out_uids, cancellable, error, e_gdbus_book_call_add_contacts_sync);
+	res = e_client_proxy_call_sync_strv__strv (E_CLIENT (client), (const gchar * const *) array, &out_uids, cancellable, error, e_gdbus_book_call_add_contacts_sync);
 
 	if (res && out_uids && added_uids) {
 		*added_uids = e_client_util_strv_to_slist ((const gchar * const*) out_uids);
@@ -1743,7 +1743,7 @@ e_book_client_modify_contacts_sync (EBookClient *client,
 
 	array = contact_slist_to_utf8_vcard_array (contacts);
 
-	res = e_client_proxy_call_sync_strv__void (E_CLIENT (client), (const gchar * const*) array, cancellable, error, e_gdbus_book_call_modify_contacts_sync);
+	res = e_client_proxy_call_sync_strv__void (E_CLIENT (client), (const gchar * const *) array, cancellable, error, e_gdbus_book_call_modify_contacts_sync);
 
 	g_strfreev (array);
 
diff --git a/addressbook/libebook/e-book.c b/addressbook/libebook/e-book.c
index fe15e58..98218fe 100644
--- a/addressbook/libebook/e-book.c
+++ b/addressbook/libebook/e-book.c
@@ -2386,8 +2386,8 @@ e_book_get_changes (EBook *book,
 
 	e_return_error_if_fail (
 		book->priv->gdbus_book, E_BOOK_ERROR_REPOSITORY_OFFLINE);
-	
-	if (error) {	
+
+	if (error) {
 		*error = g_error_new (E_BOOK_ERROR, E_BOOK_ERROR_NOT_SUPPORTED, "Not supported");
 	}
 
diff --git a/addressbook/libebook/e-contact.c b/addressbook/libebook/e-contact.c
index 943f3b0..66cb212 100644
--- a/addressbook/libebook/e-contact.c
+++ b/addressbook/libebook/e-contact.c
@@ -1321,9 +1321,12 @@ e_contact_new_from_vcard (const gchar *vcard)
  * Creates a new #EContact based on a vcard and a predefined UID.
  *
  * Returns: A new #EContact.
+ *
+ * Since: 3.4
  **/
 EContact *
-e_contact_new_from_vcard_with_uid (const gchar *vcard, const gchar *uid)
+e_contact_new_from_vcard_with_uid (const gchar *vcard,
+                                   const gchar *uid)
 {
 	EContact *contact;
 	g_return_val_if_fail (vcard != NULL, NULL);
@@ -1618,9 +1621,9 @@ e_contact_get (EContact *contact,
 	}
 	else if (info->t & E_CONTACT_FIELD_TYPE_STRING) {
 		EVCardAttribute *attr;
-		const char *cv = NULL;
+		const gchar *cv = NULL;
 		GList *v = NULL;
-		
+
 		/* Do our best to avoid vcard parsing by not calling
 		 * e_vcard_get_attributes */
 
diff --git a/addressbook/libebook/e-vcard.c b/addressbook/libebook/e-vcard.c
index 7ba41d7..7e06c00 100644
--- a/addressbook/libebook/e-vcard.c
+++ b/addressbook/libebook/e-vcard.c
@@ -649,10 +649,10 @@ parse (EVCard *evc,
 
 			if (g_ascii_strcasecmp (next_attr->name, "end") == 0)
 				break;
-			
+
 			if (ignore_uid && g_ascii_strcasecmp (attr->name, EVC_UID) == 0)
 				continue;
-				
+
 			e_vcard_add_attribute (evc, next_attr);
 		}
 	}
@@ -785,6 +785,13 @@ e_vcard_construct (EVCard *evc,
 	e_vcard_construct_with_uid (evc, str, NULL);
 }
 
+/**
+ * e_vcard_construct_with_uid:
+ *
+ * FIXME: Document me!
+ *
+ * Since: 3.4
+ **/
 void
 e_vcard_construct_with_uid (EVCard *evc,
                             const gchar *str,
@@ -798,7 +805,7 @@ e_vcard_construct_with_uid (EVCard *evc,
 	/* Lazy construction */
 	if (*str)
 		evc->priv->vcard = g_strdup (str);
-		
+
 	/* Add UID attribute */
 	if (uid) {
 		EVCardAttribute *attr;
@@ -1241,9 +1248,9 @@ e_vcard_append_attribute (EVCard *evc,
 {
 	g_return_if_fail (E_IS_VCARD (evc));
 	g_return_if_fail (attr != NULL);
-	
+
 	/* Handle UID special case:
-	   No need to parse the vcard to append an UID attribute */
+	 * No need to parse the vcard to append an UID attribute */
 	if (evc->priv->vcard != NULL && g_strcmp0 (attr->name, EVC_UID) == 0) {
 		evc->priv->attributes = g_list_append (evc->priv->attributes, attr);
 	} else {
@@ -1321,9 +1328,9 @@ e_vcard_add_attribute (EVCard *evc,
 {
 	g_return_if_fail (E_IS_VCARD (evc));
 	g_return_if_fail (attr != NULL);
-	
+
 	/* Handle UID special case:
-	   No need to parse the vcard to append an UID attribute */
+	 * No need to parse the vcard to append an UID attribute */
 	if (evc->priv->vcard != NULL && g_strcmp0 (attr->name, EVC_UID) == 0) {
 		evc->priv->attributes = g_list_prepend (evc->priv->attributes, attr);
 	} else {
@@ -1933,7 +1940,7 @@ e_vcard_get_attribute (EVCard *evc,
 
 	g_return_val_if_fail (E_IS_VCARD (evc), NULL);
 	g_return_val_if_fail (name != NULL, NULL);
-	
+
 	/* Handle UID special case */
 	if (evc->priv->vcard != NULL && g_ascii_strcasecmp (name, EVC_UID) == 0) {
 		for (l = evc->priv->attributes; l != NULL; l = l->next) {
@@ -1962,6 +1969,8 @@ e_vcard_get_attribute (EVCard *evc,
  * parse the vcard if not already parsed.
  *
  * Returns: (transfer none): An #EVCardAttribute if found, or #NULL.
+ *
+ * Since: 3.4
  **/
 EVCardAttribute *
 e_vcard_get_attribute_if_parsed (EVCard *evc,
@@ -1969,16 +1978,16 @@ e_vcard_get_attribute_if_parsed (EVCard *evc,
 {
 	GList *l;
 	EVCardAttribute *attr;
-	
+
 	g_return_val_if_fail (E_IS_VCARD (evc), NULL);
 	g_return_val_if_fail (name != NULL, NULL);
-	
+
 	for (l = evc->priv->attributes; l != NULL; l = l->next) {
 		attr = (EVCardAttribute *) l->data;
 		if (g_ascii_strcasecmp (attr->name, name) == 0)
 			return attr;
 	}
-	
+
 	return NULL;
 }
 
diff --git a/docs/reference/addressbook/libebook/libebook-sections.txt b/docs/reference/addressbook/libebook/libebook-sections.txt
index ed17e39..877f3ba 100644
--- a/docs/reference/addressbook/libebook/libebook-sections.txt
+++ b/docs/reference/addressbook/libebook/libebook-sections.txt
@@ -142,9 +142,15 @@ e_book_client_is_self
 e_book_client_add_contact
 e_book_client_add_contact_finish
 e_book_client_add_contact_sync
+e_book_client_add_contacts
+e_book_client_add_contacts_finish
+e_book_client_add_contacts_sync
 e_book_client_modify_contact
 e_book_client_modify_contact_finish
 e_book_client_modify_contact_sync
+e_book_client_modify_contacts
+e_book_client_modify_contacts_finish
+e_book_client_modify_contacts_sync
 e_book_client_remove_contact
 e_book_client_remove_contact_finish
 e_book_client_remove_contact_sync
@@ -215,6 +221,7 @@ EContactDate
 EContactCert
 e_contact_new
 e_contact_new_from_vcard
+e_contact_new_from_vcard_with_uid
 e_contact_duplicate
 e_contact_get
 e_contact_get_const
@@ -280,6 +287,8 @@ EVCard
 EVCardFormat
 EVCardAttribute
 EVCardAttributeParam
+e_vcard_construct
+e_vcard_construct_with_uid
 e_vcard_new
 e_vcard_new_from_string
 e_vcard_to_string
@@ -316,6 +325,7 @@ e_vcard_attribute_param_remove_values
 e_vcard_attribute_param_get_name
 e_vcard_attribute_param_get_values
 e_vcard_get_attribute
+e_vcard_get_attribute_if_parsed
 e_vcard_get_attributes
 e_vcard_attribute_get_group
 e_vcard_attribute_get_name
@@ -411,7 +421,6 @@ e_vcard_attribute_get_type
 e_vcard_attribute_param_get_type
 <SUBSECTION Private>
 EVCardPrivate
-e_vcard_construct
 </SECTION>
 
 <SECTION>
diff --git a/docs/reference/addressbook/libebook/tmpl/e-book-client.sgml b/docs/reference/addressbook/libebook/tmpl/e-book-client.sgml
index 5ba515c..af62a19 100644
--- a/docs/reference/addressbook/libebook/tmpl/e-book-client.sgml
+++ b/docs/reference/addressbook/libebook/tmpl/e-book-client.sgml
@@ -220,6 +220,43 @@ EBookClient
 @Returns: 
 
 
+<!-- ##### FUNCTION e_book_client_add_contacts ##### -->
+<para>
+
+</para>
+
+ client: 
+ contacts: 
+ cancellable: 
+ callback: 
+ user_data: 
+
+
+<!-- ##### FUNCTION e_book_client_add_contacts_finish ##### -->
+<para>
+
+</para>
+
+ client: 
+ result: 
+ added_uids: 
+ error: 
+ Returns: 
+
+
+<!-- ##### FUNCTION e_book_client_add_contacts_sync ##### -->
+<para>
+
+</para>
+
+ client: 
+ contacts: 
+ added_uids: 
+ cancellable: 
+ error: 
+ Returns: 
+
+
 <!-- ##### FUNCTION e_book_client_modify_contact ##### -->
 <para>
 
@@ -255,6 +292,41 @@ EBookClient
 @Returns: 
 
 
+<!-- ##### FUNCTION e_book_client_modify_contacts ##### -->
+<para>
+
+</para>
+
+ client: 
+ contacts: 
+ cancellable: 
+ callback: 
+ user_data: 
+
+
+<!-- ##### FUNCTION e_book_client_modify_contacts_finish ##### -->
+<para>
+
+</para>
+
+ client: 
+ result: 
+ error: 
+ Returns: 
+
+
+<!-- ##### FUNCTION e_book_client_modify_contacts_sync ##### -->
+<para>
+
+</para>
+
+ client: 
+ contacts: 
+ cancellable: 
+ error: 
+ Returns: 
+
+
 <!-- ##### FUNCTION e_book_client_remove_contact ##### -->
 <para>
 
diff --git a/docs/reference/addressbook/libebook/tmpl/e-contact.sgml b/docs/reference/addressbook/libebook/tmpl/e-contact.sgml
index 72f660c..353be55 100644
--- a/docs/reference/addressbook/libebook/tmpl/e-contact.sgml
+++ b/docs/reference/addressbook/libebook/tmpl/e-contact.sgml
@@ -917,6 +917,16 @@ The URI of the contact's calendar.
 @Returns: 
 
 
+<!-- ##### FUNCTION e_contact_new_from_vcard_with_uid ##### -->
+<para>
+
+</para>
+
+ vcard: 
+ uid: 
+ Returns: 
+
+
 <!-- ##### FUNCTION e_contact_duplicate ##### -->
 <para>
 
diff --git a/docs/reference/addressbook/libebook/tmpl/e-vcard.sgml b/docs/reference/addressbook/libebook/tmpl/e-vcard.sgml
index e862487..869d209 100644
--- a/docs/reference/addressbook/libebook/tmpl/e-vcard.sgml
+++ b/docs/reference/addressbook/libebook/tmpl/e-vcard.sgml
@@ -46,6 +46,25 @@ Does the low-level parsing work for contact information. This data is more conve
 </para>
 
 
+<!-- ##### FUNCTION e_vcard_construct ##### -->
+<para>
+
+</para>
+
+ evc: 
+ str: 
+
+
+<!-- ##### FUNCTION e_vcard_construct_with_uid ##### -->
+<para>
+
+</para>
+
+ evc: 
+ str: 
+ uid: 
+
+
 <!-- ##### FUNCTION e_vcard_new ##### -->
 <para>
 
@@ -376,6 +395,16 @@ Does the low-level parsing work for contact information. This data is more conve
 @Returns: 
 
 
+<!-- ##### FUNCTION e_vcard_get_attribute_if_parsed ##### -->
+<para>
+
+</para>
+
+ evc: 
+ name: 
+ Returns: 
+
+
 <!-- ##### FUNCTION e_vcard_get_attributes ##### -->
 <para>
 
diff --git a/docs/reference/addressbook/libebook/tmpl/libebook-unused.sgml b/docs/reference/addressbook/libebook/tmpl/libebook-unused.sgml
index 416a567..ec44fb3 100644
--- a/docs/reference/addressbook/libebook/tmpl/libebook-unused.sgml
+++ b/docs/reference/addressbook/libebook/tmpl/libebook-unused.sgml
@@ -668,11 +668,3 @@ Data sent back to the e-book object.
 
 @Returns: 
 
-<!-- ##### FUNCTION e_vcard_construct ##### -->
-<para>
-
-</para>
-
- evc: 
- str: 
-
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]