From 8cb8d934e6ba8dc93a02455bdf91f1217227a05c Mon Sep 17 00:00:00 2001 From: Matthew Barnes Date: Sat, 28 Aug 2010 21:05:27 -0400 Subject: [PATCH] Add "Since: 2.32" doc tags to new symbols. --- addressbook/libebook/e-book.h | 36 ++++++++++++++++++++++++++++ addressbook/libebook/e-error.h | 10 ++++++++ addressbook/libebook/e-vcard.c | 6 +++++ addressbook/libedata-book/e-book-backend.c | 4 ++++ addressbook/libedata-book/e-data-book-view.c | 5 ++++ addressbook/libedata-book/e-data-book.c | 17 +++++++++++++ addressbook/libedata-book/e-data-book.h | 5 ++++ calendar/libedata-cal/e-cal-backend.c | 4 ++++ calendar/libedata-cal/e-data-cal-view.c | 5 ++++ calendar/libedata-cal/e-data-cal.c | 17 +++++++++++++ calendar/libedata-cal/e-data-cal.h | 5 ++++ camel/camel-debug.h | 2 ++ camel/camel-folder-summary.h | 5 ++++ camel/camel-folder.c | 2 ++ camel/camel-object.h | 10 ++++++++ camel/camel-provider.h | 12 ++++++++++ libedataserver/e-data-server-util.c | 8 +++++++ libedataserverui/e-destination-store.c | 6 +++++ libedataserverui/e-name-selector-entry.c | 5 ++++ libedataserverui/e-name-selector.c | 2 ++ 20 files changed, 166 insertions(+) diff --git a/addressbook/libebook/e-book.h b/addressbook/libebook/e-book.h index 2e5b7d1..608f1dd 100644 --- a/addressbook/libebook/e-book.h +++ b/addressbook/libebook/e-book.h @@ -38,6 +38,12 @@ typedef struct _EBookPrivate EBookPrivate; #ifndef E_BOOK_DISABLE_DEPRECATED typedef void (*EBookCallback) (EBook *book, EBookStatus status, gpointer closure); #endif + +/** + * EBookAsyncCallback: + * + * Since: 2.32 + **/ typedef void (*EBookAsyncCallback) (EBook *book, const GError *error, gpointer closure); typedef void (*EBookOpenProgressCallback) (EBook *book, const gchar *status_message, @@ -50,10 +56,40 @@ typedef void (*EBookListCallback) (EBook *book, EBookStatus status, GList *l typedef void (*EBookBookViewCallback) (EBook *book, EBookStatus status, EBookView *book_view, gpointer closure); typedef void (*EBookEListCallback) (EBook *book, EBookStatus status, EList *list, gpointer closure); #endif + +/** + * EBookIdAsyncCallback: + * + * Since: 2.32 + **/ typedef void (*EBookIdAsyncCallback) (EBook *book, const GError *error, const gchar *id, gpointer closure); + +/** + * EBookContactAsyncCallback: + * + * Since: 2.32 + **/ typedef void (*EBookContactAsyncCallback) (EBook *book, const GError *error, EContact *contact, gpointer closure); + +/** + * EBookListAsyncCallback: + * + * Since: 2.32 + **/ typedef void (*EBookListAsyncCallback) (EBook *book, const GError *error, GList *list, gpointer closure); + +/** + * EBookBookViewAsyncCallback: + * + * Since: 2.32 + **/ typedef void (*EBookBookViewAsyncCallback) (EBook *book, const GError *error, EBookView *book_view, gpointer closure); + +/** + * EBookEListAsyncCallback: + * + * Since: 2.32 + **/ typedef void (*EBookEListAsyncCallback) (EBook *book, const GError *error, EList *list, gpointer closure); struct _EBook { diff --git a/addressbook/libebook/e-error.h b/addressbook/libebook/e-error.h index c4addae..0a4d453 100644 --- a/addressbook/libebook/e-error.h +++ b/addressbook/libebook/e-error.h @@ -24,6 +24,11 @@ return FALSE; \ }; }G_STMT_END +/** + * e_return_async_error_if_fail: + * + * Since: 2.32 + **/ #define e_return_async_error_if_fail(expr, error) G_STMT_START { \ if G_LIKELY (expr) {} else { \ g_log (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL, \ @@ -59,6 +64,11 @@ } \ } G_STMT_END +/** + * e_return_ex_async_error_val_if_fail: + * + * Since: 2.32 + **/ #define e_return_ex_async_error_val_if_fail(expr, error) G_STMT_START { \ if G_LIKELY (expr) {} else { \ GError *err; \ diff --git a/addressbook/libebook/e-vcard.c b/addressbook/libebook/e-vcard.c index 1221020..7a75d54 100644 --- a/addressbook/libebook/e-vcard.c +++ b/addressbook/libebook/e-vcard.c @@ -1141,6 +1141,8 @@ e_vcard_remove_attribute (EVCard *evc, EVCardAttribute *attr) * @attr: an #EVCardAttribute to append * * Appends @attr to @evc to the end of a list of attributes. + * + * Since: 2.32 **/ void e_vcard_append_attribute (EVCard *evc, EVCardAttribute *attr) @@ -1159,6 +1161,8 @@ e_vcard_append_attribute (EVCard *evc, EVCardAttribute *attr) * * Appends @attr to @evcard, setting it to @value. * For attribute addition is used e_vcard_append_attribute(). + * + * Since: 2.32 **/ void e_vcard_append_attribute_with_value (EVCard *evcard, @@ -1180,6 +1184,8 @@ e_vcard_append_attribute_with_value (EVCard *evcard, * * Appends @attr to @evcard, assigning the list of values to it. * For attribute addition is used e_vcard_append_attribute(). + * + * Since: 2.32 **/ void e_vcard_append_attribute_with_values (EVCard *evcard, EVCardAttribute *attr, ...) diff --git a/addressbook/libedata-book/e-book-backend.c b/addressbook/libedata-book/e-book-backend.c index 59ca595..4357905 100644 --- a/addressbook/libedata-book/e-book-backend.c +++ b/addressbook/libedata-book/e-book-backend.c @@ -200,6 +200,8 @@ e_book_backend_init (EBookBackend *backend) * Returns the cache directory for the given backend. * * Returns: the cache directory for the backend + * + * Since: 2.32 **/ const gchar * e_book_backend_get_cache_dir (EBookBackend *backend) @@ -219,6 +221,8 @@ e_book_backend_get_cache_dir (EBookBackend *backend) * Note that #EBookBackend is initialized with a usable default based on * the #ESource given to e_book_backend_load_source(). Backends should * not override the default without good reason. + * + * Since: 2.32 **/ void e_book_backend_set_cache_dir (EBookBackend *backend, diff --git a/addressbook/libedata-book/e-data-book-view.c b/addressbook/libedata-book/e-data-book-view.c index 73b402e..6aa6cd3 100644 --- a/addressbook/libedata-book/e-data-book-view.c +++ b/addressbook/libedata-book/e-data-book-view.c @@ -76,6 +76,11 @@ e_data_book_view_class_init (EDataBookViewClass *klass) object_class->finalize = e_data_book_view_finalize; } +/** + * e_data_book_view_register_gdbus_object: + * + * Since: 2.32 + **/ guint e_data_book_view_register_gdbus_object (EDataBookView *query, GDBusConnection *connection, const gchar *object_path, GError **error) { diff --git a/addressbook/libedata-book/e-data-book.c b/addressbook/libedata-book/e-data-book.c index 284a03f..c578ccf 100644 --- a/addressbook/libedata-book/e-data-book.c +++ b/addressbook/libedata-book/e-data-book.c @@ -155,6 +155,11 @@ op_new (OperationID op, EDataBook *book, GDBusMethodInvocation *invocation) return data; } +/** + * e_data_book_status_to_string: + * + * Since: 2.32 + **/ const gchar * e_data_book_status_to_string (EDataBookStatus status) { @@ -237,6 +242,11 @@ e_data_book_error_quark (void) return (GQuark) quark_volatile; } +/** + * e_data_book_create_error: + * + * Since: 2.32 + **/ GError * e_data_book_create_error (EDataBookStatus status, const gchar *custom_msg) { @@ -246,6 +256,11 @@ e_data_book_create_error (EDataBookStatus status, const gchar *custom_msg) return g_error_new_literal (E_DATA_BOOK_ERROR, status, custom_msg ? custom_msg : e_data_book_status_to_string (status)); } +/** + * e_data_book_create_error_fmt: + * + * Since: 2.32 + **/ GError * e_data_book_create_error_fmt (EDataBookStatus status, const gchar *custom_msg_fmt, ...) { @@ -799,6 +814,8 @@ return_error_and_list (EGdbusBook *gdbus_object, void (* complete_func) (EGdbusB * e_data_book_register_gdbus_object: * * Registers GDBus object of this EDataBook. + * + * Since: 2.32 **/ guint e_data_book_register_gdbus_object (EDataBook *book, GDBusConnection *connection, const gchar *object_path, GError **error) diff --git a/addressbook/libedata-book/e-data-book.h b/addressbook/libedata-book/e-data-book.h index 027f841..d938ec6 100644 --- a/addressbook/libedata-book/e-data-book.h +++ b/addressbook/libedata-book/e-data-book.h @@ -81,6 +81,11 @@ GError *e_data_book_create_error_fmt (EDataBookStatus status, const gchar *custo const gchar *e_data_book_status_to_string (EDataBookStatus status); +/** + * e_return_data_book_error_if_fail: + * + * Since: 2.32 + **/ #define e_return_data_book_error_if_fail(expr, _code) \ G_STMT_START { \ if (G_LIKELY(expr)) { \ diff --git a/calendar/libedata-cal/e-cal-backend.c b/calendar/libedata-cal/e-cal-backend.c index 37da37f..eb2cc0f 100644 --- a/calendar/libedata-cal/e-cal-backend.c +++ b/calendar/libedata-cal/e-cal-backend.c @@ -388,6 +388,8 @@ e_cal_backend_init (ECalBackend *backend) * Returns the cache directory for the given backend. * * Returns: the cache directory for the backend + * + * Since: 2.32 **/ const gchar * e_cal_backend_get_cache_dir (ECalBackend *backend) @@ -407,6 +409,8 @@ e_cal_backend_get_cache_dir (ECalBackend *backend) * Note that #ECalBackend is initialized with a usable default based on * #ECalBackend:source and #ECalBackend:kind properties. Backends should * not override the default without good reason. + * + * Since: 2.32 **/ void e_cal_backend_set_cache_dir (ECalBackend *backend, diff --git a/calendar/libedata-cal/e-data-cal-view.c b/calendar/libedata-cal/e-data-cal-view.c index 8b5121f..bc63d6b 100644 --- a/calendar/libedata-cal/e-data-cal-view.c +++ b/calendar/libedata-cal/e-data-cal-view.c @@ -125,6 +125,11 @@ e_data_cal_view_new (ECalBackend *backend, ECalBackendSExp *sexp) return query; } +/** + * e_data_cal_view_register_gdbus_object: + * + * Since: 2.32 + **/ guint e_data_cal_view_register_gdbus_object (EDataCalView *query, GDBusConnection *connection, const gchar *object_path, GError **error) { diff --git a/calendar/libedata-cal/e-data-cal.c b/calendar/libedata-cal/e-data-cal.c index 088983f..ec1fadb 100644 --- a/calendar/libedata-cal/e-data-cal.c +++ b/calendar/libedata-cal/e-data-cal.c @@ -93,6 +93,11 @@ e_data_cal_error_quark (void) return (GQuark) quark_volatile; } +/** + * e_data_cal_status_to_string: + * + * Since: 2.32 + **/ const gchar * e_data_cal_status_to_string (EDataCalCallStatus status) { @@ -136,6 +141,11 @@ e_data_cal_status_to_string (EDataCalCallStatus status) return _("Other error"); } +/** + * e_data_cal_create_error: + * + * Since: 2.32 + **/ GError * e_data_cal_create_error (EDataCalCallStatus status, const gchar *custom_msg) { @@ -145,6 +155,11 @@ e_data_cal_create_error (EDataCalCallStatus status, const gchar *custom_msg) return g_error_new_literal (E_DATA_CAL_ERROR, status, custom_msg ? custom_msg : e_data_cal_status_to_string (status)); } +/** + * e_data_cal_create_error_fmt: + * + * Since: 2.32 + **/ GError * e_data_cal_create_error_fmt (EDataCalCallStatus status, const gchar *custom_msg_fmt, ...) { @@ -1212,6 +1227,8 @@ e_data_cal_new (ECalBackend *backend, ESource *source) * e_data_cal_register_gdbus_object: * * Registers GDBus object of this EDataCal. + * + * Since: 2.32 **/ guint e_data_cal_register_gdbus_object (EDataCal *cal, GDBusConnection *connection, const gchar *object_path, GError **error) diff --git a/calendar/libedata-cal/e-data-cal.h b/calendar/libedata-cal/e-data-cal.h index 10eefcf..95a4401 100644 --- a/calendar/libedata-cal/e-data-cal.h +++ b/calendar/libedata-cal/e-data-cal.h @@ -70,6 +70,11 @@ GError *e_data_cal_create_error_fmt (EDataCalCallStatus status, const gchar *cus const gchar *e_data_cal_status_to_string (EDataCalCallStatus status); +/** + * e_return_data_cal_error_if_fail: + * + * Since: 2.32 + **/ #define e_return_data_cal_error_if_fail(expr, _code) \ G_STMT_START { \ if (G_LIKELY(expr)) { \ diff --git a/camel/camel-debug.h b/camel/camel-debug.h index c125351..10171d0 100644 --- a/camel/camel-debug.h +++ b/camel/camel-debug.h @@ -52,6 +52,8 @@ void camel_debug_end(void); * success = class->foo (object, some_data, error); * CAMEL_CHECK_GERROR (object, foo, success, error); * return success; + * + * Since: 2.32 */ #define CAMEL_CHECK_GERROR(object, method, expr, error) \ G_STMT_START { \ diff --git a/camel/camel-folder-summary.h b/camel/camel-folder-summary.h index ba2945e..8995cd7 100644 --- a/camel/camel-folder-summary.h +++ b/camel/camel-folder-summary.h @@ -219,6 +219,11 @@ typedef enum _CamelFolderSummaryFlags { CAMEL_SUMMARY_DIRTY = 1<<0 } CamelFolderSummaryFlags; +/** + * CamelFolderSummaryLock: + * + * Since: 2.32 + **/ typedef enum _CamelFolderSummaryLock { CAMEL_FOLDER_SUMMARY_SUMMARY_LOCK, CAMEL_FOLDER_SUMMARY_IO_LOCK, diff --git a/camel/camel-folder.c b/camel/camel-folder.c index 028206a..dedcd58 100644 --- a/camel/camel-folder.c +++ b/camel/camel-folder.c @@ -2265,6 +2265,8 @@ camel_folder_rename (CamelFolder *folder, * @changes: change information for @folder * * Emits the #CamelFolder::changed signal. + * + * Since: 2.32 **/ void camel_folder_changed (CamelFolder *folder, diff --git a/camel/camel-object.h b/camel/camel-object.h index 9757128..77c9834 100644 --- a/camel/camel-object.h +++ b/camel/camel-object.h @@ -53,6 +53,11 @@ (G_TYPE_INSTANCE_GET_CLASS \ ((obj), CAMEL_TYPE_OBJECT, CamelObjectClass)) +/** + * CAMEL_ERROR: + * + * Since: 2.32 + **/ #define CAMEL_ERROR \ (camel_error_quark ()) @@ -78,6 +83,11 @@ typedef enum { CAMEL_PARAM_PERSISTENT = 1 << (G_PARAM_USER_SHIFT + 0) } CamelParamFlags; +/** + * CamelError: + * + * Since: 2.32 + **/ typedef enum { CAMEL_ERROR_GENERIC /* lazy fallback error */ } CamelError; diff --git a/camel/camel-provider.h b/camel/camel-provider.h index 26a07aa..84b3ab0 100644 --- a/camel/camel-provider.h +++ b/camel/camel-provider.h @@ -68,7 +68,19 @@ extern gchar *camel_provider_type_name[CAMEL_NUM_PROVIDER_TYPES]; #define CAMEL_PROVIDER_SUPPORTS_SSL (1 << 5) #define CAMEL_PROVIDER_HAS_LICENSE (1 << 6) #define CAMEL_PROVIDER_DISABLE_SENT_FOLDER (1 << 7) + +/** + * CAMEL_PROVIDER_ALLOW_REAL_TRASH_FOLDER: + * + * Since: 2.32 + **/ #define CAMEL_PROVIDER_ALLOW_REAL_TRASH_FOLDER (1 << 8) + +/** + * CAMEL_PROVIDER_ALLOW_REAL_JUNK_FOLDER: + * + * Since: 2.32 + **/ #define CAMEL_PROVIDER_ALLOW_REAL_JUNK_FOLDER (1 << 9) /* Flags for url_flags. "ALLOW" means the config dialog will let the diff --git a/libedataserver/e-data-server-util.c b/libedataserver/e-data-server-util.c index b2a5a61..9da775d 100644 --- a/libedataserver/e-data-server-util.c +++ b/libedataserver/e-data-server-util.c @@ -44,6 +44,8 @@ * modified or freed. * * Returns: base directory for user-specific, non-essential data + * + * Since: 2.32 **/ const gchar * e_get_user_cache_dir (void) @@ -69,6 +71,8 @@ e_get_user_cache_dir (void) * modified or freed. * * Returns: base directory for user-specific configuration information + * + * Since: 2.32 **/ const gchar * e_get_user_config_dir (void) @@ -94,6 +98,8 @@ e_get_user_config_dir (void) * modified or freed. * * Returns: base directory for user-specific data + * + * Since: 2.32 **/ const gchar * e_get_user_data_dir (void) @@ -543,6 +549,8 @@ e_utf8_strftime (gchar *string, * reused after a thread has terminated, though. * * Returns: A 64-bit integer. + * + * Since: 2.32 */ guint64 e_util_gthread_id (GThread *thread) diff --git a/libedataserverui/e-destination-store.c b/libedataserverui/e-destination-store.c index c84611a..611c0fc 100644 --- a/libedataserverui/e-destination-store.c +++ b/libedataserverui/e-destination-store.c @@ -716,6 +716,12 @@ e_destination_store_get_value (GtkTreeModel *tree_model, } } +/** + * e_destination_store_get_stamp: + * @destination_store: an #EDestinationStore + * + * Since: 2.32 + **/ gint e_destination_store_get_stamp (EDestinationStore *destination_store) { diff --git a/libedataserverui/e-name-selector-entry.c b/libedataserverui/e-name-selector-entry.c index 8a4326a..1445cb0 100644 --- a/libedataserverui/e-name-selector-entry.c +++ b/libedataserverui/e-name-selector-entry.c @@ -2963,6 +2963,11 @@ e_name_selector_entry_set_destination_store (ENameSelectorEntry *name_selector_ setup_destination_store (name_selector_entry); } +/** + * e_name_selector_entry_get_popup_destination: + * + * Since: 2.32 + **/ EDestination * e_name_selector_entry_get_popup_destination (ENameSelectorEntry *name_selector_entry) { diff --git a/libedataserverui/e-name-selector.c b/libedataserverui/e-name-selector.c index ec72835..465da24 100644 --- a/libedataserverui/e-name-selector.c +++ b/libedataserverui/e-name-selector.c @@ -345,6 +345,8 @@ e_name_selector_peek_dialog (ENameSelector *name_selector) * * Shows the associated dialog, and sets the transient parent to the * GtkWindow top-level of "for_transient_widget if set (it should be) + * + * Since: 2.32 **/ void e_name_selector_show_dialog (ENameSelector *name_selector, -- 2.7.4