diff options
author | Matthew Barnes <mbarnes@redhat.com> | 2011-10-16 17:26:52 -0400 |
---|---|---|
committer | Matthew Barnes <mbarnes@redhat.com> | 2011-10-16 17:28:54 -0400 |
commit | 8641317bbe1457e60debcd2cff89cc1651798916 (patch) | |
tree | ec96d81d350ade212a91f143fd41bf29d04fc00e | |
parent | 24b12b57dbbd374e282f0f32db94bd9bfd292038 (diff) | |
download | evolution-data-server-8641317bbe1457e60debcd2cff89cc1651798916.tar.gz |
Update libedata-book API docs.
11 files changed, 132 insertions, 40 deletions
diff --git a/addressbook/libedata-book/e-book-backend-sqlitedb.c b/addressbook/libedata-book/e-book-backend-sqlitedb.c index 3b873cc7e..3310353e2 100644 --- a/addressbook/libedata-book/e-book-backend-sqlitedb.c +++ b/addressbook/libedata-book/e-book-backend-sqlitedb.c @@ -115,26 +115,26 @@ e_book_backend_sqlitedb_error_quark (void) static void e_book_backend_sqlitedb_dispose (GObject *object) { - EBookBackendSqliteDBPrivate *priv; + EBookBackendSqliteDBPrivate *priv; priv = E_BOOK_BACKEND_SQLITEDB (object)->priv; - g_static_mutex_lock (&dbcon_lock); + g_static_mutex_lock (&dbcon_lock); if (db_connections != NULL) { - if (priv->hash_key != NULL) { - g_hash_table_remove (db_connections, priv->hash_key); + if (priv->hash_key != NULL) { + g_hash_table_remove (db_connections, priv->hash_key); - if (g_hash_table_size (db_connections) == 0) { - g_hash_table_destroy (db_connections); - db_connections = NULL; - } + if (g_hash_table_size (db_connections) == 0) { + g_hash_table_destroy (db_connections); + db_connections = NULL; + } - g_free (priv->hash_key); - priv->hash_key = NULL; + g_free (priv->hash_key); + priv->hash_key = NULL; } } g_static_mutex_unlock (&dbcon_lock); - + /* Chain up to parent's dispose() method. */ G_OBJECT_CLASS (e_book_backend_sqlitedb_parent_class)->dispose (object); } @@ -562,11 +562,11 @@ e_book_backend_sqlitedb_new (const gchar *path, filename = g_build_filename (path, DB_FILENAME, NULL); if (!book_backend_sqlitedb_load (ebsdb, filename, &err)) { - g_static_mutex_unlock (&dbcon_lock); - g_propagate_error (error, err); - g_object_unref (ebsdb); - g_free (filename); - return NULL; + g_static_mutex_unlock (&dbcon_lock); + g_propagate_error (error, err); + g_object_unref (ebsdb); + g_free (filename); + return NULL; } g_free (filename); @@ -1159,7 +1159,10 @@ e_book_backend_sqlitedb_is_summary_query (const gchar *query) } static ESExpResult * -func_and (ESExp *f, gint argc, struct _ESExpTerm **argv, gpointer data) +func_and (ESExp *f, + gint argc, + struct _ESExpTerm **argv, + gpointer data) { ESExpResult *r, *r1; GString *string; diff --git a/addressbook/libedata-book/e-book-backend-sync.c b/addressbook/libedata-book/e-book-backend-sync.c index 579b1237e..cb4b15c46 100644 --- a/addressbook/libedata-book/e-book-backend-sync.c +++ b/addressbook/libedata-book/e-book-backend-sync.c @@ -71,6 +71,8 @@ e_book_backend_sync_open (EBookBackendSync *backend, * @error: #GError to set, when something fails * * Creates new contacts with the contents of @vcards in @backend. + * + * Since: 3.4 **/ void e_book_backend_sync_create_contacts (EBookBackendSync *backend, @@ -245,6 +247,8 @@ e_book_backend_sync_remove_contacts (EBookBackendSync *backend, * * Modifies the contacts specified by the IDs embedded in @vcards, to * reflect the full contents of @vcards. + * + * Since: 3.4 **/ void e_book_backend_sync_modify_contacts (EBookBackendSync *backend, diff --git a/addressbook/libedata-book/e-book-backend.c b/addressbook/libedata-book/e-book-backend.c index 0ef4fc5d1..fd576fb22 100644 --- a/addressbook/libedata-book/e-book-backend.c +++ b/addressbook/libedata-book/e-book-backend.c @@ -439,6 +439,8 @@ e_book_backend_refresh (EBookBackend *backend, * Executes a 'create contacts' request specified by @opid on @book * using @backend. * This might be finished with e_data_book_respond_create_contacts(). + * + * Since: 3.4 **/ void e_book_backend_create_contacts (EBookBackend *backend, @@ -503,6 +505,8 @@ e_book_backend_remove_contacts (EBookBackend *backend, * Executes a 'modify contacts' request specified by @opid on @book * using @backend. * This might be finished with e_data_book_respond_modify_contacts(). + * + * Since: 3.4 **/ void e_book_backend_modify_contacts (EBookBackend *backend, diff --git a/addressbook/libedata-book/e-data-book-view.c b/addressbook/libedata-book/e-data-book-view.c index c39bc623f..3c5ed8081 100644 --- a/addressbook/libedata-book/e-data-book-view.c +++ b/addressbook/libedata-book/e-data-book-view.c @@ -239,7 +239,7 @@ notify_change (EDataBookView *view, utf8_vcard = e_util_utf8_make_valid (vcard); utf8_id = e_util_utf8_make_valid (id); - + g_array_append_val (priv->changes, utf8_vcard); g_array_append_val (priv->changes, utf8_id); diff --git a/addressbook/libedata-book/e-data-book.c b/addressbook/libedata-book/e-data-book.c index fa7223159..03d750691 100644 --- a/addressbook/libedata-book/e-data-book.c +++ b/addressbook/libedata-book/e-data-book.c @@ -1011,6 +1011,13 @@ e_data_book_respond_get_contact_list_uids (EDataBook *book, } } +/** + * e_data_book_respond_create_contacts: + * + * FIXME: Document me! + * + * Since: 3.4 + **/ void e_data_book_respond_create_contacts (EDataBook *book, guint32 opid, @@ -1049,6 +1056,13 @@ e_data_book_respond_create_contacts (EDataBook *book, } } +/** + * e_data_book_respond_modify_contacts: + * + * FIXME: Document me! + * + * Since: 3.4 + **/ void e_data_book_respond_modify_contacts (EDataBook *book, guint32 opid, diff --git a/docs/reference/addressbook/libedata-book/libedata-book-sections.txt b/docs/reference/addressbook/libedata-book/libedata-book-sections.txt index a010756a5..1867f9380 100644 --- a/docs/reference/addressbook/libedata-book/libedata-book-sections.txt +++ b/docs/reference/addressbook/libedata-book/libedata-book-sections.txt @@ -25,9 +25,9 @@ e_book_backend_set_backend_property e_book_backend_open e_book_backend_remove e_book_backend_refresh -e_book_backend_create_contact +e_book_backend_create_contacts e_book_backend_remove_contacts -e_book_backend_modify_contact +e_book_backend_modify_contacts e_book_backend_get_contact e_book_backend_get_contact_list e_book_backend_get_contact_list_uids @@ -227,9 +227,9 @@ e_book_backend_sync_remove e_book_backend_sync_refresh e_book_backend_sync_get_backend_property e_book_backend_sync_set_backend_property -e_book_backend_sync_create_contact +e_book_backend_sync_create_contacts e_book_backend_sync_remove_contacts -e_book_backend_sync_modify_contact +e_book_backend_sync_modify_contacts e_book_backend_sync_get_contact e_book_backend_sync_get_contact_list e_book_backend_sync_get_contact_list_uids @@ -265,9 +265,9 @@ e_data_book_respond_remove e_data_book_respond_refresh e_data_book_respond_get_backend_property e_data_book_respond_set_backend_property -e_data_book_respond_create +e_data_book_respond_create_contacts e_data_book_respond_remove_contacts -e_data_book_respond_modify +e_data_book_respond_modify_contacts e_data_book_respond_get_contact e_data_book_respond_get_contact_list e_data_book_respond_get_contact_list_uids diff --git a/docs/reference/addressbook/libedata-book/tmpl/e-book-backend-sync.sgml b/docs/reference/addressbook/libedata-book/tmpl/e-book-backend-sync.sgml index c536c033b..a5f85a22f 100644 --- a/docs/reference/addressbook/libedata-book/tmpl/e-book-backend-sync.sgml +++ b/docs/reference/addressbook/libedata-book/tmpl/e-book-backend-sync.sgml @@ -97,7 +97,7 @@ EBookBackendSync @Returns: -<!-- ##### FUNCTION e_book_backend_sync_create_contact ##### --> +<!-- ##### FUNCTION e_book_backend_sync_create_contacts ##### --> <para> </para> @@ -105,8 +105,8 @@ EBookBackendSync @backend: @book: @cancellable: -@vcard: -@contact: +@vcards: +@added_contacts: @error: @@ -123,7 +123,7 @@ EBookBackendSync @error: -<!-- ##### FUNCTION e_book_backend_sync_modify_contact ##### --> +<!-- ##### FUNCTION e_book_backend_sync_modify_contacts ##### --> <para> </para> @@ -131,8 +131,8 @@ EBookBackendSync @backend: @book: @cancellable: -@vcard: -@contact: +@vcards: +@modified_contacts: @error: diff --git a/docs/reference/addressbook/libedata-book/tmpl/e-book-backend.sgml b/docs/reference/addressbook/libedata-book/tmpl/e-book-backend.sgml index 4e60208f2..7bce73887 100644 --- a/docs/reference/addressbook/libedata-book/tmpl/e-book-backend.sgml +++ b/docs/reference/addressbook/libedata-book/tmpl/e-book-backend.sgml @@ -236,7 +236,7 @@ EBookBackend @cancellable: -<!-- ##### FUNCTION e_book_backend_create_contact ##### --> +<!-- ##### FUNCTION e_book_backend_create_contacts ##### --> <para> </para> @@ -245,7 +245,7 @@ EBookBackend @book: @opid: @cancellable: -@vcard: +@vcards: <!-- ##### FUNCTION e_book_backend_remove_contacts ##### --> @@ -260,7 +260,7 @@ EBookBackend @id_list: -<!-- ##### FUNCTION e_book_backend_modify_contact ##### --> +<!-- ##### FUNCTION e_book_backend_modify_contacts ##### --> <para> </para> @@ -269,7 +269,7 @@ EBookBackend @book: @opid: @cancellable: -@vcard: +@vcards: <!-- ##### FUNCTION e_book_backend_get_contact ##### --> @@ -494,9 +494,9 @@ EBookBackend @remove: @authenticate_user: @refresh: -@create_contact: +@create_contacts: @remove_contacts: -@modify_contact: +@modify_contacts: @get_contact: @get_contact_list: @get_contact_list_uids: diff --git a/docs/reference/addressbook/libedata-book/tmpl/e-data-book-view.sgml b/docs/reference/addressbook/libedata-book/tmpl/e-data-book-view.sgml index cebea0519..85119c10e 100644 --- a/docs/reference/addressbook/libedata-book/tmpl/e-data-book-view.sgml +++ b/docs/reference/addressbook/libedata-book/tmpl/e-data-book-view.sgml @@ -91,6 +91,7 @@ EDataBookView </para> @book_view: +@id: @vcard: diff --git a/docs/reference/addressbook/libedata-book/tmpl/e-data-book.sgml b/docs/reference/addressbook/libedata-book/tmpl/e-data-book.sgml index 7d5576eea..d6c0633b8 100644 --- a/docs/reference/addressbook/libedata-book/tmpl/e-data-book.sgml +++ b/docs/reference/addressbook/libedata-book/tmpl/e-data-book.sgml @@ -167,7 +167,7 @@ EDataBook @error: -<!-- ##### FUNCTION e_data_book_respond_create ##### --> +<!-- ##### FUNCTION e_data_book_respond_create_contacts ##### --> <para> </para> @@ -175,7 +175,7 @@ EDataBook @book: @opid: @error: -@contact: +@contacts: <!-- ##### FUNCTION e_data_book_respond_remove_contacts ##### --> @@ -189,7 +189,7 @@ EDataBook @ids: -<!-- ##### FUNCTION e_data_book_respond_modify ##### --> +<!-- ##### FUNCTION e_data_book_respond_modify_contacts ##### --> <para> </para> @@ -197,7 +197,7 @@ EDataBook @book: @opid: @error: -@contact: +@contacts: <!-- ##### FUNCTION e_data_book_respond_get_contact ##### --> diff --git a/docs/reference/addressbook/libedata-book/tmpl/libedata-book-unused.sgml b/docs/reference/addressbook/libedata-book/tmpl/libedata-book-unused.sgml index 4f9016dd0..e625727ff 100644 --- a/docs/reference/addressbook/libedata-book/tmpl/libedata-book-unused.sgml +++ b/docs/reference/addressbook/libedata-book/tmpl/libedata-book-unused.sgml @@ -312,6 +312,17 @@ e-data-book-types @backend: @Returns: +<!-- ##### FUNCTION e_book_backend_create_contact ##### --> +<para> + +</para> + +@backend: +@book: +@opid: +@cancellable: +@vcard: + <!-- ##### FUNCTION e_book_backend_factory_get_protocol ##### --> <para> @@ -431,6 +442,17 @@ e-data-book-types @only_if_exists: @error: +<!-- ##### FUNCTION e_book_backend_modify_contact ##### --> +<para> + +</para> + +@backend: +@book: +@opid: +@cancellable: +@vcard: + <!-- ##### FUNCTION e_book_backend_notify_connection_status ##### --> <para> @@ -479,6 +501,18 @@ e-data-book-types @backend: @is_online: +<!-- ##### FUNCTION e_book_backend_sync_create_contact ##### --> +<para> + +</para> + +@backend: +@book: +@cancellable: +@vcard: +@contact: +@error: + <!-- ##### FUNCTION e_book_backend_sync_get_changes ##### --> <para> @@ -524,6 +558,18 @@ e-data-book-types @fields: @perror: +<!-- ##### FUNCTION e_book_backend_sync_modify_contact ##### --> +<para> + +</para> + +@backend: +@book: +@cancellable: +@vcard: +@contact: +@error: + <!-- ##### FUNCTION e_data_book_factory_activate ##### --> <para> @@ -644,6 +690,16 @@ e-data-book-types @opid: @error: +<!-- ##### FUNCTION e_data_book_respond_create ##### --> +<para> + +</para> + +@book: +@opid: +@error: +@contact: + <!-- ##### FUNCTION e_data_book_respond_get_book_view ##### --> <para> @@ -694,6 +750,16 @@ e-data-book-types @error: @fields: +<!-- ##### FUNCTION e_data_book_respond_modify ##### --> +<para> + +</para> + +@book: +@opid: +@error: +@contact: + <!-- ##### FUNCTION e_data_book_view_get_listener ##### --> <para> |