From: Matthew Barnes Date: Sat, 2 Mar 2013 16:35:26 +0000 (-0500) Subject: Update API documentation. X-Git-Tag: upstream/3.7.91~1 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=ec84c10bf5bf6530b43a64f699ece9440ad3f53f;p=platform%2Fupstream%2Fevolution-data-server.git Update API documentation. --- diff --git a/addressbook/libebook-contacts/e-book-contacts-types.c b/addressbook/libebook-contacts/e-book-contacts-types.c index 5c5f64e..6eaa695 100644 --- a/addressbook/libebook-contacts/e-book-contacts-types.c +++ b/addressbook/libebook-contacts/e-book-contacts-types.c @@ -10,6 +10,7 @@ G_DEFINE_QUARK (e-book-client-error-quark, e_book_client_error) /** * e_book_client_error_to_string: + * @code: an #EBookClientError code * * FIXME: Document me. * diff --git a/addressbook/libebook-contacts/e-contact.h b/addressbook/libebook-contacts/e-contact.h index e8cf418..faea7c3 100644 --- a/addressbook/libebook-contacts/e-contact.h +++ b/addressbook/libebook-contacts/e-contact.h @@ -260,6 +260,8 @@ typedef struct { /** * EContactGeo: + * @latitude: latitude + * @longitude: longitude * * Since: 1.12 **/ diff --git a/addressbook/libebook-contacts/e-phone-number.h b/addressbook/libebook-contacts/e-phone-number.h index cba7559..023ca20 100644 --- a/addressbook/libebook-contacts/e-phone-number.h +++ b/addressbook/libebook-contacts/e-phone-number.h @@ -174,15 +174,15 @@ typedef enum { /** * EPhoneNumberCountrySource: - * @E_PHONE_NUMBER_COUNTRY_FROM_FQTN: the EPhoneNumber was build from a - * fully qualified telephone number that contained a valid country - * calling code - * @E_PHONE_NUMBER_COUNTRY_FROM_IDD: the parsed phone number started - * with the current locale's international call prefix, followed by a - * valid country calling code - * @E_PHONE_NUMBER_COUNTRY_FROM_DEFAULT: the parsed phone didn't start - * with a (recognizable) country calling code, the code was chosen by - * checking the current locale settings + * @E_PHONE_NUMBER_COUNTRY_FROM_FQTN: + * the EPhoneNumber was build from a fully qualified telephone number + * that contained a valid country calling code + * @E_PHONE_NUMBER_COUNTRY_FROM_IDD: + * the parsed phone number started with the current locale's international + * call prefix, followed by a valid country calling code + * @E_PHONE_NUMBER_COUNTRY_FROM_DEFAULT: + * the parsed phone didn't start with a (recognizable) country calling code, + * the code was chosen by checking the current locale settings * * The origin of a parsed EPhoneNumber's country calling code. * @@ -196,6 +196,7 @@ typedef enum { /** * EPhoneNumber: + * * This opaque type describes a parsed phone number. It can be copied using * e_phone_number_copy(). To release it call e_phone_number_free(). * diff --git a/addressbook/libebook-contacts/e-vcard.c b/addressbook/libebook-contacts/e-vcard.c index bae956d..ab0eafb 100644 --- a/addressbook/libebook-contacts/e-vcard.c +++ b/addressbook/libebook-contacts/e-vcard.c @@ -39,8 +39,8 @@ G_DEFINE_TYPE (EVCard, e_vcard, G_TYPE_OBJECT) -/** Encoding used in v-card - * Note: v-card spec defines additional 7BIT 8BIT and X- encoding +/* Encoding used in v-card + * Note: v-card spec defines additional 7BIT 8BIT and X- encoding */ typedef enum { EVC_ENCODING_RAW, /* no encoding */ @@ -845,6 +845,9 @@ e_vcard_construct (EVCard *evc, /** * e_vcard_construct_with_uid: + * @evc: an #EVCard + * @str: a vCard string + * @uid: a unique ID string * * FIXME: Document me! * diff --git a/addressbook/libebook-contacts/e-vcard.h b/addressbook/libebook-contacts/e-vcard.h index 6bf72c7..c3d475c 100644 --- a/addressbook/libebook-contacts/e-vcard.h +++ b/addressbook/libebook-contacts/e-vcard.h @@ -117,6 +117,7 @@ G_BEGIN_DECLS /** * EVC_X_TWITTER: + * * Twitter name(s). * * Since: 3.6 diff --git a/addressbook/libebook/e-book-client-view.c b/addressbook/libebook/e-book-client-view.c index 38d33a9..bd70369 100644 --- a/addressbook/libebook/e-book-client-view.c +++ b/addressbook/libebook/e-book-client-view.c @@ -795,8 +795,8 @@ e_book_client_view_class_init (EBookClientViewClass *class) PROP_CLIENT, g_param_spec_object ( "client", + "Client", "The EBookClient for the view", - NULL, E_TYPE_BOOK_CLIENT, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | diff --git a/addressbook/libebook/e-book-client.c b/addressbook/libebook/e-book-client.c index 07eceda..3504569 100644 --- a/addressbook/libebook/e-book-client.c +++ b/addressbook/libebook/e-book-client.c @@ -1212,8 +1212,10 @@ e_book_client_new (ESource *source, /** * e_book_client_connect_direct_sync: - * @source: An #ESource pointer - * @error: A #GError pointer + * @registry: an #ESourceRegistry + * @source: an #ESource + * @cancellable: optional #GCancellable object, or %NULL + * @error: return location for a #GError, or %NULL * * Like e_book_client_connect_sync(), except creates the book client for * direct read access to the underlying addressbook. diff --git a/addressbook/libebook/e-book-client.h b/addressbook/libebook/e-book-client.h index aca1004..8977341 100644 --- a/addressbook/libebook/e-book-client.h +++ b/addressbook/libebook/e-book-client.h @@ -238,7 +238,7 @@ void e_book_client_get_contacts (EBookClient *client, gboolean e_book_client_get_contacts_finish (EBookClient *client, GAsyncResult *result, - GSList **contacts, + GSList **out_contacts, GError **error); gboolean e_book_client_get_contacts_sync (EBookClient *client, const gchar *sexp, diff --git a/addressbook/libebook/e-book.c b/addressbook/libebook/e-book.c index 3798942..8b25fd1 100644 --- a/addressbook/libebook/e-book.c +++ b/addressbook/libebook/e-book.c @@ -2092,6 +2092,8 @@ e_book_cancel (EBook *book, /** * e_book_cancel_async_op: + * @book: an #EBook + * @error: return location for a #GError, or %NULL * * Similar to above e_book_cancel function, only cancels last, still running, * asynchronous operation. diff --git a/addressbook/libebook/e-book.h b/addressbook/libebook/e-book.h index 3d920d1..fb00827 100644 --- a/addressbook/libebook/e-book.h +++ b/addressbook/libebook/e-book.h @@ -43,6 +43,9 @@ typedef void (*EBookCallback) (EBook *book, EBookStatus status, gpointer closure /** * EBookAsyncCallback: + * @book: an #EBook + * @error: a #GError or %NULL + * @closure: the callback closure * * Since: 2.32 **/ @@ -50,6 +53,10 @@ typedef void (*EBookAsyncCallback) (EBook *book, const GError *error, gpointer c /** * EBookOpenProgressCallback: + * @book: an #EBook + * @status_message: a status message + * @percent: percent complete (0 - 100) + * @closure: the callback closure * * Since: 2.32 **/ @@ -65,6 +72,10 @@ typedef void (*EBookEListCallback) (EBook *book, EBookStatus status, EList *li /** * EBookIdAsyncCallback: + * @book: an #EBook + * @error: a #GError or %NULL + * @id: a contact ID + * @closure: the callback closure * * Since: 2.32 **/ @@ -72,6 +83,10 @@ typedef void (*EBookIdAsyncCallback) (EBook *book, const GError *error, co /** * EBookContactAsyncCallback: + * @book: an #EBook + * @error: a #GError or %NULL + * @contact: an #EContact or %NULL + * @closure: the callback closure * * Since: 2.32 **/ @@ -79,6 +94,10 @@ typedef void (*EBookContactAsyncCallback) (EBook *book, const GError *error, EC /** * EBookListAsyncCallback: + * @book: an #EBook + * @error: a #GError or %NULL + * @list: a #GList of results + * @closure: the callback closure * * Since: 2.32 **/ @@ -86,6 +105,10 @@ typedef void (*EBookListAsyncCallback) (EBook *book, const GError *error, GL /** * EBookBookViewAsyncCallback: + * @book: an #EBook + * @error: a #GError or %NULL + * @book_view: an #EBookView + * @closure: the callback closure * * Since: 2.32 **/ @@ -93,6 +116,10 @@ typedef void (*EBookBookViewAsyncCallback) (EBook *book, const GError *error, EB /** * EBookEListAsyncCallback: + * @book: an #EBook + * @error: a #GError or %NULL + * @list: an #EList of results + * @closure: the callback closure * * Since: 2.32 **/ diff --git a/addressbook/libebook/e-error.h b/addressbook/libebook/e-error.h index 16666a0..0c5655c 100644 --- a/addressbook/libebook/e-error.h +++ b/addressbook/libebook/e-error.h @@ -4,6 +4,8 @@ /** * e_return_error_if_fail: + * @expr: the expression to check + * @error_code: the error code to set if @expr fails * * FIXME Document me! * @@ -31,6 +33,8 @@ /** * e_return_async_error_if_fail: + * @expr: the expression to check + * @error: a #GError * * Since: 2.32 **/ @@ -71,6 +75,8 @@ /** * e_return_ex_async_error_val_if_fail: + * @expr: the expression to check + * @error: a #GError * * Since: 2.32 **/ diff --git a/docs/reference/addressbook/libebook-contacts/Makefile.am b/docs/reference/addressbook/libebook-contacts/Makefile.am index b54bdd3..2124e72 100644 --- a/docs/reference/addressbook/libebook-contacts/Makefile.am +++ b/docs/reference/addressbook/libebook-contacts/Makefile.am @@ -21,7 +21,8 @@ CFILE_GLOB = $(top_srcdir)/addressbook/libebook-contacts/*.c IGNORE_HFILES = \ e-book-contacts-enumtypes.h \ - e-book-contacts-marshal.h + e-book-contacts-marshal.h \ + e-phone-number-private.h GTKDOC_CFLAGS = \ -I$(top_srcdir) \ diff --git a/docs/reference/addressbook/libebook-contacts/libebook-contacts-sections.txt b/docs/reference/addressbook/libebook-contacts/libebook-contacts-sections.txt index 8fa7582..87b2385 100644 --- a/docs/reference/addressbook/libebook-contacts/libebook-contacts-sections.txt +++ b/docs/reference/addressbook/libebook-contacts/libebook-contacts-sections.txt @@ -58,7 +58,6 @@ EContactAddress EContactDate EContactCert EContact -EContactClass e_contact_new e_contact_new_from_vcard e_contact_new_from_vcard_with_uid @@ -103,27 +102,29 @@ e_contact_vcard_attribute e_contact_field_id e_contact_field_id_from_vcard -EContactPrivate E_CONTACT -E_CONTACT_CLASS -E_CONTACT_GET_CLASS E_IS_CONTACT -E_IS_CONTACT_CLASS E_TYPE_CONTACT +E_CONTACT_CLASS +E_IS_CONTACT_CLASS +E_CONTACT_GET_CLASS E_TYPE_CONTACT_ADDRESS E_TYPE_CONTACT_ATTR_LIST E_TYPE_CONTACT_CERT E_TYPE_CONTACT_DATE E_TYPE_CONTACT_NAME E_TYPE_CONTACT_PHOTO +EContactClass +e_contact_get_type e_contact_address_get_type e_contact_attr_list_get_type e_contact_cert_get_type e_contact_date_get_type e_contact_geo_get_type -e_contact_get_type e_contact_name_get_type e_contact_photo_get_type + +EContactPrivate
@@ -161,16 +162,10 @@ e_phone_number_get_type
-e-phone-number-private -E_PHONE_NUMBER_LOCAL -
- -
e-source-backend-summary-setup ESourceBackendSummarySetup E_SOURCE_EXTENSION_BACKEND_SUMMARY_SETUP ESourceBackendSummarySetup -ESourceBackendSummarySetupClass e_source_backend_summary_setup_get_summary_fields e_source_backend_summary_setup_set_summary_fieldsv e_source_backend_summary_setup_set_summary_fields @@ -178,14 +173,16 @@ e_source_backend_summary_setup_get_indexed_fields e_source_backend_summary_setup_set_indexed_fieldsv e_source_backend_summary_setup_set_indexed_fields -ESourceBackendSummarySetupPrivate -E_IS_SOURCE_BACKEND_SUMMARY_SETUP -E_IS_SOURCE_BACKEND_SUMMARY_SETUP_CLASS E_SOURCE_BACKEND_SUMMARY_SETUP +E_IS_SOURCE_BACKEND_SUMMARY_SETUP +E_TYPE_SOURCE_BACKEND_SUMMARY_SETUP E_SOURCE_BACKEND_SUMMARY_SETUP_CLASS +E_IS_SOURCE_BACKEND_SUMMARY_SETUP_CLASS E_SOURCE_BACKEND_SUMMARY_SETUP_GET_CLASS -E_TYPE_SOURCE_BACKEND_SUMMARY_SETUP +ESourceBackendSummarySetupClass e_source_backend_summary_setup_get_type + +ESourceBackendSummarySetupPrivate
@@ -265,7 +262,6 @@ E_TYPE_VCARD_PARAM_ATTRIBUTE E_VCARD_21_VALID_PROPERTIES E_VCARD_21_VALID_PARAMETERS EVCard -EVCardClass e_vcard_construct e_vcard_construct_with_uid e_vcard_new @@ -321,16 +317,18 @@ e_vcard_unescape_string EVCardAttribute EVCardAttributeParam -EVCardPrivate +E_VCARD E_IS_VCARD -E_IS_VCARD_CLASS E_TYPE_VCARD -E_TYPE_VCARD_ATTRIBUTE -E_VCARD E_VCARD_CLASS +E_IS_VCARD_CLASS E_VCARD_GET_CLASS +E_TYPE_VCARD_ATTRIBUTE +EVCardClass +e_vcard_get_type e_vcard_attribute_get_type e_vcard_attribute_param_get_type -e_vcard_get_type + +EVCardPrivate
diff --git a/docs/reference/addressbook/libebook/libebook-sections.txt b/docs/reference/addressbook/libebook/libebook-sections.txt index 36544e7..e8a9f59 100644 --- a/docs/reference/addressbook/libebook/libebook-sections.txt +++ b/docs/reference/addressbook/libebook/libebook-sections.txt @@ -61,7 +61,6 @@ EBookListAsyncCallback EBookBookViewAsyncCallback EBookEListAsyncCallback EBookCallback -EBookOpenProgressCallback EBookIdCallback EBookEListCallback EBookListCallback @@ -113,13 +112,11 @@ EBookPrivate EBookClient BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS -E_BOOK_CLIENT_ERROR -EBookClientError -e_book_client_error_to_string EBookClient e_book_client_connect_sync e_book_client_connect e_book_client_connect_finish +e_book_client_connect_direct_sync e_book_client_get_self e_book_client_set_self e_book_client_is_self @@ -184,7 +181,6 @@ e_book_client_view_is_running e_book_client_view_set_fields_of_interest e_book_client_view_start e_book_client_view_stop -EBookClientViewFlags e_book_client_view_set_flags E_BOOK_CLIENT_VIEW @@ -204,7 +200,6 @@ EBookClientViewPrivate E_BOOK_ERROR e_book_error_quark EBookStatus -EBookIndexType E_BOOK_ERROR_CORBA_EXCEPTION diff --git a/docs/reference/addressbook/libedata-book/libedata-book-sections.txt b/docs/reference/addressbook/libedata-book/libedata-book-sections.txt index 2561c98..e1e5944 100644 --- a/docs/reference/addressbook/libedata-book/libedata-book-sections.txt +++ b/docs/reference/addressbook/libedata-book/libedata-book-sections.txt @@ -153,13 +153,15 @@ EBookBackendSExpPrivate e-book-backend-sqlitedb EBookBackendSqliteDB EBookBackendSqliteDB +E_BOOK_SDB_ERROR +EBookSDBError EbSdbSearchData e_book_backend_sqlitedb_new e_book_backend_sqlitedb_new_full e_book_backend_sqlitedb_lock_updates e_book_backend_sqlitedb_unlock_updates -e_book_backend_sqlitedb_add_contact -e_book_backend_sqlitedb_add_contacts +e_book_backend_sqlitedb_new_contact +e_book_backend_sqlitedb_new_contacts e_book_backend_sqlitedb_remove_contact e_book_backend_sqlitedb_remove_contacts e_book_backend_sqlitedb_has_contact @@ -189,6 +191,8 @@ e_book_backend_sqlitedb_check_summary_fields e_book_backend_sqlitedb_is_summary_query e_book_backend_sqlitedb_is_summary_fields +e_book_backend_sqlitedb_add_contact +e_book_backend_sqlitedb_add_contacts E_TYPE_BOOK_BACKEND_SQLITEDB E_BOOK_BACKEND_SQLITEDB @@ -198,6 +202,7 @@ E_IS_BOOK_BACKEND_SQLITEDB_CLASS E_BOOK_BACKEND_SQLITEDB_GET_CLASS EBookBackendSqliteDBClass; e_book_backend_sqlitedb_get_type +e_book_backend_sqlitedb_error_quark EBookBackendSqliteDBPrivate diff --git a/docs/reference/camel/camel-sections.txt b/docs/reference/camel/camel-sections.txt index c20be7c..a4c1f0b 100644 --- a/docs/reference/camel/camel-sections.txt +++ b/docs/reference/camel/camel-sections.txt @@ -833,6 +833,7 @@ camel_imapx_job_set_data camel_imapx_job_has_folder camel_imapx_job_ref_folder camel_imapx_job_set_folder +camel_imapx_job_get_cancellable uidset_state @@ -2058,6 +2059,7 @@ CamelOperationPrivate
camel-provider +EDS_CAMEL_PROVIDER_DIR CamelProvider CamelProviderType CamelProviderFlags diff --git a/docs/reference/libebackend/libebackend-sections.txt b/docs/reference/libebackend/libebackend-sections.txt index 763a0a3..6c604bf 100644 --- a/docs/reference/libebackend/libebackend-sections.txt +++ b/docs/reference/libebackend/libebackend-sections.txt @@ -87,6 +87,8 @@ e_backend_get_user_prompter e_backend_trust_prompt_sync e_backend_trust_prompt e_backend_trust_prompt_finish +e_backend_get_destination_address +e_backend_is_destination_reachable E_BACKEND E_IS_BACKEND @@ -398,6 +400,7 @@ EServerSideSourcePrivate e-source-registry-server ESourceRegistryServer E_SOURCE_REGISTRY_SERVER_OBJECT_PATH +EDS_REGISTRY_MODULES ESourceRegistryServer e_source_registry_server_new e_source_registry_server_add_source diff --git a/docs/reference/libedataserver/libedataserver-sections.txt b/docs/reference/libedataserver/libedataserver-sections.txt index 9b663e2..821ebcd 100644 --- a/docs/reference/libedataserver/libedataserver-sections.txt +++ b/docs/reference/libedataserver/libedataserver-sections.txt @@ -539,6 +539,12 @@ E_SOURCE_EXTENSION_GOA e_source_goa_get_account_id e_source_goa_dup_account_id e_source_goa_set_account_id +e_source_goa_get_calendar_url +e_source_goa_dup_calendar_url +e_source_goa_set_calendar_url +e_source_goa_get_contacts_url +e_source_goa_dup_contacts_url +e_source_goa_set_contacts_url E_SOURCE_GOA E_IS_SOURCE_GOA @@ -1070,6 +1076,7 @@ e_source_webdav_dup_soup_uri e_source_webdav_set_soup_uri ETrustPromptResponse e_source_webdav_prepare_ssl_trust_prompt +e_source_webdav_prepare_ssl_trust_prompt_with_parent e_source_webdav_store_ssl_trust_prompt e_source_webdav_unset_temporary_ssl_trust diff --git a/docs/reference/private/libedbus-private-sections.txt b/docs/reference/private/libedbus-private-sections.txt index ffa35f9..7937be3 100644 --- a/docs/reference/private/libedbus-private-sections.txt +++ b/docs/reference/private/libedbus-private-sections.txt @@ -406,6 +406,60 @@ EDBusCalendarFactorySkeletonPrivate
+e-dbus-direct-book +EDBusDirectBook +EDBusDirectBook +e_dbus_direct_book_get_backend_config +e_dbus_direct_book_dup_backend_config +e_dbus_direct_book_set_backend_config +e_dbus_direct_book_get_backend_name +e_dbus_direct_book_dup_backend_name +e_dbus_direct_book_set_backend_name +e_dbus_direct_book_get_backend_path +e_dbus_direct_book_dup_backend_path +e_dbus_direct_book_set_backend_path +e_dbus_direct_book_interface_info +e_dbus_direct_book_override_properties + +EDBusDirectBookProxy +e_dbus_direct_book_proxy_new_sync +e_dbus_direct_book_proxy_new +e_dbus_direct_book_proxy_new_finish +e_dbus_direct_book_proxy_new_for_bus_sync +e_dbus_direct_book_proxy_new_for_bus +e_dbus_direct_book_proxy_new_for_bus_finish + +EDBusDirectBookSkeleton +e_dbus_direct_book_skeleton_new + +E_DBUS_DIRECT_BOOK +E_DBUS_IS_DIRECT_BOOK +E_DBUS_TYPE_DIRECT_BOOK +E_DBUS_DIRECT_BOOK_GET_IFACE +E_DBUS_DIRECT_BOOK_PROXY +E_DBUS_IS_DIRECT_BOOK_PROXY +E_DBUS_TYPE_DIRECT_BOOK_PROXY +E_DBUS_DIRECT_BOOK_PROXY_CLASS +E_DBUS_IS_DIRECT_BOOK_PROXY_CLASS +E_DBUS_DIRECT_BOOK_PROXY_GET_CLASS +E_DBUS_DIRECT_BOOK_SKELETON +E_DBUS_IS_DIRECT_BOOK_SKELETON +E_DBUS_TYPE_DIRECT_BOOK_SKELETON +E_DBUS_DIRECT_BOOK_SKELETON_CLASS +E_DBUS_IS_DIRECT_BOOK_SKELETON_CLASS +E_DBUS_DIRECT_BOOK_SKELETON_GET_CLASS +EDBusDirectBookIface +EDBusDirectBookProxyClass +EDBusDirectBookSkeletonClass +e_dbus_direct_book_get_type +e_dbus_direct_book_proxy_get_type +e_dbus_direct_book_skeleton_get_type + +EDBusDirectBookProxyPrivate +EDBusDirectBookSkeletonPrivate +
+ +
e-dbus-object EDBusObject EDBusObject diff --git a/libedataserver/e-source-mail-signature.c b/libedataserver/e-source-mail-signature.c index e43f8c5..6f20402 100644 --- a/libedataserver/e-source-mail-signature.c +++ b/libedataserver/e-source-mail-signature.c @@ -394,7 +394,7 @@ source_mail_signature_load_thread (GSimpleAsyncResult *simple, * captured as the email signature content. If the signature file is not * executable, the email signature content is read directly from the file. * - * Returns; %TRUE on success, %FALSE on failure + * Returns: %TRUE on success, %FALSE on failure * * Since: 3.6 **/ diff --git a/libedataserver/e-source-refresh.h b/libedataserver/e-source-refresh.h index 019002e..ecadbe1 100644 --- a/libedataserver/e-source-refresh.h +++ b/libedataserver/e-source-refresh.h @@ -79,6 +79,8 @@ struct _ESourceRefreshClass { /** * ESourceRefreshFunc: + * @source: an #ESource + * @user_data: user data provided to the callback function * * Since: 3.6 **/