From bfdc62c9756d07b2ec5f0d1062df6e1f99db9a67 Mon Sep 17 00:00:00 2001 From: Matthew Barnes Date: Sat, 11 Aug 2012 17:38:20 -0400 Subject: [PATCH] Update API documentation. --- calendar/libecal/e-cal-types.h | 3 +- camel/camel-debug.h | 8 +- camel/camel-imapx-server.h | 2 - camel/camel-store.c | 14 +-- camel/camel-vee-data-cache.h | 108 ++++++++++++--------- docs/reference/addressbook/libebook/Makefile.am | 1 + .../addressbook/libebook/libebook-sections.txt | 3 +- .../libedata-book/libedata-book-sections.txt | 1 - docs/reference/calendar/libecal/Makefile.am | 1 + .../calendar/libecal/libecal-sections.txt | 4 + docs/reference/camel/camel-docs.sgml | 1 - docs/reference/camel/camel-sections.txt | 15 +-- .../libedataserver/libedataserver-sections.txt | 4 - .../libedataserverui/libedataserverui-sections.txt | 6 +- 14 files changed, 94 insertions(+), 77 deletions(-) diff --git a/calendar/libecal/e-cal-types.h b/calendar/libecal/e-cal-types.h index 8f554d5..8c181ff 100644 --- a/calendar/libecal/e-cal-types.h +++ b/calendar/libecal/e-cal-types.h @@ -44,8 +44,7 @@ typedef enum { E_CAL_CHANGE_DELETED = 1 << 2 } ECalChangeType; -typedef struct -{ +typedef struct { ECalComponent *comp; ECalChangeType type; } ECalChange; diff --git a/camel/camel-debug.h b/camel/camel-debug.h index 4bb097a..a9027c4 100644 --- a/camel/camel-debug.h +++ b/camel/camel-debug.h @@ -98,9 +98,11 @@ void camel_debug_end (void); #define camel_pointer_tracker_track(ptr) \ (camel_pointer_tracker_track_with_info ((ptr), G_STRFUNC)) -void camel_pointer_tracker_track_with_info (gpointer ptr, const gchar *info); -void camel_pointer_tracker_untrack (gpointer ptr); -void camel_pointer_tracker_dump (void); +void camel_pointer_tracker_track_with_info + (gpointer ptr, + const gchar *info); +void camel_pointer_tracker_untrack (gpointer ptr); +void camel_pointer_tracker_dump (void); G_END_DECLS diff --git a/camel/camel-imapx-server.h b/camel/camel-imapx-server.h index b68bfbd..759c313 100644 --- a/camel/camel-imapx-server.h +++ b/camel/camel-imapx-server.h @@ -267,13 +267,11 @@ gboolean camel_imapx_server_rename_folder struct _IMAPXJobQueueInfo * camel_imapx_server_get_job_queue_info (CamelIMAPXServer *is); - const CamelIMAPXUntaggedRespHandlerDesc* camel_imapx_server_register_untagged_handler (CamelIMAPXServer *is, const gchar *untagged_response, const CamelIMAPXUntaggedRespHandlerDesc *desc); - gboolean camel_imapx_server_command_run (CamelIMAPXServer *is, CamelIMAPXCommand *ic, GCancellable *cancellable, diff --git a/camel/camel-store.c b/camel/camel-store.c index 03eca62..4d4dde0 100644 --- a/camel/camel-store.c +++ b/camel/camel-store.c @@ -1567,14 +1567,14 @@ folder_info_cmp (gconstpointer ap, /** * camel_folder_info_build: * @folders: an array of #CamelFolderInfo - * @namespace: an ignorable prefix on the folder names + * @namespace_: an ignorable prefix on the folder names * @separator: the hieararchy separator character * @short_names: %TRUE if the (short) name of a folder is the part after * the last @separator in the full name. %FALSE if it is the full name. * * This takes an array of folders and attaches them together according * to the hierarchy described by their full_names and @separator. If - * @namespace is non-%NULL, then it will be ignored as a full_name + * @namespace_ is non-%NULL, then it will be ignored as a full_name * prefix, for purposes of comparison. If necessary, * camel_folder_info_build() will create additional #CamelFolderInfo with * %NULL urls to fill in gaps in the tree. The value of @short_names @@ -1587,7 +1587,7 @@ folder_info_cmp (gconstpointer ap, **/ CamelFolderInfo * camel_folder_info_build (GPtrArray *folders, - const gchar *namespace, + const gchar *namespace_, gchar separator, gboolean short_names) { @@ -1596,9 +1596,9 @@ camel_folder_info_build (GPtrArray *folders, gchar *p, *pname; gint i, nlen; - if (!namespace) - namespace = ""; - nlen = strlen (namespace); + if (namespace_ == NULL) + namespace_ = ""; + nlen = strlen (namespace_); qsort (folders->pdata, folders->len, sizeof (folders->pdata[0]), folder_info_cmp); @@ -1612,7 +1612,7 @@ camel_folder_info_build (GPtrArray *folders, /* Now find parents. */ for (i = 0; i < folders->len; i++) { fi = folders->pdata[i]; - if (!strncmp (namespace, fi->full_name, nlen) + if (!strncmp (namespace_, fi->full_name, nlen) && (p = strrchr (fi->full_name + nlen, separator))) { pname = g_strndup (fi->full_name, p - fi->full_name); pfi = g_hash_table_lookup (hash, pname); diff --git a/camel/camel-vee-data-cache.h b/camel/camel-vee-data-cache.h index 3323b66..1416ab9 100644 --- a/camel/camel-vee-data-cache.h +++ b/camel/camel-vee-data-cache.h @@ -86,20 +86,19 @@ G_BEGIN_DECLS typedef struct _CamelVeeSubfolderData CamelVeeSubfolderData; -typedef struct _CamelVeeSubfolderDataPrivate CamelVeeSubfolderDataPrivate; typedef struct _CamelVeeSubfolderDataClass CamelVeeSubfolderDataClass; +typedef struct _CamelVeeSubfolderDataPrivate CamelVeeSubfolderDataPrivate; typedef struct _CamelVeeMessageInfoData CamelVeeMessageInfoData; -typedef struct _CamelVeeMessageInfoDataPrivate CamelVeeMessageInfoDataPrivate; typedef struct _CamelVeeMessageInfoDataClass CamelVeeMessageInfoDataClass; +typedef struct _CamelVeeMessageInfoDataPrivate CamelVeeMessageInfoDataPrivate; typedef struct _CamelVeeDataCache CamelVeeDataCache; -typedef struct _CamelVeeDataCachePrivate CamelVeeDataCachePrivate; typedef struct _CamelVeeDataCacheClass CamelVeeDataCacheClass; +typedef struct _CamelVeeDataCachePrivate CamelVeeDataCachePrivate; struct _CamelVeeSubfolderData { GObject parent; - CamelVeeSubfolderDataPrivate *priv; }; @@ -107,16 +106,19 @@ struct _CamelVeeSubfolderDataClass { GObjectClass parent_class; }; -GType camel_vee_subfolder_data_get_type (void); -CamelVeeSubfolderData * camel_vee_subfolder_data_new (CamelFolder *folder); -CamelFolder * camel_vee_subfolder_data_get_folder (CamelVeeSubfolderData *data); /* returned not reffed */ -const gchar * camel_vee_subfolder_data_get_folder_id (CamelVeeSubfolderData *data); +GType camel_vee_subfolder_data_get_type + (void) G_GNUC_CONST; +CamelVeeSubfolderData * + camel_vee_subfolder_data_new (CamelFolder *folder); +CamelFolder * camel_vee_subfolder_data_get_folder + (CamelVeeSubfolderData *data); +const gchar * camel_vee_subfolder_data_get_folder_id + (CamelVeeSubfolderData *data); /* ----------------------------------------------------------------------- */ struct _CamelVeeMessageInfoData { GObject parent; - CamelVeeMessageInfoDataPrivate *priv; }; @@ -124,21 +126,24 @@ struct _CamelVeeMessageInfoDataClass { GObjectClass parent_class; }; -GType camel_vee_message_info_data_get_type (void); -CamelVeeMessageInfoData * camel_vee_message_info_data_new (CamelVeeSubfolderData *subfolder_data, - const gchar *orig_message_uid); -CamelVeeSubfolderData * camel_vee_message_info_data_get_subfolder_data - (CamelVeeMessageInfoData *data); /* returned not reffed */ -const gchar * camel_vee_message_info_data_get_orig_message_uid - (CamelVeeMessageInfoData *data); -const gchar * camel_vee_message_info_data_get_vee_message_uid - (CamelVeeMessageInfoData *data); +GType camel_vee_message_info_data_get_type + (void) G_GNUC_CONST; +CamelVeeMessageInfoData * + camel_vee_message_info_data_new + (CamelVeeSubfolderData *subfolder_data, + const gchar *orig_message_uid); +CamelVeeSubfolderData * + camel_vee_message_info_data_get_subfolder_data + (CamelVeeMessageInfoData *data); +const gchar * camel_vee_message_info_data_get_orig_message_uid + (CamelVeeMessageInfoData *data); +const gchar * camel_vee_message_info_data_get_vee_message_uid + (CamelVeeMessageInfoData *data); /* ----------------------------------------------------------------------- */ struct _CamelVeeDataCache { GObject parent; - CamelVeeDataCachePrivate *priv; }; @@ -146,35 +151,42 @@ struct _CamelVeeDataCacheClass { GObjectClass parent_class; }; -GType camel_vee_data_cache_get_type (void); -CamelVeeDataCache * camel_vee_data_cache_new (void); -void camel_vee_data_cache_add_subfolder (CamelVeeDataCache *data_cache, - CamelFolder *subfolder); -void camel_vee_data_cache_remove_subfolder (CamelVeeDataCache *data_cache, - CamelFolder *subfolder); -CamelVeeSubfolderData * camel_vee_data_cache_get_subfolder_data (CamelVeeDataCache *data_cache, /* returned is reffed */ - CamelFolder *folder); -gboolean camel_vee_data_cache_contains_message_info_data - (CamelVeeDataCache *data_cache, - CamelFolder *folder, - const gchar *orig_message_uid); -CamelVeeMessageInfoData * camel_vee_data_cache_get_message_info_data /* returned is reffed */ - (CamelVeeDataCache *data_cache, - CamelFolder *folder, - const gchar *orig_message_uid); -CamelVeeMessageInfoData * camel_vee_data_cache_get_message_info_data_by_vuid /* returned is reffed */ - (CamelVeeDataCache *data_cache, - const gchar *vee_message_uid); -void camel_vee_data_cache_foreach_message_info_data - (CamelVeeDataCache *data_cache, - CamelFolder *fromfolder, - void (* func) (CamelVeeMessageInfoData *mi_data, - CamelFolder *subfolder, - gpointer user_data), - gpointer user_data); -void camel_vee_data_cache_remove_message_info_data - (CamelVeeDataCache *data_cache, - CamelVeeMessageInfoData *mi_data); +GType camel_vee_data_cache_get_type (void) G_GNUC_CONST; +CamelVeeDataCache * + camel_vee_data_cache_new (void); +void camel_vee_data_cache_add_subfolder + (CamelVeeDataCache *data_cache, + CamelFolder *subfolder); +void camel_vee_data_cache_remove_subfolder + (CamelVeeDataCache *data_cache, + CamelFolder *subfolder); +CamelVeeSubfolderData * + camel_vee_data_cache_get_subfolder_data + (CamelVeeDataCache *data_cache, + CamelFolder *folder); +gboolean camel_vee_data_cache_contains_message_info_data + (CamelVeeDataCache *data_cache, + CamelFolder *folder, + const gchar *orig_message_uid); +CamelVeeMessageInfoData * + camel_vee_data_cache_get_message_info_data + (CamelVeeDataCache *data_cache, + CamelFolder *folder, + const gchar *orig_message_uid); +CamelVeeMessageInfoData * + camel_vee_data_cache_get_message_info_data_by_vuid + (CamelVeeDataCache *data_cache, + const gchar *vee_message_uid); +void camel_vee_data_cache_foreach_message_info_data + (CamelVeeDataCache *data_cache, + CamelFolder *fromfolder, + void (* func) (CamelVeeMessageInfoData *mi_data, + CamelFolder *subfolder, + gpointer user_data), + gpointer user_data); +void camel_vee_data_cache_remove_message_info_data + (CamelVeeDataCache *data_cache, + CamelVeeMessageInfoData *mi_data); G_END_DECLS diff --git a/docs/reference/addressbook/libebook/Makefile.am b/docs/reference/addressbook/libebook/Makefile.am index a269cfa..804e101 100644 --- a/docs/reference/addressbook/libebook/Makefile.am +++ b/docs/reference/addressbook/libebook/Makefile.am @@ -15,6 +15,7 @@ HFILE_GLOB = $(top_srcdir)/addressbook/libebook/*.h CFILE_GLOB = $(top_srcdir)/addressbook/libebook/*.c IGNORE_HFILES = \ + e-book-enumtypes.h \ e-book-marshal.h \ e-data-book-bindings.h \ e-data-book-factory-bindings.h \ diff --git a/docs/reference/addressbook/libebook/libebook-sections.txt b/docs/reference/addressbook/libebook/libebook-sections.txt index aeaed44..40c2b06 100644 --- a/docs/reference/addressbook/libebook/libebook-sections.txt +++ b/docs/reference/addressbook/libebook/libebook-sections.txt @@ -388,7 +388,7 @@ EVC_X_TTYTDD EVC_X_VIDEO_URL EVC_X_WANTS_HTML EVC_X_YAHOO -EVC_X_BOOK_URI +EVC_X_BOOK_UID EVC_CONTACT_LIST EVC_PARENT_CL EVC_CL_UID @@ -442,6 +442,7 @@ e_book_query_get_type E_BOOK_ERROR e_book_error_quark EBookStatus +EDataBookStatus E_BOOK_ERROR_CORBA_EXCEPTION EBookViewStatus EBookChangeType diff --git a/docs/reference/addressbook/libedata-book/libedata-book-sections.txt b/docs/reference/addressbook/libedata-book/libedata-book-sections.txt index 902978d..c68fc1e 100644 --- a/docs/reference/addressbook/libedata-book/libedata-book-sections.txt +++ b/docs/reference/addressbook/libedata-book/libedata-book-sections.txt @@ -92,7 +92,6 @@ e_book_backend_cache_get_type
e-book-backend-db-cache e_book_backend_db_cache_get_contact -string_to_dbt e_book_backend_db_cache_get_filename e_book_backend_db_cache_set_filename e_book_backend_db_cache_add_contact diff --git a/docs/reference/calendar/libecal/Makefile.am b/docs/reference/calendar/libecal/Makefile.am index 1375ee9..22a0530 100644 --- a/docs/reference/calendar/libecal/Makefile.am +++ b/docs/reference/calendar/libecal/Makefile.am @@ -15,6 +15,7 @@ HFILE_GLOB = $(top_srcdir)/calendar/libecal/*.h CFILE_GLOB = $(top_srcdir)/calendar/libecal/*.c IGNORE_HFILES = \ + e-cal-enumtypes.h \ e-cal-marshal.h \ e-data-cal-bindings.h \ e-data-cal-factory-bindings.h \ diff --git a/docs/reference/calendar/libecal/libecal-sections.txt b/docs/reference/calendar/libecal/libecal-sections.txt index fbc7db7..fa071bd 100644 --- a/docs/reference/calendar/libecal/libecal-sections.txt +++ b/docs/reference/calendar/libecal/libecal-sections.txt @@ -431,7 +431,11 @@ tm_to_icaltimetype E_CALENDAR_ERROR e_calendar_error_quark ECalChangeType +ECalChange ECalendarStatus +EDataCalCallStatus +EDataCalObjType +EDataCalObjModType E_CALENDAR_STATUS_CORBA_EXCEPTION
diff --git a/docs/reference/camel/camel-docs.sgml b/docs/reference/camel/camel-docs.sgml index e460fc2..62cf52b 100644 --- a/docs/reference/camel/camel-docs.sgml +++ b/docs/reference/camel/camel-docs.sgml @@ -190,7 +190,6 @@ - diff --git a/docs/reference/camel/camel-sections.txt b/docs/reference/camel/camel-sections.txt index 187948f..f98e997 100644 --- a/docs/reference/camel/camel-sections.txt +++ b/docs/reference/camel/camel-sections.txt @@ -849,7 +849,10 @@ camel_imapx_server_create_folder camel_imapx_server_delete_folder camel_imapx_server_rename_folder camel_imapx_server_get_job_queue_info -camel_imapx_server_set_extended_token_handler +CamelIMAPXUntaggedRespHandler +CamelIMAPXUntaggedRespHandlerDesc +camel_imapx_server_register_untagged_handler +camel_imapx_server_command_run CAMEL_IMAPX_SERVER CAMEL_IS_IMAPX_SERVER @@ -2227,11 +2230,6 @@ camel_sasl_get_type
-camel-search-sql -camel_sexp_to_sql -
- -
camel-search-sql-sexp camel_sexp_to_sql_sexp
@@ -2930,6 +2928,7 @@ camel_vee_data_cache_new camel_vee_data_cache_add_subfolder camel_vee_data_cache_remove_subfolder camel_vee_data_cache_get_subfolder_data +camel_vee_data_cache_contains_message_info_data camel_vee_data_cache_get_message_info_data camel_vee_data_cache_get_message_info_data_by_vuid camel_vee_data_cache_foreach_message_info_data @@ -3112,6 +3111,10 @@ camel_debug camel_debug_start camel_debug_end CAMEL_CHECK_GERROR +camel_pointer_tracker_track +camel_pointer_tracker_track_with_info +camel_pointer_tracker_untrack +camel_pointer_tracker_dump
diff --git a/docs/reference/libedataserver/libedataserver-sections.txt b/docs/reference/libedataserver/libedataserver-sections.txt index a139671..b4efe04 100644 --- a/docs/reference/libedataserver/libedataserver-sections.txt +++ b/docs/reference/libedataserver/libedataserver-sections.txt @@ -1151,10 +1151,6 @@ e_util_get_localedir e_util_replace_prefix e_data_server_util_get_dbus_call_timeout e_data_server_util_set_dbus_call_timeout -e_pointer_tracker_track -e_pointer_tracker_track_with_info -e_pointer_tracker_untrack -e_pointer_tracker_dump
diff --git a/docs/reference/libedataserverui/libedataserverui-sections.txt b/docs/reference/libedataserverui/libedataserverui-sections.txt index 9ed8a3c..cf5906a 100644 --- a/docs/reference/libedataserverui/libedataserverui-sections.txt +++ b/docs/reference/libedataserverui/libedataserverui-sections.txt @@ -241,12 +241,14 @@ e_name_selector_dialog_get_type
e-name-selector-entry ENameSelectorEntry -MINIMUM_QUERY_LENGTH -FORCE_SHOW_ADDRESS ENameSelectorEntry e_name_selector_entry_new e_name_selector_entry_get_registry e_name_selector_entry_set_registry +e_name_selector_entry_get_minimum_query_length +e_name_selector_entry_set_minimum_query_length +e_name_selector_entry_get_show_address +e_name_selector_entry_set_show_address e_name_selector_entry_peek_contact_store e_name_selector_entry_set_contact_store e_name_selector_entry_peek_destination_store -- 2.7.4