[evolution-data-server] Add "Since: 2.24" tags to the API documentation.
- From: Matthew Barnes <mbarnes src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [evolution-data-server] Add "Since: 2.24" tags to the API documentation.
- Date: Sun, 14 Mar 2010 15:45:26 +0000 (UTC)
commit 6c0c14006be8800ed210f552211894f0d8d6903b
Author: Matthew Barnes <mbarnes redhat com>
Date: Sun Mar 14 11:31:23 2010 -0400
Add "Since: 2.24" tags to the API documentation.
Also create "Index of new symbols in 2.24" index pages in the table
of contents pages.
addressbook/libebook/e-book.c | 3 +
calendar/libecal/e-cal-check-timezones.c | 46 +++--
.../libedata-cal/e-cal-backend-loader-factory.h | 5 +
calendar/libedata-cal/e-cal-backend-util.c | 2 +
calendar/libedata-cal/e-cal-backend.c | 19 ++
camel/camel-db.c | 246 +++++++++++++++++++-
camel/camel-db.h | 135 +++++++++---
camel/camel-filter-driver.h | 9 -
camel/camel-folder-summary.c | 80 ++++++-
camel/camel-folder-summary.h | 11 +
camel/camel-folder.c | 10 +
camel/camel-folder.h | 5 +
camel/camel-mime-filter-progress.c | 2 +
camel/camel-mime-filter-progress.h | 5 +
camel/camel-mime-part-utils.c | 9 +-
camel/camel-msgport.c | 42 ++++-
camel/camel-msgport.h | 11 +
camel/camel-offline-store.c | 2 +
camel/camel-search-sql.c | 5 +-
camel/camel-stream-vfs.c | 4 +
camel/camel-stream-vfs.h | 17 ++-
camel/camel-string-utils.c | 2 +
camel/camel-trie.c | 10 +
camel/camel-vee-folder.c | 5 +
camel/camel-vee-store.h | 6 +
camel/camel-vee-summary.c | 5 +
camel/camel.c | 5 +
.../addressbook/libebook/libebook-docs.sgml | 4 +
.../libedata-book/libedata-book-docs.sgml | 4 +
docs/reference/calendar/libecal/libecal-docs.sgml | 4 +
.../calendar/libedata-cal/libedata-cal-docs.sgml | 5 +
docs/reference/camel/camel-docs.sgml | 5 +
docs/reference/camel/tmpl/camel-filter-driver.sgml | 30 ---
docs/reference/camel/tmpl/camel-unused.sgml | 27 +++
docs/reference/libebackend/libebackend-docs.xml | 4 +
.../libedataserver/libedataserver-docs.sgml | 4 +
.../libedataserverui/libedataserverui-docs.sgml | 4 +
libedataserver/e-categories.c | 4 +
libedataserver/e-proxy.c | 15 ++
libedataserver/e-proxy.h | 5 +
libedataserver/e-source-group.c | 4 +
libedataserver/e-source.c | 4 +
libedataserverui/e-name-selector-entry.c | 3 +
libedataserverui/e-name-selector-entry.h | 12 +
libedataserverui/e-source-selector.c | 2 +
45 files changed, 734 insertions(+), 107 deletions(-)
---
diff --git a/addressbook/libebook/e-book.c b/addressbook/libebook/e-book.c
index ddf1b8a..9722546 100644
--- a/addressbook/libebook/e-book.c
+++ b/addressbook/libebook/e-book.c
@@ -1605,8 +1605,11 @@ e_book_cancel (EBook *book,
/**
* e_book_cancel_async_op:
+ *
* Similar to above e_book_cancel function, only cancels last, still running,
* asynchronous operation.
+ *
+ * Since: 2.24
**/
gboolean
e_book_cancel_async_op (EBook *book, GError **error)
diff --git a/calendar/libecal/e-cal-check-timezones.c b/calendar/libecal/e-cal-check-timezones.c
index 57003ba..9c55db4 100644
--- a/calendar/libecal/e-cal-check-timezones.c
+++ b/calendar/libecal/e-cal-check-timezones.c
@@ -63,10 +63,15 @@ static const gchar *e_cal_match_location(const gchar *location)
/**
* e_cal_match_tzid:
- * matches a TZID against the system timezone definitions
- * and returns the matching TZID, or NULL if none found
+ * @tzid: a timezone ID
+ *
+ * Matches @tzid against the system timezone definitions
+ * and returns the matching TZID, or %NULL if none found
+ *
+ * Since: 2.24
*/
-const gchar *e_cal_match_tzid(const gchar *tzid)
+const gchar *
+e_cal_match_tzid(const gchar *tzid)
{
const gchar *location;
const gchar *systzid = NULL;
@@ -242,14 +247,17 @@ static void addsystemtz(gpointer key,
* accordingly.
*
* Return value: TRUE if successful, FALSE otherwise.
+ *
+ * Since: 2.24
*/
-gboolean e_cal_check_timezones(icalcomponent *comp,
- GList *comps,
- icaltimezone *(*tzlookup)(const gchar *tzid,
- gconstpointer custom,
- GError **error),
- gconstpointer custom,
- GError **error)
+gboolean
+e_cal_check_timezones (icalcomponent *comp,
+ GList *comps,
+ icaltimezone *(*tzlookup)(const gchar *tzid,
+ gconstpointer custom,
+ GError **error),
+ gconstpointer custom,
+ GError **error)
{
gboolean success = TRUE;
icalcomponent *subcomp = NULL;
@@ -449,10 +457,13 @@ gboolean e_cal_check_timezones(icalcomponent *comp,
*
* An implementation of the tzlookup callback which clients
* can use. Calls #e_cal_get_timezone.
+ *
+ * Since: 2.24
*/
-icaltimezone *e_cal_tzlookup_ecal(const gchar *tzid,
- gconstpointer custom,
- GError **error)
+icaltimezone *
+e_cal_tzlookup_ecal (const gchar *tzid,
+ gconstpointer custom,
+ GError **error)
{
ECal *ecal = (ECal *)custom;
icaltimezone *zone = NULL;
@@ -483,10 +494,13 @@ icaltimezone *e_cal_tzlookup_ecal(const gchar *tzid,
* An implementation of the tzlookup callback which backends
* like the file backend can use. Searches for the timezone
* in the component list.
+ *
+ * Since: 2.24
*/
-icaltimezone *e_cal_tzlookup_icomp(const gchar *tzid,
- gconstpointer custom,
- GError **error)
+icaltimezone *
+e_cal_tzlookup_icomp (const gchar *tzid,
+ gconstpointer custom,
+ GError **error)
{
icalcomponent *icomp = (icalcomponent *)custom;
diff --git a/calendar/libedata-cal/e-cal-backend-loader-factory.h b/calendar/libedata-cal/e-cal-backend-loader-factory.h
index bf13e59..dad38d5 100644
--- a/calendar/libedata-cal/e-cal-backend-loader-factory.h
+++ b/calendar/libedata-cal/e-cal-backend-loader-factory.h
@@ -37,6 +37,11 @@ G_BEGIN_DECLS
typedef struct _ECalBackendLoaderFactoryPrivate ECalBackendLoaderFactoryPrivate;
+/**
+ * ECalBackendLoaderFactory:
+ *
+ * Since: 2.24
+ **/
typedef struct {
ECalBackendFactory parent_object;
} ECalBackendLoaderFactory;
diff --git a/calendar/libedata-cal/e-cal-backend-util.c b/calendar/libedata-cal/e-cal-backend-util.c
index 421d7b8..7e06c5f 100644
--- a/calendar/libedata-cal/e-cal-backend-util.c
+++ b/calendar/libedata-cal/e-cal-backend-util.c
@@ -94,6 +94,8 @@ e_cal_backend_mail_account_is_valid (gchar *user, gchar **name)
* e_cal_backend_status_to_string:
*
* Converts status code to string.
+ *
+ * Since: 2.24
**/
const gchar *
e_cal_backend_status_to_string (GNOME_Evolution_Calendar_CallStatus status)
diff --git a/calendar/libedata-cal/e-cal-backend.c b/calendar/libedata-cal/e-cal-backend.c
index 60b3580..afdb557 100644
--- a/calendar/libedata-cal/e-cal-backend.c
+++ b/calendar/libedata-cal/e-cal-backend.c
@@ -501,6 +501,8 @@ e_cal_backend_get_queries (ECalBackend *backend)
* @query: An #EDataCalView object, previously added with @ref e_cal_backend_add_query.
*
* Removes query from the list of live queries for the backend.
+ *
+ * Since: 2.24
**/
void
e_cal_backend_remove_query (ECalBackend *backend, EDataCalView *query)
@@ -1221,6 +1223,8 @@ match_query_and_notify (EDataCalView *query, const gchar *old_object, const gcha
*
* This methods has to be used before e_cal_backend_notify_view_progress.
* Sets last notified percent value to 0.
+ *
+ * Since: 2.24
**/
void
e_cal_backend_notify_view_progress_start (ECalBackend *backend)
@@ -1413,18 +1417,33 @@ e_cal_backend_notify_object_removed (ECalBackend *backend, const ECalComponentId
g_object_unref (iter);
}
+/**
+ * e_cal_backend_notify_objects_added:
+ *
+ * Since: 2.24
+ **/
void
e_cal_backend_notify_objects_added (ECalBackend *backend, EDataCalView *query, const GList *objects)
{
e_data_cal_view_notify_objects_added (query, objects);
}
+/**
+ * e_cal_backend_notify_objects_removed:
+ *
+ * Since: 2.24
+ **/
void
e_cal_backend_notify_objects_removed (ECalBackend *backend, EDataCalView *query, const GList *ids)
{
e_data_cal_view_notify_objects_removed (query, ids);
}
+/**
+ * e_cal_backend_notify_objects_modified:
+ *
+ * Since: 2.24
+ **/
void
e_cal_backend_notify_objects_modified (ECalBackend *backend, EDataCalView *query, const GList *objects)
{
diff --git a/camel/camel-db.c b/camel/camel-db.c
index 262ec38..fd7674e 100644
--- a/camel/camel-db.c
+++ b/camel/camel-db.c
@@ -392,6 +392,11 @@ cdb_sql_exec (sqlite3 *db, const gchar * stmt, CamelException *ex)
return 0;
}
+/**
+ * camel_db_open:
+ *
+ * Since: 2.24
+ **/
CamelDB *
camel_db_open (const gchar *path, CamelException *ex)
{
@@ -460,6 +465,11 @@ camel_db_clone (CamelDB *cdb, CamelException *ex)
return camel_db_open(cdb->priv->file_name, ex);
}
+/**
+ * camel_db_close:
+ *
+ * Since: 2.24
+ **/
void
camel_db_close (CamelDB *cdb)
{
@@ -471,6 +481,11 @@ camel_db_close (CamelDB *cdb)
}
}
+/**
+ * camel_db_set_collate:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_set_collate (CamelDB *cdb, const gchar *col, const gchar *collate, CamelDBCollate func)
{
@@ -488,24 +503,35 @@ camel_db_set_collate (CamelDB *cdb, const gchar *col, const gchar *collate, Came
return ret;
}
-/* Should this be really exposed ? */
+/**
+ * camel_db_command:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_command (CamelDB *cdb, const gchar *stmt, CamelException *ex)
{
- gint ret;
+ gint ret;
- if (!cdb)
- return TRUE;
- g_mutex_lock (cdb->lock);
+ /* XXX Should this be really exposed ? */
- START(stmt);
- ret = cdb_sql_exec (cdb->db, stmt, ex);
- END;
- g_mutex_unlock (cdb->lock);
+ if (!cdb)
+ return TRUE;
+ g_mutex_lock (cdb->lock);
- return ret;
+ START(stmt);
+ ret = cdb_sql_exec (cdb->db, stmt, ex);
+ END;
+ g_mutex_unlock (cdb->lock);
+
+ return ret;
}
+/**
+ * camel_db_begin_transaction:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_begin_transaction (CamelDB *cdb, CamelException *ex)
{
@@ -520,6 +546,11 @@ camel_db_begin_transaction (CamelDB *cdb, CamelException *ex)
return (cdb_sql_exec (cdb->db, "BEGIN", ex));
}
+/**
+ * camel_db_end_transaction:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_end_transaction (CamelDB *cdb, CamelException *ex)
{
@@ -538,6 +569,11 @@ camel_db_end_transaction (CamelDB *cdb, CamelException *ex)
return ret;
}
+/**
+ * camel_db_abort_transaction:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_abort_transaction (CamelDB *cdb, CamelException *ex)
{
@@ -552,6 +588,11 @@ camel_db_abort_transaction (CamelDB *cdb, CamelException *ex)
return ret;
}
+/**
+ * camel_db_add_to_transaction:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_add_to_transaction (CamelDB *cdb, const gchar *stmt, CamelException *ex)
{
@@ -561,6 +602,11 @@ camel_db_add_to_transaction (CamelDB *cdb, const gchar *stmt, CamelException *ex
return (cdb_sql_exec (cdb->db, stmt, ex));
}
+/**
+ * camel_db_transaction_command:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_transaction_command (CamelDB *cdb, GSList *qry_list, CamelException *ex)
{
@@ -651,6 +697,11 @@ camel_db_count_message_info (CamelDB *cdb, const gchar *query, guint32 *count, C
return ret;
}
+/**
+ * camel_db_count_junk_message_info:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_count_junk_message_info (CamelDB *cdb, const gchar *table_name, guint32 *count, CamelException *ex)
{
@@ -668,6 +719,11 @@ camel_db_count_junk_message_info (CamelDB *cdb, const gchar *table_name, guint32
return ret;
}
+/**
+ * camel_db_count_unread_message_info:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_count_unread_message_info (CamelDB *cdb, const gchar *table_name, guint32 *count, CamelException *ex)
{
@@ -685,6 +741,11 @@ camel_db_count_unread_message_info (CamelDB *cdb, const gchar *table_name, guint
return ret;
}
+/**
+ * camel_db_count_visible_unread_message_info:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_count_visible_unread_message_info (CamelDB *cdb, const gchar *table_name, guint32 *count, CamelException *ex)
{
@@ -702,6 +763,11 @@ camel_db_count_visible_unread_message_info (CamelDB *cdb, const gchar *table_nam
return ret;
}
+/**
+ * camel_db_count_visible_message_info:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_count_visible_message_info (CamelDB *cdb, const gchar *table_name, guint32 *count, CamelException *ex)
{
@@ -719,6 +785,11 @@ camel_db_count_visible_message_info (CamelDB *cdb, const gchar *table_name, guin
return ret;
}
+/**
+ * camel_db_count_junk_not-deleted_message_info:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_count_junk_not_deleted_message_info (CamelDB *cdb, const gchar *table_name, guint32 *count, CamelException *ex)
{
@@ -736,6 +807,11 @@ camel_db_count_junk_not_deleted_message_info (CamelDB *cdb, const gchar *table_n
return ret;
}
+/**
+ * camel_db_count_deleted_message_info:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_count_deleted_message_info (CamelDB *cdb, const gchar *table_name, guint32 *count, CamelException *ex)
{
@@ -753,6 +829,11 @@ camel_db_count_deleted_message_info (CamelDB *cdb, const gchar *table_name, guin
return ret;
}
+/**
+ * camel_db_count_total_message_info:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_count_total_message_info (CamelDB *cdb, const gchar *table_name, guint32 *count, CamelException *ex)
{
@@ -771,6 +852,11 @@ camel_db_count_total_message_info (CamelDB *cdb, const gchar *table_name, guint3
return ret;
}
+/**
+ * camel_db_select:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_select (CamelDB *cdb, const gchar * stmt, CamelDBSelectCB callback, gpointer data, CamelException *ex)
{
@@ -816,6 +902,11 @@ camel_db_select (CamelDB *cdb, const gchar * stmt, CamelDBSelectCB callback, gpo
return ret;
}
+/**
+ * camel_db_create_vfolder:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_create_vfolder (CamelDB *db, const gchar *folder_name, CamelException *ex)
{
@@ -839,6 +930,11 @@ camel_db_create_vfolder (CamelDB *db, const gchar *folder_name, CamelException *
return ret;
}
+/**
+ * camel_db_recreate_vfolder:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_recreate_vfolder (CamelDB *db, const gchar *folder_name, CamelException *ex)
{
@@ -854,6 +950,11 @@ camel_db_recreate_vfolder (CamelDB *db, const gchar *folder_name, CamelException
return camel_db_create_vfolder (db, folder_name, ex);
}
+/**
+ * camel_db_delete_uid_from_vfolder:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_delete_uid_from_vfolder (CamelDB *db, gchar *folder_name, gchar *vuid, CamelException *ex)
{
@@ -869,6 +970,11 @@ camel_db_delete_uid_from_vfolder (CamelDB *db, gchar *folder_name, gchar *vuid,
return ret;
}
+/**
+ * camel_db_delete_uid_from_vfolder_transaction:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_delete_uid_from_vfolder_transaction (CamelDB *db, const gchar *folder_name, const gchar *vuid, CamelException *ex)
{
@@ -953,6 +1059,11 @@ read_uids_callback (gpointer ref, gint ncol, gchar ** cols, gchar ** name)
return 0;
}
+/**
+ * camel_db_get_folder_uids:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_get_folder_uids (CamelDB *db, const gchar *folder_name, const gchar *sort_by, const gchar *collate, GPtrArray *array, CamelException *ex)
{
@@ -967,6 +1078,11 @@ camel_db_get_folder_uids (CamelDB *db, const gchar *folder_name, const gchar *so
return ret;
}
+/**
+ * camel_db_get_folder_junk_uids:
+ *
+ * Since: 2.24
+ **/
GPtrArray *
camel_db_get_folder_junk_uids (CamelDB *db, gchar *folder_name, CamelException *ex)
{
@@ -987,6 +1103,11 @@ camel_db_get_folder_junk_uids (CamelDB *db, gchar *folder_name, CamelException *
return array;
}
+/**
+ * camel_db_get_folder_deleted_uids:
+ *
+ * Since: 2.24
+ **/
GPtrArray *
camel_db_get_folder_deleted_uids (CamelDB *db, gchar *folder_name, CamelException *ex)
{
@@ -1090,6 +1211,11 @@ read_vuids_callback (gpointer ref, gint ncol, gchar ** cols, gchar ** name)
return 0;
}
+/**
+ * camel_db_get_vuids_from_vfolder:
+ *
+ * Since: 2.24
+ **/
GPtrArray *
camel_db_get_vuids_from_vfolder (CamelDB *db, gchar *folder_name, gchar *filter, CamelException *ex)
{
@@ -1119,6 +1245,11 @@ camel_db_get_vuids_from_vfolder (CamelDB *db, gchar *folder_name, gchar *filter,
return array;
}
+/**
+ * camel_db_add_to_vfolder:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_add_to_vfolder (CamelDB *db, gchar *folder_name, gchar *vuid, CamelException *ex)
{
@@ -1134,6 +1265,11 @@ camel_db_add_to_vfolder (CamelDB *db, gchar *folder_name, gchar *vuid, CamelExce
return ret;
}
+/**
+ * camel_db_add_to_vfolder_transaction:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_add_to_vfolder_transaction (CamelDB *db, const gchar *folder_name, const gchar *vuid, CamelException *ex)
{
@@ -1149,6 +1285,11 @@ camel_db_add_to_vfolder_transaction (CamelDB *db, const gchar *folder_name, cons
return ret;
}
+/**
+ * camel_db_create_folders_table:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_create_folders_table (CamelDB *cdb, CamelException *ex)
{
@@ -1354,6 +1495,11 @@ camel_db_get_folder_version (CamelDB *cdb, const gchar *folder_name, CamelExcept
return version;
}
+/**
+ * camel_db_prepare_message_info_table:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_prepare_message_info_table (CamelDB *cdb, const gchar *folder_name, CamelException *ex)
{
@@ -1388,6 +1534,11 @@ camel_db_write_fresh_message_info_record (CamelDB *cdb, const gchar *folder_name
return write_mir (cdb, folder_name, record, ex, FALSE);
}
+/**
+ * camel_db_write_message_info_record:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_write_message_info_record (CamelDB *cdb, const gchar *folder_name, CamelMIRecord *record, CamelException *ex)
{
@@ -1447,6 +1598,11 @@ write_mir (CamelDB *cdb, const gchar *folder_name, CamelMIRecord *record, CamelE
return ret;
}
+/**
+ * camel_db_write_folder_info_record:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_write_folder_info_record (CamelDB *cdb, CamelFIRecord *record, CamelException *ex)
{
@@ -1535,6 +1691,11 @@ read_fir_callback (gpointer ref, gint ncol, gchar ** cols, gchar ** name)
return 0;
}
+/**
+ * camel_db_read_folder_info_record:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_read_folder_info_record (CamelDB *cdb, const gchar *folder_name, CamelFIRecord **record, CamelException *ex)
{
@@ -1548,6 +1709,11 @@ camel_db_read_folder_info_record (CamelDB *cdb, const gchar *folder_name, CamelF
return (ret);
}
+/**
+ * camel_db_read_message_info_record_with_uid:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_read_message_info_record_with_uid (CamelDB *cdb, const gchar *folder_name, const gchar *uid, gpointer p, CamelDBSelectCB read_mir_callback, CamelException *ex)
{
@@ -1561,6 +1727,11 @@ camel_db_read_message_info_record_with_uid (CamelDB *cdb, const gchar *folder_na
return (ret);
}
+/**
+ * camel_db_read_message_info_records:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_read_message_info_records (CamelDB *cdb, const gchar *folder_name, gpointer p, CamelDBSelectCB read_mir_callback, CamelException *ex)
{
@@ -1574,6 +1745,11 @@ camel_db_read_message_info_records (CamelDB *cdb, const gchar *folder_name, gpoi
return (ret);
}
+/**
+ * camel_db_create_deleted_table:
+ *
+ * Since: 2.24
+ **/
static gint
camel_db_create_deleted_table (CamelDB *cdb, CamelException *ex)
{
@@ -1597,6 +1773,11 @@ camel_db_trim_deleted_table (CamelDB *cdb, CamelException *ex)
return ret;
}
+/**
+ * camel_db_delete_uid:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_delete_uid (CamelDB *cdb, const gchar *folder, const gchar *uid, CamelException *ex)
{
@@ -1698,6 +1879,11 @@ cdb_delete_ids (CamelDB *cdb, const gchar * folder_name, GSList *uids, const gch
return ret;
}
+/**
+ * camel_db_delete_uids:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_delete_uids (CamelDB *cdb, const gchar * folder_name, GSList *uids, CamelException *ex)
{
@@ -1718,6 +1904,11 @@ camel_db_delete_vuids (CamelDB *cdb, const gchar * folder_name, const gchar *has
return cdb_delete_ids (cdb, folder_name, uids, hash, "vuid", ex);
}
+/**
+ * camel_db_clear_folder_summary:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_clear_folder_summary (CamelDB *cdb, gchar *folder, CamelException *ex)
{
@@ -1755,6 +1946,11 @@ camel_db_clear_folder_summary (CamelDB *cdb, gchar *folder, CamelException *ex)
return ret;
}
+/**
+ * camel_db_delete_folder:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_delete_folder (CamelDB *cdb, const gchar *folder, CamelException *ex)
{
@@ -1790,6 +1986,11 @@ camel_db_delete_folder (CamelDB *cdb, const gchar *folder, CamelException *ex)
return ret;
}
+/**
+ * camel_db_rename_folder:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_rename_folder (CamelDB *cdb, const gchar *old_folder, const gchar *new_folder, CamelException *ex)
{
@@ -1828,6 +2029,11 @@ camel_db_rename_folder (CamelDB *cdb, const gchar *old_folder, const gchar *new_
return ret;
}
+/**
+ * camel_db_camel_mir_free:
+ *
+ * Since: 2.24
+ **/
void
camel_db_camel_mir_free (CamelMIRecord *record)
{
@@ -1852,12 +2058,22 @@ camel_db_camel_mir_free (CamelMIRecord *record)
}
}
+/**
+ * camel_db_sqlize_string:
+ *
+ * Since: 2.24
+ **/
gchar *
camel_db_sqlize_string (const gchar *string)
{
return sqlite3_mprintf ("%Q", string);
}
+/**
+ * camel_db_free_sqlized_string:
+ *
+ * Since: 2.24
+ **/
void
camel_db_free_sqlized_string (gchar *string)
{
@@ -1879,6 +2095,11 @@ followup_flag TEXT ,
followup_completed_on TEXT ,
followup_due_by TEXT ," */
+/**
+ * camel_db_get_column_name:
+ *
+ * Since: 2.24
+ **/
gchar *
camel_db_get_column_name (const gchar *raw_name)
{
@@ -1913,6 +2134,11 @@ camel_db_get_column_name (const gchar *raw_name)
}
+/**
+ * camel_db_migrate_vfolders_to_14:
+ *
+ * Since: 2.24
+ **/
gint
camel_db_migrate_vfolders_to_14 (CamelDB *cdb, const gchar *folder, CamelException *ex)
{
diff --git a/camel/camel-db.h b/camel/camel-db.h
index 3b3f3df..27a59f8 100644
--- a/camel/camel-db.h
+++ b/camel/camel-db.h
@@ -5,6 +5,11 @@
#include <sqlite3.h>
#include <glib.h>
+/**
+ * CAMEL_DB_FILE:
+ *
+ * Since: 2.24
+ **/
#define CAMEL_DB_FILE "folders.db"
/* Hopefully no one will create a folder named EVO_IN_meM_hAnDlE */
@@ -34,47 +39,110 @@
typedef struct _CamelDBPrivate CamelDBPrivate;
+/**
+ * CamelDBCollate:
+ *
+ * Since: 2.24
+ **/
typedef gint(*CamelDBCollate)(gpointer ,int,gconstpointer ,int,gconstpointer );
+/**
+ * CamelDB:
+ *
+ * Since: 2.24
+ **/
struct _CamelDB {
sqlite3 *db;
GMutex *lock;
CamelDBPrivate *priv;
};
+/**
+ * CAMEL_DB_FREE_CACHE_SIZE:
+ *
+ * Since: 2.24
+ **/
#define CAMEL_DB_FREE_CACHE_SIZE 2 * 1024 * 1024
+
+/**
+ * CAMEL_DB_SLEEP_INTERVAL:
+ *
+ * Since: 2.24
+ **/
#define CAMEL_DB_SLEEP_INTERVAL 1*10*10
+
+/**
+ * CAMEL_DB_RELEASE_SQLITE_MEMORY:
+ *
+ * Since: 2.24
+ **/
#define CAMEL_DB_RELEASE_SQLITE_MEMORY if(!g_getenv("CAMEL_SQLITE_FREE_CACHE")) sqlite3_release_memory(CAMEL_DB_FREE_CACHE_SIZE);
-#define CAMEL_DB_USE_SHARED_CACHE if(g_getenv("CAMEL_SQLITE_SHARED_CACHE")) sqlite3_enable_shared_cache(TRUE);
-/* The extensive DB format, supporting basic searching and sorting
- uid, - Message UID
- flags, - Camel Message info flags
- unread/read, - boolean read/unread status
- deleted, - boolean deleted status
- replied, - boolean replied status
- imp, - boolean important status
- junk, - boolean junk status
- size, - size of the mail
- attachment, boolean attachment status
- dsent, - sent date
- dreceived, - received date
- subject, - subject of the mail
- from, - sender
- to, - recipient
- cc, - CC members
- mlist, - message list headers
- follow-up-flag, - followup flag / also can be queried to see for followup or not
- completed-on-set, - completed date, can be used to see if completed
- due-by, - to see the due by date
- Location - This can be derived from the database location/name. No need to store.
- label, - labels of mails also called as userflags
- usertags, composite string of user tags
- cinfo, content info string - composite string
- bdata, provider specific data
- part, part/references/thread id
-*/
+/**
+ * CAMEL_DB_USE_SHARED_CACHE:
+ *
+ * Since: 2.24
+ **/
+#define CAMEL_DB_USE_SHARED_CACHE if(g_getenv("CAMEL_SQLITE_SHARED_CACHE")) sqlite3_enable_shared_cache(TRUE);
+/**
+ * CamelMIRecord:
+ * @uid:
+ * Message UID
+ * @flags:
+ * Camel Message info flags
+ * @msg_type:
+ * @dirty:
+ * @read:
+ * boolean read status
+ * @deleted:
+ * boolean deleted status
+ * @replied:
+ * boolean replied status
+ * @important:
+ * boolean important status
+ * @junk:
+ * boolean junk status
+ * @attachment:
+ * boolean attachment status
+ * @size:
+ * size of the mail
+ * @dsent:
+ * date sent
+ * @dreceived:
+ * date received
+ * @subject:
+ * subject of the mail
+ * @from:
+ * sender
+ * @to:
+ * recipient
+ * @cc:
+ * CC members
+ * @mlist:
+ * message list headers
+ * @followup_flag:
+ * followup flag / also can be queried to see for followup or not
+ * @followup_completed_on:
+ * completed date, can be used to see if completed
+ * @followup_due_by:
+ * to see the due by date
+ * @part:
+ * part / references / thread id
+ * @labels:
+ * labels of mails also called as userflags
+ * @usertags:
+ * composite string of user tags
+ * @cinfo:
+ * content info string - composite string
+ * @bdata:
+ * provider specific data
+ * @bodystructure:
+ *
+ * The extensive DB format, supporting basic searching and sorting.
+ *
+ * Since: 2.24
+ **/
typedef struct _CamelMIRecord {
gchar *uid;
guint32 flags;
@@ -105,6 +173,11 @@ typedef struct _CamelMIRecord {
gchar *bodystructure;
} CamelMIRecord;
+/**
+ * CamelFIRecord:
+ *
+ * Since: 2.24
+ **/
typedef struct _CamelFIRecord {
gchar *folder_name;
guint32 version;
@@ -121,6 +194,12 @@ typedef struct _CamelFIRecord {
} CamelFIRecord;
typedef struct _CamelDB CamelDB;
+
+/**
+ * CamelDBSelectCB:
+ *
+ * Since: 2.24
+ **/
typedef gint (*CamelDBSelectCB) (gpointer data, gint ncol, gchar **colvalues, gchar **colnames);
CamelDB * camel_db_open (const gchar *path, CamelException *ex);
diff --git a/camel/camel-filter-driver.h b/camel/camel-filter-driver.h
index 82277c1..e1d6116 100644
--- a/camel/camel-filter-driver.h
+++ b/camel/camel-filter-driver.h
@@ -100,15 +100,6 @@ gint camel_filter_driver_filter_mbox (CamelFilterDriver *driver, const
gint camel_filter_driver_filter_folder (CamelFilterDriver *driver, CamelFolder *folder, CamelUIDCache *cache,
GPtrArray *uids, gboolean remove, CamelException *ex);
-#if 0
-/* generate the search query/action string for a filter option */
-void camel_filter_driver_expand_option (CamelFilterDriver *d, GString *s, GString *action, struct filter_option *op);
-
-/* get info about rules (options) */
-gint camel_filter_driver_rule_count (CamelFilterDriver *d);
-struct filter_option *camel_filter_driver_rule_get (CamelFilterDriver *d, gint n);
-#endif
-
G_END_DECLS
#endif /* _CAMEL_FILTER_DRIVER_H */
diff --git a/camel/camel-folder-summary.c b/camel/camel-folder-summary.c
index 3844428..7513bf9 100644
--- a/camel/camel-folder-summary.c
+++ b/camel/camel-folder-summary.c
@@ -410,6 +410,8 @@ camel_folder_summary_index (CamelFolderSummary *s, gint i)
* free'd as appropriate.
*
* Returns: the summary item's uid , or %NULL if @index is out of range
+ *
+ * Since: 2.24
**/
gchar *
camel_folder_summary_uid_from_index (CamelFolderSummary *s, gint i)
@@ -435,6 +437,8 @@ camel_folder_summary_uid_from_index (CamelFolderSummary *s, gint i)
*
*
* Returns: if the uid is present in the summary or not (%TRUE or %FALSE)
+ *
+ * Since: 2.24
**/
gboolean
camel_folder_summary_check_uid (CamelFolderSummary *s, const gchar *uid)
@@ -755,13 +759,20 @@ append_changed_uids (gchar *key, CamelMessageInfoBase *info, GPtrArray *array)
g_ptr_array_add (array, (gpointer)camel_pstring_strdup((camel_message_info_uid(info))));
}
-/* FIXME[disk-summary] sucks, this function returns from memory. We need to
- * have collate or something to get the modified ones from DB and merge */
+/**
+ * camel_folder_summary_get_changed:
+ *
+ * Since: 2.24
+ **/
GPtrArray *
camel_folder_summary_get_changed (CamelFolderSummary *s)
{
GPtrArray *res = g_ptr_array_new();
+ /* FIXME[disk-summary] sucks, this function returns from memory.
+ * We need to have collate or something to get the modified ones
+ * from DB and merge */
+
CAMEL_SUMMARY_LOCK (s, summary_lock);
g_hash_table_foreach (s->loaded_infos, (GHFunc) append_changed_uids, res);
CAMEL_SUMMARY_UNLOCK (s, summary_lock);
@@ -878,6 +889,11 @@ cfs_try_release_memory (CamelFolderSummary *s)
return TRUE;
}
+/**
+ * camel_folder_summary_cache_size:
+ *
+ * Since: 2.24
+ **/
gint
camel_folder_summary_cache_size (CamelFolderSummary *s)
{
@@ -983,6 +999,12 @@ static CamelSessionThreadOps preview_update_ops = {
};
/* end */
+
+/**
+ * camel_folder_summary_reload_from_db:
+ *
+ * Since: 2.24
+ **/
gint
camel_folder_summary_reload_from_db (CamelFolderSummary *s, CamelException *ex)
{
@@ -1086,6 +1108,11 @@ camel_folder_summary_get_flag_cache (CamelFolderSummary *summary)
return p->flag_cache;
}
+/**
+ * camel_folder_summary_load_from_db:
+ *
+ * Since: 2.24
+ **/
gint
camel_folder_summary_load_from_db (CamelFolderSummary *s, CamelException *ex)
{
@@ -1328,6 +1355,11 @@ error:
}
+/**
+ * camel_folder_summary_migrate_infos:
+ *
+ * Since: 2.24
+ **/
gint
camel_folder_summary_migrate_infos(CamelFolderSummary *s)
{
@@ -1567,6 +1599,11 @@ msg_save_preview (const gchar *uid, gpointer value, CamelFolder *folder)
camel_db_write_preview_record (folder->parent_store->cdb_w, folder->full_name, uid, (gchar *)value, NULL);
}
+/**
+ * camel_folder_summary_save_to_db:
+ *
+ * Since: 2.24
+ **/
gint
camel_folder_summary_save_to_db (CamelFolderSummary *s, CamelException *ex)
{
@@ -1646,6 +1683,11 @@ camel_folder_summary_save_to_db (CamelFolderSummary *s, CamelException *ex)
return ret;
}
+/**
+ * camel_folder_summary_header_save_to_db:
+ *
+ * Since: 2.24
+ **/
gint
camel_folder_summary_header_save_to_db (CamelFolderSummary *s, CamelException *ex)
{
@@ -1817,6 +1859,11 @@ exception:
return -1;
}
+/**
+ * camel_folder_summary_header_load_from_db:
+ *
+ * Since: 2.24
+ **/
gint
camel_folder_summary_header_load_from_db (CamelFolderSummary *s, CamelStore *store, const gchar *folder_name, CamelException *ex)
{
@@ -1962,6 +2009,11 @@ camel_folder_summary_add (CamelFolderSummary *s, CamelMessageInfo *info)
CAMEL_SUMMARY_UNLOCK(s, summary_lock);
}
+/**
+ * camel_folder_summary_insert:
+ *
+ * Since: 2.24
+ **/
void
camel_folder_summary_insert (CamelFolderSummary *s, CamelMessageInfo *info, gboolean load)
{
@@ -2305,16 +2357,21 @@ camel_folder_summary_clear(CamelFolderSummary *s)
CAMEL_SUMMARY_UNLOCK(s, summary_lock);
}
-/* FIXME: This is non-sense. Neither an exception is passed,
-nor a value returned. How is the caller supposed to know,
-whether the operation is succesful */
-
+/**
+ * camel_folder_summary_clear_db:
+ *
+ * Since: 2.24
+ **/
void
camel_folder_summary_clear_db (CamelFolderSummary *s)
{
CamelDB *cdb;
gchar *folder_name;
+ /* FIXME: This is non-sense. Neither an exception is passed,
+ nor a value returned. How is the caller supposed to know,
+ whether the operation is succesful */
+
d(printf ("\ncamel_folder_summary_load_from_db called \n"));
s->flags &= ~CAMEL_SUMMARY_DIRTY;
@@ -2432,6 +2489,12 @@ camel_folder_summary_remove_uid(CamelFolderSummary *s, const gchar *uid)
}
/* _fast doesn't deal with db and leaves it to the caller. */
+
+/**
+ * camel_folder_summary_remove_uid_fast:
+ *
+ * Since: 2.24
+ **/
void
camel_folder_summary_remove_uid_fast (CamelFolderSummary *s, const gchar *uid)
{
@@ -2461,6 +2524,11 @@ camel_folder_summary_remove_uid_fast (CamelFolderSummary *s, const gchar *uid)
}
}
+/**
+ * camel_folder_summary_remove_index_fast:
+ *
+ * Since: 2.24
+ **/
void
camel_folder_summary_remove_index_fast (CamelFolderSummary *s, gint index)
{
diff --git a/camel/camel-folder-summary.h b/camel/camel-folder-summary.h
index 463aeac..98629b5 100644
--- a/camel/camel-folder-summary.h
+++ b/camel/camel-folder-summary.h
@@ -449,6 +449,9 @@ time_t camel_message_info_time(const CamelMessageInfo *mi, gint id);
/**
* camel_message_info_preview:
+ * @mi: a #CamelMessageInfo
+ *
+ * FIXME Document me!
*
* Since: 2.28
**/
@@ -470,6 +473,14 @@ time_t camel_message_info_time(const CamelMessageInfo *mi, gint id);
#define camel_message_info_user_flags(mi) ((const CamelFlag *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_USER_FLAGS))
#define camel_message_info_user_tags(mi) ((const CamelTag *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_USER_TAGS))
+/**
+ * camel_message_info_headers:
+ * @mi: a #CamelMessageInfo
+ *
+ * FIXME Document me!
+ *
+ * Since: 2.24
+ **/
#define camel_message_info_headers(mi) ((const struct _camel_header_param *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_HEADERS))
/**
diff --git a/camel/camel-folder.c b/camel/camel-folder.c
index b888ed9..26da733 100644
--- a/camel/camel-folder.c
+++ b/camel/camel-folder.c
@@ -1316,6 +1316,8 @@ sort_uids (CamelFolder *folder, GPtrArray *uids)
* @uids: array of uids
*
* Sorts the array of UIDs.
+ *
+ * Since: 2.24
**/
void
camel_folder_sort_uids (CamelFolder *folder, GPtrArray *uids)
@@ -1831,6 +1833,8 @@ get_quota_info (CamelFolder *folder)
* @folder: a #CamelFolder object
*
* Returns: list of known quota(s) for the folder.
+ *
+ * Since: 2.24
**/
CamelFolderQuotaInfo *
camel_folder_get_quota_info (CamelFolder *folder)
@@ -1848,6 +1852,8 @@ camel_folder_get_quota_info (CamelFolder *folder)
*
* Returns: newly allocated #CamelFolderQuotaInfo structure with
* initialized values based on the parameters, with next member set to NULL.
+ *
+ * Since: 2.24
**/
CamelFolderQuotaInfo *
camel_folder_quota_info_new (const gchar *name, guint64 used, guint64 total)
@@ -1868,6 +1874,8 @@ camel_folder_quota_info_new (const gchar *name, guint64 used, guint64 total)
* @info: a #CamelFolderQuotaInfo object to clone.
*
* Makes a copy of the given info and all next-s.
+ *
+ * Since: 2.24
**/
CamelFolderQuotaInfo *
camel_folder_quota_info_clone (const CamelFolderQuotaInfo *info)
@@ -1894,6 +1902,8 @@ camel_folder_quota_info_clone (const CamelFolderQuotaInfo *info)
* @info: a #CamelFolderQuotaInfo object to free.
*
* Frees this and all next objects.
+ *
+ * Since: 2.24
**/
void
camel_folder_quota_info_free (CamelFolderQuotaInfo *info)
diff --git a/camel/camel-folder.h b/camel/camel-folder.h
index 5fbe52e..26bc55c 100644
--- a/camel/camel-folder.h
+++ b/camel/camel-folder.h
@@ -86,6 +86,11 @@ struct _CamelFolderChangeInfo {
typedef struct _CamelFolderQuotaInfo CamelFolderQuotaInfo;
+/**
+ * CamelFolderQuotaInfo:
+ *
+ * Since: 2.24
+ **/
struct _CamelFolderQuotaInfo {
gchar *name;
guint64 used;
diff --git a/camel/camel-mime-filter-progress.c b/camel/camel-mime-filter-progress.c
index b4a41f1..c4dcfee 100644
--- a/camel/camel-mime-filter-progress.c
+++ b/camel/camel-mime-filter-progress.c
@@ -128,6 +128,8 @@ camel_mime_filter_progress_class_init (CamelMimeFilterProgressClass *klass)
* streaming progress.
*
* Returns: a new #CamelMimeFilter object
+ *
+ * Since: 2.24
**/
CamelMimeFilter *
camel_mime_filter_progress_new (CamelOperation *operation, gsize total)
diff --git a/camel/camel-mime-filter-progress.h b/camel/camel-mime-filter-progress.h
index 7e21b4c..12d3608 100644
--- a/camel/camel-mime-filter-progress.h
+++ b/camel/camel-mime-filter-progress.h
@@ -35,6 +35,11 @@ G_BEGIN_DECLS
typedef struct _CamelMimeFilterProgressClass CamelMimeFilterProgressClass;
typedef struct _CamelMimeFilterProgress CamelMimeFilterProgress;
+/**
+ * CamelMimeFilterProgress:
+ *
+ * Since: 2.24
+ **/
struct _CamelMimeFilterProgress {
CamelMimeFilter parent;
diff --git a/camel/camel-mime-part-utils.c b/camel/camel-mime-part-utils.c
index c761c32..477401e 100644
--- a/camel/camel-mime-part-utils.c
+++ b/camel/camel-mime-part-utils.c
@@ -78,7 +78,11 @@ simple_data_wrapper_construct_from_parser (CamelDataWrapper *dw, CamelMimeParser
camel_object_unref (mem);
}
-/* This replaces the data wrapper repository ... and/or could be replaced by it? */
+/**
+ * camel_mime_part_construct_content_from_parser:
+ *
+ * Since: 2.24
+ **/
void
camel_mime_part_construct_content_from_parser (CamelMimePart *dw, CamelMimeParser *mp)
{
@@ -86,6 +90,9 @@ camel_mime_part_construct_content_from_parser (CamelMimePart *dw, CamelMimeParse
CamelContentType *ct;
gchar *encoding;
+ /* This replaces the data wrapper repository ... and/or could be
+ * replaced by it? */
+
if (!dw)
return;
diff --git a/camel/camel-msgport.c b/camel/camel-msgport.c
index ca9f0b1..43d4b6a 100644
--- a/camel/camel-msgport.c
+++ b/camel/camel-msgport.c
@@ -249,6 +249,11 @@ msgport_sync_with_prpipe (PRFileDesc *prfd)
}
#endif
+/**
+ * camel_msgport_new:
+ *
+ * Since: 2.24
+ **/
CamelMsgPort *
camel_msgport_new (void)
{
@@ -266,6 +271,11 @@ camel_msgport_new (void)
return msgport;
}
+/**
+ * camel_msgport_destroy:
+ *
+ * Since: 2.24
+ **/
void
camel_msgport_destroy (CamelMsgPort *msgport)
{
@@ -286,6 +296,11 @@ camel_msgport_destroy (CamelMsgPort *msgport)
g_slice_free (CamelMsgPort, msgport);
}
+/**
+ * camel_msgport_fd:
+ *
+ * Since: 2.24
+ **/
gint
camel_msgport_fd (CamelMsgPort *msgport)
{
@@ -303,6 +318,11 @@ camel_msgport_fd (CamelMsgPort *msgport)
}
#ifdef HAVE_NSS
+/**
+ * camel_msgport_prfd:
+ *
+ * Since: 2.24
+ **/
PRFileDesc *
camel_msgport_prfd (CamelMsgPort *msgport)
{
@@ -320,6 +340,11 @@ camel_msgport_prfd (CamelMsgPort *msgport)
}
#endif
+/**
+ * camel_msgport_push:
+ *
+ * Since: 2.24
+ **/
void
camel_msgport_push (CamelMsgPort *msgport, CamelMsg *msg)
{
@@ -367,6 +392,11 @@ camel_msgport_push (CamelMsgPort *msgport, CamelMsg *msg)
g_async_queue_unlock (msgport->queue);
}
+/**
+ * camel_msgport_pop:
+ *
+ * Since: 2.24
+ **/
CamelMsg *
camel_msgport_pop (CamelMsgPort *msgport)
{
@@ -392,6 +422,11 @@ camel_msgport_pop (CamelMsgPort *msgport)
return msg;
}
+/**
+ * camel_msgport_try_pop:
+ *
+ * Since: 2.24
+ **/
CamelMsg *
camel_msgport_try_pop (CamelMsgPort *msgport)
{
@@ -420,8 +455,6 @@ camel_msgport_try_pop (CamelMsgPort *msgport)
* @msgport: a #CamelMsgPort
* @end_time: a #GTimeVal
*
- * FIXME Document me!
- *
* Since: 2.30
**/
CamelMsg *
@@ -447,6 +480,11 @@ camel_msgport_timed_pop (CamelMsgPort *msgport, GTimeVal *end_time)
return msg;
}
+/**
+ * camel_msgport_reply:
+ *
+ * Since: 2.24
+ **/
void
camel_msgport_reply (CamelMsg *msg)
{
diff --git a/camel/camel-msgport.h b/camel/camel-msgport.h
index 311054b..7c7a91c 100644
--- a/camel/camel-msgport.h
+++ b/camel/camel-msgport.h
@@ -26,9 +26,20 @@
G_BEGIN_DECLS
+/**
+ * CamelMsgPort:
+ *
+ * Since: 2.24
+ **/
+
typedef struct _CamelMsg CamelMsg;
typedef struct _CamelMsgPort CamelMsgPort;
+/**
+ * CamelMsg:
+ *
+ * Since: 2.24
+ **/
struct _CamelMsg {
CamelDListNode ln;
CamelMsgPort *reply_port;
diff --git a/camel/camel-offline-store.c b/camel/camel-offline-store.c
index 4066bc8..3a73a60 100644
--- a/camel/camel-offline-store.c
+++ b/camel/camel-offline-store.c
@@ -103,6 +103,8 @@ offline_store_construct (CamelService *service, CamelSession *session,
*
* Return the network state either #CAMEL_OFFLINE_STORE_NETWORK_AVAIL
* or #CAMEL_OFFLINE_STORE_NETWORK_UNAVAIL.
+ *
+ * Since: 2.24
**/
gint
camel_offline_store_get_network_state (CamelOfflineStore *store, CamelException *ex)
diff --git a/camel/camel-search-sql.c b/camel/camel-search-sql.c
index 9358c31..8f0dc8b 100644
--- a/camel/camel-search-sql.c
+++ b/camel/camel-search-sql.c
@@ -199,13 +199,14 @@ escape_values (gchar *str)
}
/**
- * camel_search_sexp_to_sql:
+ * camel_sexp_to_sql:
* @txt: A valid sexp expression
*
* Converts a valid sexp expression to a sql statement with table fields converted into it.
* This is very specific to Evolution. It might crash is the sexp is invalid. The callers must ensure that the sexp is valid
+ *
+ * Since: 2.24
**/
-
gchar *
camel_sexp_to_sql (const gchar *txt)
{
diff --git a/camel/camel-stream-vfs.c b/camel/camel-stream-vfs.c
index b735638..c90464f 100644
--- a/camel/camel-stream-vfs.c
+++ b/camel/camel-stream-vfs.c
@@ -105,6 +105,8 @@ camel_stream_vfs_get_type (void)
* will be closed. This will not increase reference counter on the stream.
*
* Returns: a new #CamelStreamVFS
+ *
+ * Since: 2.24
**/
CamelStream *
camel_stream_vfs_new_with_stream (GObject *stream)
@@ -175,6 +177,8 @@ camel_stream_vfs_new_with_uri (const gchar *uri, CamelStreamVFSOpenMethod mode)
* @stream_vfs: a #CamelStreamVFS instance
*
* Returns: whether is the underlying stream writable or not.
+ *
+ * Since: 2.24
**/
gboolean
camel_stream_vfs_is_writable (CamelStreamVFS *stream_vfs)
diff --git a/camel/camel-stream-vfs.h b/camel/camel-stream-vfs.h
index 816129a..822fefe 100644
--- a/camel/camel-stream-vfs.h
+++ b/camel/camel-stream-vfs.h
@@ -53,10 +53,21 @@ typedef struct {
/* Standard Camel function */
CamelType camel_stream_vfs_get_type (void);
+/**
+ * CamelStreamVFSOpenMethod:
+ * CAMEL_STREAM_VFS_CREATE:
+ * Writable, creates new file or replaces old file.
+ * CAMEL_STREAM_VFS_APPEND:
+ * Writable, creates new file or appends at the end of the old file.
+ * CAMEL_STREAM_VFS_READ:
+ * Readable, opens existing file for reading.
+ *
+ * Since: 2.24
+ **/
typedef enum {
- CAMEL_STREAM_VFS_CREATE, /* writable, creates new file or replaces old file */
- CAMEL_STREAM_VFS_APPEND, /* writable, creates new file or appends at the end of the old file */
- CAMEL_STREAM_VFS_READ /* readable, opens existing file for reading */
+ CAMEL_STREAM_VFS_CREATE,
+ CAMEL_STREAM_VFS_APPEND,
+ CAMEL_STREAM_VFS_READ
} CamelStreamVFSOpenMethod;
/* public methods */
diff --git a/camel/camel-string-utils.c b/camel/camel-string-utils.c
index b2c1b27..6a70052 100644
--- a/camel/camel-string-utils.c
+++ b/camel/camel-string-utils.c
@@ -199,6 +199,8 @@ camel_pstring_add (gchar *str, gboolean own)
*
* Return value: A pointer to an equivalent string of @s. Use
* camel_pstring_free() when it is no longer needed.
+ *
+ * Since: 2.24
**/
const gchar *
camel_pstring_peek (const gchar *str)
diff --git a/camel/camel-trie.c b/camel/camel-trie.c
index 09180b6..9e66de7 100644
--- a/camel/camel-trie.c
+++ b/camel/camel-trie.c
@@ -49,6 +49,8 @@ struct _trie_match {
* CamelTrie:
*
* A trie data structure.
+ *
+ * Since: 2.24
**/
struct _CamelTrie {
struct _trie_state root;
@@ -110,6 +112,8 @@ trie_utf8_getc (const guchar **in, gsize inlen)
* done by the CamelTrie will be case insensitive.
*
* Returns: The newly-created #CamelTrie.
+ *
+ * Since: 2.24
**/
CamelTrie *
camel_trie_new (gboolean icase)
@@ -136,6 +140,8 @@ camel_trie_new (gboolean icase)
* @trie: The #CamelTrie to free.
*
* Frees the memory associated with the #CamelTrie @trie.
+ *
+ * Since: 2.24
**/
void
camel_trie_free (CamelTrie *trie)
@@ -230,6 +236,8 @@ dump_trie (struct _trie_state *s, gint depth)
* @pattern_id: The id to use for the pattern.
*
* Add a new pattern to the #CamelTrie @trie.
+ *
+ * Since: 2.24
**/
void
camel_trie_add (CamelTrie *trie, const gchar *pattern, gint pattern_id)
@@ -326,6 +334,8 @@ camel_trie_add (CamelTrie *trie, const gchar *pattern, gint pattern_id)
* Try to match the string @buffer with a pattern in @trie.
*
* Returns: The matched pattern, or %NULL if no pattern is matched.
+ *
+ * Since: 2.24
**/
const gchar *
camel_trie_search (CamelTrie *trie, const gchar *buffer, gsize buflen,
diff --git a/camel/camel-vee-folder.c b/camel/camel-vee-folder.c
index bed7690..a2507ed 100644
--- a/camel/camel-vee-folder.c
+++ b/camel/camel-vee-folder.c
@@ -2286,6 +2286,11 @@ vee_folder_stop_folder(CamelVeeFolder *vf, CamelFolder *sub)
camel_object_unref((CamelObject *)sub);
}
+/**
+ * camel_vee_folder_sync_headers:
+ *
+ * Since: 2.24
+ **/
void
camel_vee_folder_sync_headers (CamelFolder *vf, CamelException *ex)
{
diff --git a/camel/camel-vee-store.h b/camel/camel-vee-store.h
index 1921560..7c45914 100644
--- a/camel/camel-vee-store.h
+++ b/camel/camel-vee-store.h
@@ -36,6 +36,12 @@ typedef struct _CamelVeeStoreClass CamelVeeStoreClass;
/* open mode for folder, vee folder auto-update */
#define CAMEL_STORE_VEE_FOLDER_AUTO (1<<16)
+
+/**
+ * CAMEL_STORE_VEE_FOLDER_SPECIAL:
+ *
+ * Since: 2.24
+ **/
#define CAMEL_STORE_VEE_FOLDER_SPECIAL (1<<17)
struct _CamelVeeStore {
diff --git a/camel/camel-vee-summary.c b/camel/camel-vee-summary.c
index 6303a76..16b631f 100644
--- a/camel/camel-vee-summary.c
+++ b/camel/camel-vee-summary.c
@@ -468,6 +468,11 @@ camel_vee_summary_new(CamelFolder *parent)
return &s->summary;
}
+/**
+ * camel_vee_summary_get_ids:
+ *
+ * Since: 2.24
+ **/
GPtrArray *
camel_vee_summary_get_ids (CamelVeeSummary *summary, gchar hash[8])
{
diff --git a/camel/camel.c b/camel/camel.c
index 0986d80..7bccbf9 100644
--- a/camel/camel.c
+++ b/camel/camel.c
@@ -145,6 +145,11 @@ camel_init (const gchar *configdir, gboolean nss_init)
return 0;
}
+/**
+ * camel_shutdown:
+ *
+ * Since: 2.24
+ **/
void
camel_shutdown (void)
{
diff --git a/docs/reference/addressbook/libebook/libebook-docs.sgml b/docs/reference/addressbook/libebook/libebook-docs.sgml
index f6a490b..4cdef80 100644
--- a/docs/reference/addressbook/libebook/libebook-docs.sgml
+++ b/docs/reference/addressbook/libebook/libebook-docs.sgml
@@ -37,4 +37,8 @@
<title>Index of new symbols in 2.26</title>
<xi:include href="xml/api-index-2.26.xml"><xi:fallback /></xi:include>
</index>
+ <index id="api-index-2.24" role="2.24">
+ <title>Index of new symbols in 2.24</title>
+ <xi:include href="xml/api-index-2.24.xml"><xi:fallback /></xi:include>
+ </index>
</book>
diff --git a/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml b/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml
index a21d736..352df4a 100644
--- a/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml
+++ b/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml
@@ -39,4 +39,8 @@
<title>Index of new symbols in 2.26</title>
<xi:include href="xml/api-index-2.26.xml"><xi:fallback /></xi:include>
</index>
+ <index id="api-index-2.24" role="2.24">
+ <title>Index of new symbols in 2.24</title>
+ <xi:include href="xml/api-index-2.24.xml"><xi:fallback /></xi:include>
+ </index>
</book>
diff --git a/docs/reference/calendar/libecal/libecal-docs.sgml b/docs/reference/calendar/libecal/libecal-docs.sgml
index 1334651..f78d5d3 100644
--- a/docs/reference/calendar/libecal/libecal-docs.sgml
+++ b/docs/reference/calendar/libecal/libecal-docs.sgml
@@ -37,4 +37,8 @@
<title>Index of new symbols in 2.26</title>
<xi:include href="xml/api-index-2.26.xml"><xi:fallback /></xi:include>
</index>
+ <index id="api-index-2.24" role="2.24">
+ <title>Index of new symbols in 2.24</title>
+ <xi:include href="xml/api-index-2.24.xml"><xi:fallback /></xi:include>
+ </index>
</book>
diff --git a/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml b/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml
index 48f73b7..0b8146b 100644
--- a/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml
+++ b/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml
@@ -13,6 +13,7 @@
<xi:include href="xml/e-cal-backend.xml"/>
<xi:include href="xml/e-cal-backend-cache.xml"/>
<xi:include href="xml/e-cal-backend-factory.xml"/>
+ <xi:include href="xml/e-cal-backend-loader-factory.xml"/>
<xi:include href="xml/e-cal-backend-sexp.xml"/>
<xi:include href="xml/e-cal-backend-store.xml"/>
<xi:include href="xml/e-cal-backend-file-store.xml"/>
@@ -39,4 +40,8 @@
<title>Index of new symbols in 2.26</title>
<xi:include href="xml/api-index-2.26.xml"><xi:fallback /></xi:include>
</index>
+ <index id="api-index-2.24" role="2.24">
+ <title>Index of new symbols in 2.24</title>
+ <xi:include href="xml/api-index-2.24.xml"><xi:fallback /></xi:include>
+ </index>
</book>
diff --git a/docs/reference/camel/camel-docs.sgml b/docs/reference/camel/camel-docs.sgml
index 4269ed4..9ea72d2 100644
--- a/docs/reference/camel/camel-docs.sgml
+++ b/docs/reference/camel/camel-docs.sgml
@@ -158,6 +158,7 @@
<chapter id="Fundamentals">
<title>Fundamentals</title>
+ &CamelInit;
&CamelArg;
&CamelDebug;
&CamelException;
@@ -342,5 +343,9 @@
<title>Index of new symbols in 2.26</title>
<xi:include href="xml/api-index-2.26.xml"><xi:fallback /></xi:include>
</index>
+ <index id="api-index-2.24" role="2.24">
+ <title>Index of new symbols in 2.24</title>
+ <xi:include href="xml/api-index-2.24.xml"><xi:fallback /></xi:include>
+ </index>
</part>
</book>
diff --git a/docs/reference/camel/tmpl/camel-filter-driver.sgml b/docs/reference/camel/tmpl/camel-filter-driver.sgml
index cfbaf47..b46e6f2 100644
--- a/docs/reference/camel/tmpl/camel-filter-driver.sgml
+++ b/docs/reference/camel/tmpl/camel-filter-driver.sgml
@@ -186,33 +186,3 @@ CamelFilterDriver
@Returns:
-<!-- ##### FUNCTION camel_filter_driver_expand_option ##### -->
-<para>
-
-</para>
-
- d:
- s:
- action:
- op:
-
-
-<!-- ##### FUNCTION camel_filter_driver_rule_count ##### -->
-<para>
-
-</para>
-
- d:
- Returns:
-
-
-<!-- ##### FUNCTION camel_filter_driver_rule_get ##### -->
-<para>
-
-</para>
-
- d:
- n:
- Returns:
-
-
diff --git a/docs/reference/camel/tmpl/camel-unused.sgml b/docs/reference/camel/tmpl/camel-unused.sgml
index f578a14..5d468c0 100644
--- a/docs/reference/camel/tmpl/camel-unused.sgml
+++ b/docs/reference/camel/tmpl/camel-unused.sgml
@@ -484,6 +484,33 @@ camel-types
@value:
@Returns:
+<!-- ##### FUNCTION camel_filter_driver_expand_option ##### -->
+<para>
+
+</para>
+
+ d:
+ s:
+ action:
+ op:
+
+<!-- ##### FUNCTION camel_filter_driver_rule_count ##### -->
+<para>
+
+</para>
+
+ d:
+ Returns:
+
+<!-- ##### FUNCTION camel_filter_driver_rule_get ##### -->
+<para>
+
+</para>
+
+ d:
+ n:
+ Returns:
+
<!-- ##### FUNCTION camel_folder_summary_array_free ##### -->
<para>
diff --git a/docs/reference/libebackend/libebackend-docs.xml b/docs/reference/libebackend/libebackend-docs.xml
index 2860cb3..ac50c9d 100644
--- a/docs/reference/libebackend/libebackend-docs.xml
+++ b/docs/reference/libebackend/libebackend-docs.xml
@@ -32,4 +32,8 @@
<title>Index of new symbols in 2.26</title>
<xi:include href="xml/api-index-2.26.xml"><xi:fallback /></xi:include>
</index>
+ <index id="api-index-2.24" role="2.24">
+ <title>Index of new symbols in 2.24</title>
+ <xi:include href="xml/api-index-2.24.xml"><xi:fallback /></xi:include>
+ </index>
</book>
diff --git a/docs/reference/libedataserver/libedataserver-docs.sgml b/docs/reference/libedataserver/libedataserver-docs.sgml
index 527430e..b680d14 100644
--- a/docs/reference/libedataserver/libedataserver-docs.sgml
+++ b/docs/reference/libedataserver/libedataserver-docs.sgml
@@ -51,4 +51,8 @@
<title>Index of new symbols in 2.26</title>
<xi:include href="xml/api-index-2.26.xml"><xi:fallback /></xi:include>
</index>
+ <index id="api-index-2.24" role="2.24">
+ <title>Index of new symbols in 2.24</title>
+ <xi:include href="xml/api-index-2.24.xml"><xi:fallback /></xi:include>
+ </index>
</book>
diff --git a/docs/reference/libedataserverui/libedataserverui-docs.sgml b/docs/reference/libedataserverui/libedataserverui-docs.sgml
index 8a50740..2d6d5cd 100644
--- a/docs/reference/libedataserverui/libedataserverui-docs.sgml
+++ b/docs/reference/libedataserverui/libedataserverui-docs.sgml
@@ -46,4 +46,8 @@
<title>Index of new symbols in 2.26</title>
<xi:include href="xml/api-index-2.26.xml"><xi:fallback /></xi:include>
</index>
+ <index id="api-index-2.24" role="2.24">
+ <title>Index of new symbols in 2.24</title>
+ <xi:include href="xml/api-index-2.24.xml"><xi:fallback /></xi:include>
+ </index>
</book>
diff --git a/libedataserver/e-categories.c b/libedataserver/e-categories.c
index 96bdad9..c90bbda 100644
--- a/libedataserver/e-categories.c
+++ b/libedataserver/e-categories.c
@@ -680,6 +680,8 @@ e_categories_is_searchable (const gchar *category)
* Registers callback to be called on change of any category.
* Pair listener and user_data is used to distinguish between listeners.
* Listeners can be unregistered with @e_categories_unregister_change_listener.
+ *
+ * Since: 2.24
**/
void
e_categories_register_change_listener (GCallback listener, gpointer user_data)
@@ -697,6 +699,8 @@ e_categories_register_change_listener (GCallback listener, gpointer user_data)
*
* Removes previously registered callback from the list of listeners on changes.
* If it was not registered, then does nothing.
+ *
+ * Since: 2.24
**/
void
e_categories_unregister_change_listener (GCallback listener, gpointer user_data)
diff --git a/libedataserver/e-proxy.c b/libedataserver/e-proxy.c
index 3f76edf..ed85ea2 100644
--- a/libedataserver/e-proxy.c
+++ b/libedataserver/e-proxy.c
@@ -702,6 +702,11 @@ ep_setting_changed (GConfClient *client, guint32 cnxn_id, GConfEntry *entry, gpo
}
}
+/**
+ * e_proxy_new:
+ *
+ * Since: 2.24
+ **/
EProxy*
e_proxy_new (void)
{
@@ -712,6 +717,11 @@ e_proxy_new (void)
return proxy;
}
+/**
+ * e_proxxy_setup_proxy:
+ *
+ * Since: 2.24
+ **/
void
e_proxy_setup_proxy (EProxy* proxy)
{
@@ -773,6 +783,11 @@ e_proxy_peek_uri_for (EProxy* proxy, const gchar *uri)
return proxy->priv->uri_http;
}
+/**
+ * e_proxy_require_proxy_for_uri:
+ *
+ * Since: 2.24
+ **/
gboolean
e_proxy_require_proxy_for_uri (EProxy* proxy, const gchar * uri)
{
diff --git a/libedataserver/e-proxy.h b/libedataserver/e-proxy.h
index 752d292..3f961a9 100644
--- a/libedataserver/e-proxy.h
+++ b/libedataserver/e-proxy.h
@@ -38,6 +38,11 @@ typedef struct _EProxy EProxy;
typedef struct _EProxyClass EProxyClass;
typedef struct _EProxyPrivate EProxyPrivate;
+/**
+ * EProxy:
+ *
+ * Since: 2.24
+ **/
struct _EProxy {
GObject parent;
EProxyPrivate *priv;
diff --git a/libedataserver/e-source-group.c b/libedataserver/e-source-group.c
index abeef14..fbd35b4 100644
--- a/libedataserver/e-source-group.c
+++ b/libedataserver/e-source-group.c
@@ -822,6 +822,8 @@ compare_source_lists (GSList *a, GSList *b)
*
* Return value: %TRUE if @a is equivalent to @b,
* %FALSE otherwise.
+ *
+ * Since: 2.24
**/
gboolean
e_source_group_equal (ESourceGroup *a, ESourceGroup *b)
@@ -867,6 +869,8 @@ e_source_group_equal (ESourceGroup *a, ESourceGroup *b)
*
* Return value: %TRUE if @a is equivalent to @b,
* %FALSE otherwise.
+ *
+ * Since: 2.24
**/
gboolean
e_source_group_xmlstr_equal (const gchar *a, const gchar *b)
diff --git a/libedataserver/e-source.c b/libedataserver/e-source.c
index 73b2aa4..4291ff5 100644
--- a/libedataserver/e-source.c
+++ b/libedataserver/e-source.c
@@ -824,6 +824,8 @@ e_source_to_standalone_xml (ESource *source)
*
* Return value: %TRUE if @a is equivalent to @b,
* %FALSE otherwise.
+ *
+ * Since: 2.24
**/
gboolean
e_source_equal (ESource *a, ESource *b)
@@ -880,6 +882,8 @@ e_source_equal (ESource *a, ESource *b)
*
* Return value: %TRUE if @a is equivalent to @b,
* %FALSE otherwise.
+ *
+ * Since: 2.24
**/
gboolean
e_source_xmlstr_equal (const gchar *a, const gchar *b)
diff --git a/libedataserverui/e-name-selector-entry.c b/libedataserverui/e-name-selector-entry.c
index ca2c2cd..156f5a8 100644
--- a/libedataserverui/e-name-selector-entry.c
+++ b/libedataserverui/e-name-selector-entry.c
@@ -480,9 +480,12 @@ escape_sexp_string (const gchar *string)
/**
* ens_util_populate_user_query_fields:
+ *
* Populates list of user query fields to string usable in query string.
* Returned pointer is either newly allocated string, supposed to be freed with g_free,
* or NULL if no fields defined.
+ *
+ * Since: 2.24
**/
gchar *
ens_util_populate_user_query_fields (GSList *user_query_fields, const gchar *cue_str, const gchar *encoded_cue_str)
diff --git a/libedataserverui/e-name-selector-entry.h b/libedataserverui/e-name-selector-entry.h
index 7c03884..e7ae409 100644
--- a/libedataserverui/e-name-selector-entry.h
+++ b/libedataserverui/e-name-selector-entry.h
@@ -50,7 +50,19 @@
((obj), E_TYPE_NAME_SELECTOR_ENTRY, ENameSelectorEntryClass))
#define MINIMUM_QUERY_LENGTH "/apps/evolution/addressbook/completion/minimum_query_length"
+
+/**
+ * FORCE_SHOW_ADDRESS:
+ *
+ * Since: 2.24
+ **/
#define FORCE_SHOW_ADDRESS "/apps/evolution/addressbook/completion/show_address"
+
+/**
+ * USER_QUERY_FIELDS:
+ *
+ * Since: 2.24
+ **/
#define USER_QUERY_FIELDS "/apps/evolution/addressbook/completion/user_query_fields"
G_BEGIN_DECLS
diff --git a/libedataserverui/e-source-selector.c b/libedataserverui/e-source-selector.c
index 53b0942..1b9f4a6 100644
--- a/libedataserverui/e-source-selector.c
+++ b/libedataserverui/e-source-selector.c
@@ -1340,6 +1340,8 @@ e_source_selector_new (ESourceList *list)
* Returns the #ESourceList that @selector is rendering.
*
* Returns: an #ESourceList
+ *
+ * Since: 2.24
**/
ESourceList *
e_source_selector_get_source_list (ESourceSelector *selector)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
