[evolution-data-server] Correct and enhance developer documentation a bit
- From: Milan Crha <mcrha src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [evolution-data-server] Correct and enhance developer documentation a bit
- Date: Tue, 12 May 2015 21:56:35 +0000 (UTC)
commit d2c385c7134432ce2967df677fb4d3e35f5793cc
Author: Milan Crha <mcrha redhat com>
Date: Tue May 12 23:55:50 2015 +0200
Correct and enhance developer documentation a bit
.../libebook-contacts/e-book-contacts-types.c | 4 +-
addressbook/libebook/e-book.c | 2 +
.../libedata-book/e-book-backend-db-cache.c | 5 +-
.../libedata-book/e-book-backend-sqlitedb.c | 2 +
addressbook/libedata-book/e-book-backend.c | 3 +
addressbook/libedata-book/e-book-sqlite.c | 4 +-
addressbook/libedata-book/e-data-book.c | 85 +++++-
addressbook/libedata-book/e-data-book.h | 2 +
.../libedata-book/e-subprocess-book-factory.c | 8 +-
calendar/libecal/e-cal-check-timezones.c | 26 ++-
calendar/libecal/e-cal-client-view.h | 13 +
calendar/libecal/e-cal-client.c | 5 +-
calendar/libecal/e-cal-client.h | 18 +-
calendar/libecal/e-cal-component.c | 10 +
calendar/libecal/e-cal-component.h | 196 +++++++++++-
calendar/libecal/e-cal-types.h | 1 +
calendar/libecal/e-cal-util.h | 11 +-
calendar/libedata-cal/e-cal-backend-cache.c | 2 +
calendar/libedata-cal/e-cal-backend-sexp.c | 2 +
calendar/libedata-cal/e-cal-backend-sync.h | 31 ++
calendar/libedata-cal/e-subprocess-cal-factory.c | 8 +-
camel/camel-db.c | 2 +-
camel/camel-enums.h | 2 +-
camel/camel-folder.c | 4 +-
camel/camel-mime-filter-tohtml.c | 4 +-
camel/camel-store.c | 8 +-
camel/providers/imapx/camel-imapx-search.c | 2 +-
docs/reference/camel/camel-sections.txt | 86 +++++-
docs/reference/eds/eds-sections.txt | 319 ++++++++++++++++++++
libebackend/e-backend-factory.h | 2 +
libebackend/e-backend.c | 11 +-
libebackend/e-backend.h | 3 +-
libebackend/e-collection-backend-factory.h | 3 +
libebackend/e-collection-backend.h | 3 +
libebackend/e-subprocess-factory.c | 4 +-
libedataserver/e-client.c | 21 +-
libedataserver/e-client.h | 26 ++-
libedataserver/e-module.c | 2 +-
.../e-source-credentials-provider-impl.c | 12 +-
libedataserver/e-source.c | 42 ++--
libedataserver/e-webdav-discover.c | 13 +-
libedataserverui/e-credentials-prompter-impl.c | 6 +-
libedataserverui/e-credentials-prompter.c | 18 +-
libedataserverui/e-trust-prompt.c | 10 +-
libedataserverui/e-webdav-discover-widget.c | 6 +-
45 files changed, 917 insertions(+), 130 deletions(-)
---
diff --git a/addressbook/libebook-contacts/e-book-contacts-types.c
b/addressbook/libebook-contacts/e-book-contacts-types.c
index 7356f07..bf04dcf 100644
--- a/addressbook/libebook-contacts/e-book-contacts-types.c
+++ b/addressbook/libebook-contacts/e-book-contacts-types.c
@@ -26,7 +26,9 @@ 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.
+ * Get localized human readable description of the given error code.
+ *
+ * Returns: Localized human readable description of the given error code
*
* Since: 3.2
**/
diff --git a/addressbook/libebook/e-book.c b/addressbook/libebook/e-book.c
index a54e2de..1412b63 100644
--- a/addressbook/libebook/e-book.c
+++ b/addressbook/libebook/e-book.c
@@ -2100,6 +2100,8 @@ e_book_cancel (EBook *book,
* Similar to above e_book_cancel function, only cancels last, still running,
* asynchronous operation.
*
+ * Returns: %TRUE on success, %FALSE otherwise
+ *
* Since: 2.24
*
* Deprecated: 3.2: Use e_client_cancel_all() or e_client_cancel_op() on an
diff --git a/addressbook/libedata-book/e-book-backend-db-cache.c
b/addressbook/libedata-book/e-book-backend-db-cache.c
index 6d074fa..0081d0b 100644
--- a/addressbook/libedata-book/e-book-backend-db-cache.c
+++ b/addressbook/libedata-book/e-book-backend-db-cache.c
@@ -97,7 +97,10 @@ e_book_backend_db_cache_set_filename (DB *db,
* e_book_backend_db_cache_get_filename:
* @db: DB Handle
*
- * Get the filename for db cacahe file.
+ * Get the filename for db cache file.
+ *
+ * Returns: The filename for db cache file. Free with g_free()
+ * when done with it.
*
* Deprecated: 3.12: Use #EBookSqlite instead
**/
diff --git a/addressbook/libedata-book/e-book-backend-sqlitedb.c
b/addressbook/libedata-book/e-book-backend-sqlitedb.c
index 6c85dad..f6d2d05 100644
--- a/addressbook/libedata-book/e-book-backend-sqlitedb.c
+++ b/addressbook/libedata-book/e-book-backend-sqlitedb.c
@@ -2849,6 +2849,8 @@ uid_rev_fields (GHashTable *fields_of_interest)
* This only checks if all the fields are part of the default summary fields,
* not part of the configured summary fields.
*
+ * Returns: Whether all @fields_of_interest are part of the default summary fields
+ *
* Since: 3.2
*
* Deprecated: 3.8: Use #EBookSqlite instead
diff --git a/addressbook/libedata-book/e-book-backend.c b/addressbook/libedata-book/e-book-backend.c
index 51cc2f4..962889f 100644
--- a/addressbook/libedata-book/e-book-backend.c
+++ b/addressbook/libedata-book/e-book-backend.c
@@ -3338,6 +3338,9 @@ e_book_backend_set_locale (EBookBackend *backend,
*
* Fetches a copy of the currently configured locale for the addressbook
*
+ * Returns: A copy of the currently configured locale for the addressbook.
+ * Free with g_free() when done with it.
+ *
* Since: 3.12
*/
gchar *
diff --git a/addressbook/libedata-book/e-book-sqlite.c b/addressbook/libedata-book/e-book-sqlite.c
index bc9d6b0..0e9ea83 100644
--- a/addressbook/libedata-book/e-book-sqlite.c
+++ b/addressbook/libedata-book/e-book-sqlite.c
@@ -6538,6 +6538,7 @@ ebsql_new_default (const gchar *path,
/**
* e_book_sqlite_new:
* @path: location to load or create the new database
+ * @source: an optional #ESource, associated with the #EBookSqlite, or %NULL
* @cancellable: (allow-none): A #GCancellable
* @error: (allow-none): A location to store any error that may have occurred.
*
@@ -6576,6 +6577,7 @@ e_book_sqlite_new (const gchar *path,
/**
* e_book_sqlite_new_full:
* @path: location to load or create the new database
+ * @source: an optional #ESource, associated with the #EBookSqlite, or %NULL
* @setup: (allow-none): an #ESourceBackendSummarySetup describing how the summary should be setup, or %NULL
to use the default
* @vcard_callback: (allow-none) (scope async) (closure user_data): A function to resolve vcards
* @change_callback: (allow-none) (scope async) (closure user_data): A function to catch notifications of
vcard changes
@@ -6865,7 +6867,7 @@ e_book_sqlite_ref_collator (EBookSqlite *ebsql)
* use g_object_unref() when finished using the source.
* It can be %NULL in some cases, like when running tests.
*
- * Returns: (transfer-full): A reference to the #ESource to which @ebsql
+ * Returns: (transfer full): A reference to the #ESource to which @ebsql
* is paired, or %NULL.
*
* Since: 3.16
diff --git a/addressbook/libedata-book/e-data-book.c b/addressbook/libedata-book/e-data-book.c
index f4c35fe..9c17cb7 100644
--- a/addressbook/libedata-book/e-data-book.c
+++ b/addressbook/libedata-book/e-data-book.c
@@ -361,6 +361,11 @@ data_book_convert_to_client_error (GError *error)
/**
* e_data_book_status_to_string:
+ * @status: an #EDataBookStatus
+ *
+ * Get localized human readable description of the given status code.
+ *
+ * Returns: Localized human readable description of the given status code
*
* Since: 2.32
**/
@@ -477,10 +482,17 @@ e_data_book_create_error (EDataBookStatus status,
/**
* e_data_book_create_error_fmt:
+ * @status: an #EDataBookStatus
+ * @custom_msg_fmt: Custom message to use for the error. When NULL,
+ * then uses a default message based on the @status code.
+ * @...: arguments for the @custom_msg_fmt
*
* Similar as e_data_book_create_error(), only here, instead of custom_msg,
* is used a printf() format to create a custom_msg for the error.
*
+ * Returns: (transfer full): a new #GError populated with the values
+ * from the parameters.
+ *
* Since: 2.32
**/
GError *
@@ -508,10 +520,13 @@ e_data_book_create_error_fmt (EDataBookStatus status,
/**
* e_data_book_string_slist_to_comma_string:
+ * @strings: (element-type gchar *): a list of gchar *
*
* Takes a list of strings and converts it to a comma-separated string of
* values; free returned pointer with g_free()
*
+ * Returns: (transfer full): comma-separated newly allocated text of @strings
+ *
* Since: 3.2
**/
gchar *
@@ -1377,6 +1392,14 @@ data_book_handle_close_cb (EDBusAddressBook *dbus_interface,
return TRUE;
}
+/**
+ * e_data_book_respond_open:
+ * @book: An #EDataBook
+ * @opid: An operation ID
+ * @error: Operation error, if any, automatically freed if passed it
+ *
+ * Notifies listeners of the completion of the open method call.
+ **/
void
e_data_book_respond_open (EDataBook *book,
guint opid,
@@ -1407,8 +1430,9 @@ e_data_book_respond_open (EDataBook *book,
/**
* e_data_book_respond_refresh:
- * @book: An addressbook client interface.
- * @error: Operation error, if any, automatically freed if passed it.
+ * @book: An #EDataBook
+ * @opid: An operation ID
+ * @error: Operation error, if any, automatically freed if passed it
*
* Notifies listeners of the completion of the refresh method call.
*
@@ -1442,6 +1466,14 @@ e_data_book_respond_refresh (EDataBook *book,
g_object_unref (backend);
}
+/**
+ * e_data_book_respond_get_contact:
+ * @book: An #EDataBook
+ * @opid: An operation ID
+ * @error: Operation error, if any, automatically freed if passed it
+ *
+ * Notifies listeners of the completion of the get_contact method call.
+ */
void
e_data_book_respond_get_contact (EDataBook *book,
guint32 opid,
@@ -1480,6 +1512,17 @@ e_data_book_respond_get_contact (EDataBook *book,
g_object_unref (backend);
}
+/**
+ * e_data_book_respond_get_contact_list:
+ * @book: An #EDataBook
+ * @opid: An operation ID
+ * @error: Operation error, if any, automatically freed if passed it
+ * @cards: (allow-none) (element-type gchar *): A list of vCard strings, or %NULL on error
+ *
+ * Finishes a call to get list of vCards which satisfy certain criteria.
+ *
+ * Since: 3.2
+ **/
void
e_data_book_respond_get_contact_list (EDataBook *book,
guint32 opid,
@@ -1527,8 +1570,12 @@ e_data_book_respond_get_contact_list (EDataBook *book,
/**
* e_data_book_respond_get_contact_list_uids:
+ * @book: An #EDataBook
+ * @opid: An operation ID
+ * @error: Operation error, if any, automatically freed if passed it
+ * @uids: (allow-none) (element-type gchar *): A list of picked UIDs, or %NULL on error
*
- * FIXME: Document me.
+ * Finishes a call to get list of UIDs which satisfy certain criteria.
*
* Since: 3.2
**/
@@ -1574,8 +1621,12 @@ e_data_book_respond_get_contact_list_uids (EDataBook *book,
/**
* e_data_book_respond_create_contacts:
+ * @book: An #EDataBook
+ * @opid: An operation ID
+ * @error: Operation error, if any, automatically freed if passed it
+ * @contacts: (allow-none) (element-type EContact): A list of created #EContact-s, or %NULL on error
*
- * FIXME: Document me!
+ * Finishes a call to create a list contacts.
*
* Since: 3.4
**/
@@ -1623,8 +1674,12 @@ e_data_book_respond_create_contacts (EDataBook *book,
/**
* e_data_book_respond_modify_contacts:
+ * @book: An #EDataBook
+ * @opid: An operation ID
+ * @error: Operation error, if any, automatically freed if passed it
+ * @contacts: (allow-none) (element-type EContact): A list of modified #EContact-s, or %NULL on error
*
- * FIXME: Document me!
+ * Finishes a call to modify a list of contacts.
*
* Since: 3.4
**/
@@ -1670,6 +1725,17 @@ e_data_book_respond_modify_contacts (EDataBook *book,
g_object_unref (backend);
}
+/**
+ * e_data_book_respond_remove_contacts:
+ * @book: An #EDataBook
+ * @opid: An operation ID
+ * @error: Operation error, if any, automatically freed if passed it
+ * @ids: (allow-none) (element-type gchar *): A list of removed contact UID-s, or %NULL on error
+ *
+ * Finishes a call to remove a list of contacts.
+ *
+ * Since: 3.4
+ **/
void
e_data_book_respond_remove_contacts (EDataBook *book,
guint32 opid,
@@ -1712,8 +1778,10 @@ e_data_book_respond_remove_contacts (EDataBook *book,
/**
* e_data_book_report_error:
+ * @book: An #EDataBook
+ * @message: An error message
*
- * FIXME: Document me.
+ * Notifies the clients about an error, which happened out of any client-initiate operation.
*
* Since: 3.2
**/
@@ -1729,8 +1797,11 @@ e_data_book_report_error (EDataBook *book,
/**
* e_data_book_report_backend_property_changed:
+ * @book: An #EDataBook
+ * @prop_name: Property name which changed
+ * @prop_value: The new property value
*
- * FIXME: Document me.
+ * Notifies the clients about a property change.
*
* Since: 3.2
**/
diff --git a/addressbook/libedata-book/e-data-book.h b/addressbook/libedata-book/e-data-book.h
index 2e2f7ab..48e8a0b 100644
--- a/addressbook/libedata-book/e-data-book.h
+++ b/addressbook/libedata-book/e-data-book.h
@@ -52,11 +52,13 @@ typedef struct _EDataBookClass EDataBookClass;
typedef struct _EDataBookPrivate EDataBookPrivate;
struct _EDataBook {
+ /*< private >*/
GObject parent;
EDataBookPrivate *priv;
};
struct _EDataBookClass {
+ /*< private >*/
GObjectClass parent_class;
};
diff --git a/addressbook/libedata-book/e-subprocess-book-factory.c
b/addressbook/libedata-book/e-subprocess-book-factory.c
index a1868bb..bef12d6 100644
--- a/addressbook/libedata-book/e-subprocess-book-factory.c
+++ b/addressbook/libedata-book/e-subprocess-book-factory.c
@@ -17,15 +17,11 @@
* Authors: Fabiano Fidêncio <fidencio redhat com>
*/
-/**
- * SECTION: e-subprocess-book-factory
- * @include: libedata-book/libedata-book.h
- * @short_description: Responsible for #EBackend objects
- *
+/*
* This class handles and creates #EBackend objects from inside
* their own subprocesses and also serves as the layer that does
* the communication between #EDataBookFactory and #EBackend
- **/
+ */
#ifdef HAVE_CONFIG_H
#include <config.h>
diff --git a/calendar/libecal/e-cal-check-timezones.c b/calendar/libecal/e-cal-check-timezones.c
index 2381b19..834aaec 100644
--- a/calendar/libecal/e-cal-check-timezones.c
+++ b/calendar/libecal/e-cal-check-timezones.c
@@ -462,11 +462,16 @@ e_cal_check_timezones (icalcomponent *comp,
/**
* e_cal_tzlookup_ecal:
- * @custom: must be a valid ECal pointer
+ * @tzid: ID of the timezone to lookup
+ * @custom: must be a valid #ECal pointer
+ * @error: an error description in case of a failure
*
* An implementation of the tzlookup callback which clients
* can use. Calls e_cal_get_timezone().
*
+ * Returns: A timezone object, or %NULL on failure. This object is owned
+ * by the @custom, thus do not free it.
+ *
* Since: 2.24
*
* Deprecated: 3.2: Use e_cal_client_tzlookup() instead.
@@ -502,14 +507,19 @@ e_cal_tzlookup_ecal (const gchar *tzid,
/**
* e_cal_tzlookup_icomp:
+ * @tzid: ID of the timezone to lookup
* @custom: must be a icalcomponent pointer which contains
* either a VCALENDAR with VTIMEZONEs or VTIMEZONES
* directly
+ * @error: an error description in case of a failure
*
* An implementation of the tzlookup callback which backends
* like the file backend can use. Searches for the timezone
* in the component list.
*
+ * Returns: A timezone object, or %NULL if not found inside @custom. This object is owned
+ * by the @custom, thus do not free it.
+ *
* Since: 2.24
*
* Deprecated: 3.2: Use e_cal_client_tzlookup_icomp() instead.
@@ -775,11 +785,17 @@ e_cal_client_check_timezones (icalcomponent *comp,
/**
* e_cal_client_tzlookup:
- * @ecalclient: must be a valid ECalCleint pointer
+ * @tzid: ID of the timezone to lookup
+ * @ecalclient: must be a valid #ECalClient pointer
+ * @cancellable: an optional #GCancellable to use, or %NULL
+ * @error: an error description in case of a failure
*
* An implementation of the tzlookup callback which clients
* can use. Calls e_cal_client_get_timezone_sync().
*
+ * Returns: A timezone object, or %NULL on failure. This object is owned
+ * by the @ecalclient, thus do not free it.
+ *
* Since: 3.2
*/
icaltimezone *
@@ -814,14 +830,20 @@ e_cal_client_tzlookup (const gchar *tzid,
/**
* e_cal_client_tzlookup_icomp:
+ * @tzid: ID of the timezone to lookup
* @custom: must be a icalcomponent pointer which contains
* either a VCALENDAR with VTIMEZONEs or VTIMEZONES
* directly
+ * @cancellable: an optional #GCancellable to use, or %NULL
+ * @error: an error description in case of a failure
*
* An implementation of the tzlookup callback which backends
* like the file backend can use. Searches for the timezone
* in the component list.
*
+ * Returns: A timezone object, or %NULL if not found inside @custom. This object is owned
+ * by the @custom, thus do not free it.
+ *
* Since: 3.2
*/
icaltimezone *
diff --git a/calendar/libecal/e-cal-client-view.h b/calendar/libecal/e-cal-client-view.h
index 628aff0..54cb709 100644
--- a/calendar/libecal/e-cal-client-view.h
+++ b/calendar/libecal/e-cal-client-view.h
@@ -80,13 +80,26 @@ typedef enum {
* Since: 3.2
**/
struct _ECalClientView {
+ /*< private >*/
GObject object;
ECalClientViewPrivate *priv;
};
+/**
+ * ECalClientViewClass:
+ * @objects_added: A signal emitted when new objects are added into the view
+ * @objects_modified: A signal emitted when some objects are modified in the view
+ * @objects_removed: A signal emitted when some objects are removed from the view
+ * @progress: A signal emitted when the backend notifies about the progress
+ * @complete: A signal emitted when the backend finished initial view population
+ *
+ * Base class structure for the #ECalClientView class
+ **/
struct _ECalClientViewClass {
+ /*< private >*/
GObjectClass parent_class;
+ /*< public >*/
/* Signals */
void (*objects_added) (ECalClientView *client_view,
const GSList *objects);
diff --git a/calendar/libecal/e-cal-client.c b/calendar/libecal/e-cal-client.c
index 4eff237..78731f6 100644
--- a/calendar/libecal/e-cal-client.c
+++ b/calendar/libecal/e-cal-client.c
@@ -250,8 +250,11 @@ G_DEFINE_QUARK (e-cal-client-error-quark, e_cal_client_error)
/**
* e_cal_client_error_to_string:
+ * @code: an #ECalClientError error code
*
- * FIXME: Document me.
+ * Get localized human readable description of the given error code.
+ *
+ * Returns: Localized human readable description of the given error code
*
* Since: 3.2
**/
diff --git a/calendar/libecal/e-cal-client.h b/calendar/libecal/e-cal-client.h
index 25b4319..17124a1 100644
--- a/calendar/libecal/e-cal-client.h
+++ b/calendar/libecal/e-cal-client.h
@@ -90,8 +90,12 @@ G_BEGIN_DECLS
/**
* ECalClientError:
- *
- * FIXME: Document me.
+ * @E_CAL_CLIENT_ERROR_NO_SUCH_CALENDAR: No such calendar
+ * @E_CAL_CLIENT_ERROR_OBJECT_NOT_FOUND: Object not found
+ * @E_CAL_CLIENT_ERROR_INVALID_OBJECT: Invalid object
+ * @E_CAL_CLIENT_ERROR_UNKNOWN_USER: Unknown user
+ * @E_CAL_CLIENT_ERROR_OBJECT_ID_ALREADY_EXISTS: Object ID already exists
+ * @E_CAL_CLIENT_ERROR_INVALID_RANGE: Invalid range
*
* Since: 3.2
**/
@@ -117,15 +121,23 @@ typedef struct _ECalClientPrivate ECalClientPrivate;
* Since: 3.2
**/
struct _ECalClient {
+ /*< private >*/
EClient parent;
- /*< private >*/
ECalClientPrivate *priv;
};
+/**
+ * ECalClientClass:
+ * @free_busy_data: signal used to notify about free/busy data
+ *
+ * Base class structure for the #ECalClient class
+ **/
struct _ECalClientClass {
+ /*< private >*/
EClientClass parent;
+ /*< public >*/
/* Signals */
void (*free_busy_data) (ECalClient *client,
const GSList *free_busy_ecalcomps);
diff --git a/calendar/libecal/e-cal-component.c b/calendar/libecal/e-cal-component.c
index 179882e..67bcee0 100644
--- a/calendar/libecal/e-cal-component.c
+++ b/calendar/libecal/e-cal-component.c
@@ -3641,6 +3641,11 @@ e_cal_component_get_percent (ECalComponent *comp,
/**
* e_cal_component_set_percent_as_int:
+ * @comp: an #ECalComponent
+ * @percent: a percent to set, or -1 to remove the property
+ *
+ * Sets percent complete as integer. The @percent can be between 0 and 100, inclusive.
+ * A special value -1 can be used to remove the percent complete property.
*
* Since: 2.28
**/
@@ -3679,6 +3684,11 @@ e_cal_component_set_percent_as_int (ECalComponent *comp,
/**
* e_cal_component_get_percent_as_int:
+ * @comp: an #ECalComponent
+ *
+ * Get percent complete as an integer value
+ *
+ * Returns: percent complete as an integer value, -1 when the @comp doesn't have the property
*
* Since: 2.28
**/
diff --git a/calendar/libecal/e-cal-component.h b/calendar/libecal/e-cal-component.h
index b71eaa0..bfc9c19 100644
--- a/calendar/libecal/e-cal-component.h
+++ b/calendar/libecal/e-cal-component.h
@@ -49,15 +49,29 @@
G_BEGIN_DECLS
+/**
+ * ECalComponentId:
+ * @uid: UID of the component
+ * @rid: recurrence ID of the component; can be %NULL
+ **/
typedef struct {
gchar *uid;
gchar *rid;
} ECalComponentId;
-/* Types of calendar components to be stored by a ECalComponent, as per RFC 2445.
+/**
+ * ECalComponentVType:
+ * @E_CAL_COMPONENT_NO_TYPE: Unknown or unsupported component type
+ * @E_CAL_COMPONENT_EVENT: vEvent type
+ * @E_CAL_COMPONENT_TODO: vTodo type
+ * @E_CAL_COMPONENT_JOURNAL: vJournal type
+ * @E_CAL_COMPONENT_FREEBUSY: vFreeBusy type
+ * @E_CAL_COMPONENT_TIMEZONE: vTimezone type
+ *
+ * Types of calendar components to be stored by a ECalComponent, as per RFC 2445.
* We don't put the alarm component type here since we store alarms as separate
* structures inside the other "real" components.
- */
+ **/
typedef enum {
E_CAL_COMPONENT_NO_TYPE,
E_CAL_COMPONENT_EVENT,
@@ -67,9 +81,35 @@ typedef enum {
E_CAL_COMPONENT_TIMEZONE
} ECalComponentVType;
-/* Field identifiers for a calendar component; these are used by the data model
- * for ETable.
+/**
+ * ECalComponentField:
+ * @E_CAL_COMPONENT_FIELD_CATEGORIES: Concatenation of categories
+ * @E_CAL_COMPONENT_FIELD_CLASSIFICATION: Classification
+ * @E_CAL_COMPONENT_FIELD_COMPLETED: Completed
+ * @E_CAL_COMPONENT_FIELD_DTEND: Dtend
+ * @E_CAL_COMPONENT_FIELD_DTSTART: Dtstart
+ * @E_CAL_COMPONENT_FIELD_DUE: Due
+ * @E_CAL_COMPONENT_FIELD_GEO: Geo
+ * @E_CAL_COMPONENT_FIELD_PERCENT: Percent
+ * @E_CAL_COMPONENT_FIELD_PRIORITY: Priority
+ * @E_CAL_COMPONENT_FIELD_SUMMARY: Summary
+ * @E_CAL_COMPONENT_FIELD_TRANSPARENCY: Transparency
+ * @E_CAL_COMPONENT_FIELD_URL: URL
+ * @E_CAL_COMPONENT_FIELD_HAS_ALARMS: not a real field
+ * @E_CAL_COMPONENT_FIELD_ICON: not a real field
+ * @E_CAL_COMPONENT_FIELD_COMPLETE: not a real field
+ * @E_CAL_COMPONENT_FIELD_RECURRING: not a real field
+ * @E_CAL_COMPONENT_FIELD_OVERDUE: not a real field
+ * @E_CAL_COMPONENT_FIELD_COLOR: not a real field
+ * @E_CAL_COMPONENT_FIELD_STATUS: Status
+ * @E_CAL_COMPONENT_FIELD_COMPONENT: not a real field
+ * @E_CAL_COMPONENT_FIELD_LOCATION: Location
+ * @E_CAL_COMPONENT_FIELD_NUM_FIELDS: the last member
*
+ * Field identifiers for a calendar component.
+ **/
+
+/*
* NOTE: These are also used in the ETable specification, and the column
* numbers are saved in the user settings file. So don't reorder them!
*/
@@ -100,7 +140,16 @@ typedef enum {
/* Structures and enumerations to return properties and their parameters */
-/* CLASSIFICATION property */
+/**
+ * ECalComponentClassification:
+ * @E_CAL_COMPONENT_CLASS_NONE: None
+ * @E_CAL_COMPONENT_CLASS_PUBLIC: Public
+ * @E_CAL_COMPONENT_CLASS_PRIVATE: Private
+ * @E_CAL_COMPONENT_CLASS_CONFIDENTIAL: Confidential
+ * @E_CAL_COMPONENT_CLASS_UNKNOWN: Unknown
+ *
+ * CLASSIFICATION property
+ **/
typedef enum {
E_CAL_COMPONENT_CLASS_NONE,
E_CAL_COMPONENT_CLASS_PUBLIC,
@@ -110,6 +159,13 @@ typedef enum {
} ECalComponentClassification;
/* Properties that have time and timezone information */
+/**
+ * ECalComponentDateTime:
+ * @value: an icaltimetype value
+ * @tzid: a timezone ID for the @value
+ *
+ * Time with timezone property
+ **/
typedef struct {
/* Actual date/time value */
struct icaltimetype *value;
@@ -118,13 +174,25 @@ typedef struct {
const gchar *tzid;
} ECalComponentDateTime;
-/* Way in which a period of time is specified */
+/**
+ * ECalComponentPeriodType:
+ * @E_CAL_COMPONENT_PERIOD_DATETIME: Date and time
+ * @E_CAL_COMPONENT_PERIOD_DURATION: Duration
+ *
+ * Way in which a period of time is specified
+ **/
typedef enum {
E_CAL_COMPONENT_PERIOD_DATETIME,
E_CAL_COMPONENT_PERIOD_DURATION
} ECalComponentPeriodType;
-/* Period of time, can have explicit start/end times or start/duration instead */
+/**
+ * ECalComponentPeriod:
+ * @type: An #ECalComponentPeriodType
+ * @start: When the period starts
+ *
+ * Period of time, can have explicit start/end times or start/duration instead
+ **/
typedef struct {
ECalComponentPeriodType type;
@@ -136,20 +204,40 @@ typedef struct {
} u;
} ECalComponentPeriod;
-/* The type of range */
+/**
+ * ECalComponentRangeType:
+ * @E_CAL_COMPONENT_RANGE_SINGLE: Single
+ * @E_CAL_COMPONENT_RANGE_THISPRIOR: This and prior
+ * @E_CAL_COMPONENT_RANGE_THISFUTURE: This and future
+ *
+ * The type of range
+ **/
typedef enum {
E_CAL_COMPONENT_RANGE_SINGLE,
E_CAL_COMPONENT_RANGE_THISPRIOR,
E_CAL_COMPONENT_RANGE_THISFUTURE
} ECalComponentRangeType;
+/**
+ * ECalComponentRange:
+ * @type: an #ECalComponentRangeType
+ * @datetime: an #ECalComponentDateTime of the range
+ *
+ * Describes a range
+ **/
typedef struct {
ECalComponentRangeType type;
ECalComponentDateTime datetime;
} ECalComponentRange;
-/* Text properties */
+/**
+ * ECalComponentText:
+ * @value: Description string
+ * @altrep: Alternate representation URI
+ *
+ * For the text properties
+ **/
typedef struct {
/* Description string */
const gchar *value;
@@ -158,7 +246,15 @@ typedef struct {
const gchar *altrep;
} ECalComponentText;
-/* Time transparency */
+/**
+ * ECalComponentTransparency:
+ * @E_CAL_COMPONENT_TRANSP_NONE: None
+ * @E_CAL_COMPONENT_TRANSP_TRANSPARENT: Transparent
+ * @E_CAL_COMPONENT_TRANSP_OPAQUE: Opaque
+ * @E_CAL_COMPONENT_TRANSP_UNKNOWN: Unknown
+ *
+ * Time transparency
+ **/
typedef enum {
E_CAL_COMPONENT_TRANSP_NONE,
E_CAL_COMPONENT_TRANSP_TRANSPARENT,
@@ -166,7 +262,22 @@ typedef enum {
E_CAL_COMPONENT_TRANSP_UNKNOWN
} ECalComponentTransparency;
-/* Organizer & Attendee */
+/**
+ * ECalComponentAttendee:
+ * @value: usually a "mailto:email"; of the attendee
+ * @member: Member
+ * @cutype: Type of the attendee
+ * @role: Role of the attendee
+ * @status: Current status of the attendee
+ * @rsvp: Whether requires RSVP
+ * @delto: Delegated to
+ * @delfrom: Delegated from
+ * @sentby: Sent by
+ * @cn: Common name
+ * @language: Language
+ *
+ * Describes an attendee
+ **/
typedef struct {
const gchar *value;
@@ -183,6 +294,15 @@ typedef struct {
const gchar *language;
} ECalComponentAttendee;
+/**
+ * ECalComponentOrganizer:
+ * @value: usually a "mailto:email"; of the organizer
+ * @sentby: Sent by
+ * @cn: Common name
+ * @language: Language
+ *
+ * Describes an organizer
+ **/
typedef struct {
const gchar *value;
const gchar *sentby;
@@ -197,11 +317,13 @@ typedef struct _ECalComponentClass ECalComponentClass;
typedef struct _ECalComponentPrivate ECalComponentPrivate;
struct _ECalComponent {
+ /*< private >*/
GObject parent;
ECalComponentPrivate *priv;
};
struct _ECalComponentClass {
+ /*< private >*/
GObjectClass parent_class;
};
@@ -482,7 +604,15 @@ void e_cal_component_free_attendee_list
/* Opaque structure used to represent alarm subcomponents */
typedef struct _ECalComponentAlarm ECalComponentAlarm;
-/* An alarm occurrence, i.e. a trigger instance */
+/**
+ * ECalComponentAlarmInstance:
+ * @auid: UID of the alarm
+ * @trigger: Trigger time, i.e. "5 minutes before the appointment"
+ * @occur_start: Actual event occurrence start to which this trigger corresponds
+ * @occur_end: Actual event occurrence end to which this trigger corresponds
+ *
+ * An alarm occurrence, i.e. a trigger instance
+ **/
typedef struct {
/* UID of the alarm that triggered */
gchar *auid;
@@ -495,7 +625,13 @@ typedef struct {
time_t occur_end;
} ECalComponentAlarmInstance;
-/* Alarm trigger instances for a particular component */
+/**
+ * ECalComponentAlarms:
+ * @comp: The actual alarm component
+ * @alarms: (element-type: ECalComponentAlarmInstance): List of #ECalComponentAlarmInstance structures
+ *
+ * Alarm trigger instances for a particular component
+ **/
typedef struct {
/* The actual component */
ECalComponent *comp;
@@ -504,7 +640,17 @@ typedef struct {
GSList *alarms;
} ECalComponentAlarms;
-/* Alarm types */
+/**
+ * ECalComponentAlarmAction:
+ * @E_CAL_COMPONENT_ALARM_NONE: None
+ * @E_CAL_COMPONENT_ALARM_AUDIO: Audio
+ * @E_CAL_COMPONENT_ALARM_DISPLAY: Display message
+ * @E_CAL_COMPONENT_ALARM_EMAIL: Email
+ * @E_CAL_COMPONENT_ALARM_PROCEDURE: Procedure
+ * @E_CAL_COMPONENT_ALARM_UNKNOWN: Unknown
+ *
+ * Alarm types
+ **/
typedef enum {
E_CAL_COMPONENT_ALARM_NONE,
E_CAL_COMPONENT_ALARM_AUDIO,
@@ -514,7 +660,14 @@ typedef enum {
E_CAL_COMPONENT_ALARM_UNKNOWN
} ECalComponentAlarmAction;
-/* Whether a trigger is relative to the start or end of an event occurrence, or
+/**
+ * ECalComponentAlarmTriggerType:
+ * @E_CAL_COMPONENT_ALARM_TRIGGER_NONE: None
+ * @E_CAL_COMPONENT_ALARM_TRIGGER_RELATIVE_START: Relative to the start
+ * @E_CAL_COMPONENT_ALARM_TRIGGER_RELATIVE_END: Relative to the end
+ * @E_CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: Absolute
+ *
+ * Whether a trigger is relative to the start or end of an event occurrence, or
* whether it is specified to occur at an absolute time.
*/
typedef enum {
@@ -524,6 +677,12 @@ typedef enum {
E_CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE
} ECalComponentAlarmTriggerType;
+/**
+ * ECalComponentAlarmTrigger:
+ * @type: An #ECalComponentAlarmTriggerType
+ *
+ * When the alarm is supposed to be triggered
+ **/
typedef struct {
ECalComponentAlarmTriggerType type;
@@ -533,6 +692,13 @@ typedef struct {
} u;
} ECalComponentAlarmTrigger;
+/**
+ * ECalComponentAlarmRepeat:
+ * @repetitions: Number of extra repetitions, zero for none
+ * @duration: Interval between repetitions
+ *
+ * Whether and how the alarm repeats.
+ **/
typedef struct {
/* Number of extra repetitions, zero for none */
gint repetitions;
diff --git a/calendar/libecal/e-cal-types.h b/calendar/libecal/e-cal-types.h
index ad94d07..0a1bdaa 100644
--- a/calendar/libecal/e-cal-types.h
+++ b/calendar/libecal/e-cal-types.h
@@ -34,6 +34,7 @@ G_BEGIN_DECLS
* @E_CAL_CLIENT_SOURCE_TYPE_EVENTS: Events calander
* @E_CAL_CLIENT_SOURCE_TYPE_TASKS: Task list calendar
* @E_CAL_CLIENT_SOURCE_TYPE_MEMOS: Memo list calendar
+ * @E_CAL_CLIENT_SOURCE_TYPE_LAST: Artificial 'last' value of the enum
*
* Indicates the type of calendar
*
diff --git a/calendar/libecal/e-cal-util.h b/calendar/libecal/e-cal-util.h
index cad1fe5..5d96956 100644
--- a/calendar/libecal/e-cal-util.h
+++ b/calendar/libecal/e-cal-util.h
@@ -32,9 +32,15 @@
G_BEGIN_DECLS
-/* Instance of a calendar object. This can be an actual occurrence, a
+/**
+ * CalObjInstance:
+ * @uid: UID of the object
+ * @start: Start time of instance
+ * @end: End time of instance
+ *
+ * Instance of a calendar object. This can be an actual occurrence, a
* recurrence, or an alarm trigger of a `real' calendar object.
- */
+ **/
typedef struct {
gchar *uid; /* UID of the object */
time_t start; /* Start time of instance */
@@ -104,6 +110,7 @@ gboolean e_cal_util_event_dates_match (icalcomponent *icalcomp1,
/**
* CAL_STATIC_CAPABILITY_MEMO_START_DATE:
+ *
* Flag indicating that the backend does not support memo's start date
*
* Since: 3.12
diff --git a/calendar/libedata-cal/e-cal-backend-cache.c b/calendar/libedata-cal/e-cal-backend-cache.c
index 13182e2..2071abd 100644
--- a/calendar/libedata-cal/e-cal-backend-cache.c
+++ b/calendar/libedata-cal/e-cal-backend-cache.c
@@ -684,6 +684,8 @@ e_cal_backend_cache_get_key_value (ECalBackendCache *cache,
*
* Removes the cache directory
*
+ * Returns: %TRUE on success, %FALSE otherwise
+ *
* Since: 2.28
**/
gboolean
diff --git a/calendar/libedata-cal/e-cal-backend-sexp.c b/calendar/libedata-cal/e-cal-backend-sexp.c
index ecd1b65..3cd60fe 100644
--- a/calendar/libedata-cal/e-cal-backend-sexp.c
+++ b/calendar/libedata-cal/e-cal-backend-sexp.c
@@ -1580,6 +1580,8 @@ e_cal_backend_sexp_func_time_day_end (ESExp *esexp,
*
* Determines biggest time window given by expressions "occur-in-range" in sexp.
*
+ * Returns: %TRUE on success, %FALSE otherwise
+ *
* Since: 2.32
*/
gboolean
diff --git a/calendar/libedata-cal/e-cal-backend-sync.h b/calendar/libedata-cal/e-cal-backend-sync.h
index a84ac31..5dc6ae3 100644
--- a/calendar/libedata-cal/e-cal-backend-sync.h
+++ b/calendar/libedata-cal/e-cal-backend-sync.h
@@ -48,14 +48,45 @@ typedef struct _ECalBackendSync ECalBackendSync;
typedef struct _ECalBackendSyncClass ECalBackendSyncClass;
typedef struct _ECalBackendSyncPrivate ECalBackendSyncPrivate;
+/**
+ * ECalBackendSync:
+ *
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ **/
struct _ECalBackendSync {
+ /*< private >*/
ECalBackend parent;
ECalBackendSyncPrivate *priv;
};
+/**
+ * ECalBackendSyncClass:
+ * @open_sync: Open the calendar
+ * @refresh_sync: Refresh the calendar
+ * @set_backend_property_sync: Deprecated: Set backend property
+ * @get_object_sync: Get single object
+ * @get_object_list_sync: Get multiple objects at once
+ * @get_free_busy_sync: Get Free/Busy objects
+ * @create_objects_sync: Create objects
+ * @modify_objects_sync: Modify objects
+ * @remove_objects_sync: Remove objects
+ * @receive_objects_sync: Receive objects
+ * @send_objects_sync: Send objects
+ * @get_attachment_uris_sync: Get attachments uris for given object
+ * @discard_alarm_sync: Discard alarm
+ * @get_timezone_sync: Get specified timezone
+ * @add_timezone_sync: Add specified timezone
+ *
+ * Base class structure for the #ECalBackendSync class
+ *
+ * Since: 3.4
+ **/
struct _ECalBackendSyncClass {
+ /*< private >*/
ECalBackendClass parent_class;
+ /*< public >*/
/* Virtual methods */
void (*open_sync) (ECalBackendSync *backend,
EDataCal *cal,
diff --git a/calendar/libedata-cal/e-subprocess-cal-factory.c
b/calendar/libedata-cal/e-subprocess-cal-factory.c
index 3dffb4b..c268684 100644
--- a/calendar/libedata-cal/e-subprocess-cal-factory.c
+++ b/calendar/libedata-cal/e-subprocess-cal-factory.c
@@ -17,15 +17,11 @@
* Authors: Fabiano Fidêncio <fidencio redhat com>
*/
-/**
- * SECTION: e-subprocess-cal-factory
- * @include: libedata-cal/libedata-cal.h
- * @short_description: Responsible for #EBackend objects.
- *
+/*
* This class handles and creates #EBackend objects from inside
* their own subprocesses and also serves as the layer that does
* the communication between #EDataCalFactory and #EBackend
- **/
+ */
#ifdef HAVE_CONFIG_H
#include <config.h>
diff --git a/camel/camel-db.c b/camel/camel-db.c
index 72da7ed..48cef89 100644
--- a/camel/camel-db.c
+++ b/camel/camel-db.c
@@ -2754,7 +2754,7 @@ get_number_cb (gpointer data,
/**
* camel_db_maybe_run_maintenance:
* @cdb: a #CamelDB instance
- * @error: (allow none): a #GError or %NULL
+ * @error: (allow-none): a #GError or %NULL
*
* Runs a @cdb maintenance, which includes vacuum, if necessary.
*
diff --git a/camel/camel-enums.h b/camel/camel-enums.h
index 4c1dcf0..022a482 100644
--- a/camel/camel-enums.h
+++ b/camel/camel-enums.h
@@ -301,7 +301,7 @@ typedef enum {
} CamelProviderConfType;
/**
- * CamelProviderFlags;
+ * CamelProviderFlags:
* @CAMEL_PROVIDER_IS_REMOTE:
* Provider works with remote data.
* @CAMEL_PROVIDER_IS_LOCAL:
diff --git a/camel/camel-folder.c b/camel/camel-folder.c
index 9e9c14b..4f62c7b 100644
--- a/camel/camel-folder.c
+++ b/camel/camel-folder.c
@@ -2737,7 +2737,7 @@ folder_append_message_thread (GTask *task,
/**
* camel_folder_append_message:
- * @folder a #CamelFolder
+ * @folder: a #CamelFolder
* @message: a #CamelMimeMessage
* @info: a #CamelMessageInfo with additional flags/etc to set on the
* new message, or %NULL
@@ -3833,7 +3833,7 @@ folder_synchronize_message_thread (GTask *task,
}
/**
- * camel_folder_synchronize_message;
+ * camel_folder_synchronize_message:
* @folder: a #CamelFolder
* @message_uid: a message UID
* @io_priority: the I/O priority of the request
diff --git a/camel/camel-mime-filter-tohtml.c b/camel/camel-mime-filter-tohtml.c
index ef9ed68..ada8c34 100644
--- a/camel/camel-mime-filter-tohtml.c
+++ b/camel/camel-mime-filter-tohtml.c
@@ -45,13 +45,13 @@ struct _CamelMimeFilterToHTMLPrivate {
guint32 pre_open : 1;
};
-/**
+/*
* TODO: convert common text/plain 'markup' to html. eg.:
*
* _word_ -> <u>_word_</u>
* *word* -> <b>*word*</b>
* /word/ -> <i>/word/</i>
- **/
+ */
#define d(x)
diff --git a/camel/camel-store.c b/camel/camel-store.c
index cd2ddb5..177732d 100644
--- a/camel/camel-store.c
+++ b/camel/camel-store.c
@@ -215,10 +215,10 @@ store_emit_folder_info_stale_cb (gpointer user_data)
return FALSE;
}
-/**
+/*
* ignore_no_such_table_exception:
- * Clears the exception 'ex' when it's the 'no such table' exception.
- **/
+ * Clears the error 'error' when it's the 'no such table' error.
+ */
static void
ignore_no_such_table_exception (GError **error)
{
@@ -2910,7 +2910,7 @@ camel_store_synchronize_finish (CamelStore *store,
/**
* camel_store_maybe_run_db_maintenance:
* @store: a #CamelStore instance
- * @error: (allow none): return location for a #GError, or %NULL
+ * @error: (allow-none): return location for a #GError, or %NULL
*
* Checks the state of the current CamelDB used for the @store and eventually
* runs maintenance routines on it.
diff --git a/camel/providers/imapx/camel-imapx-search.c b/camel/providers/imapx/camel-imapx-search.c
index 640415a..f2dd1c8 100644
--- a/camel/providers/imapx/camel-imapx-search.c
+++ b/camel/providers/imapx/camel-imapx-search.c
@@ -629,7 +629,7 @@ camel_imapx_search_init (CamelIMAPXSearch *search)
/**
* camel_imapx_search_new:
- * imapx_store: a #CamelIMAPXStore to which the search belongs
+ * @imapx_store: a #CamelIMAPXStore to which the search belongs
*
* Returns a new #CamelIMAPXSearch instance.
*
diff --git a/docs/reference/camel/camel-sections.txt b/docs/reference/camel/camel-sections.txt
index fbcf5d1..88a11ad 100644
--- a/docs/reference/camel/camel-sections.txt
+++ b/docs/reference/camel/camel-sections.txt
@@ -1,4 +1,13 @@
<SECTION>
+<FILE>camel</FILE>
+<TITLE>Camel miscellaneous utilities</TITLE>
+camel_application_is_exiting
+camel_binding_bind_property
+camel_binding_bind_property_full
+camel_binding_bind_property_with_closures
+</SECTION>
+
+<SECTION>
<FILE>camel-address</FILE>
<TITLE>CamelAddress</TITLE>
CamelAddress
@@ -96,6 +105,8 @@ CamelCert
camel_cert_new
camel_cert_ref
camel_cert_unref
+camel_cert_load_cert_file
+camel_cert_save_cert_file
CamelCertDB
camel_certdb_new
camel_certdb_set_default
@@ -106,6 +117,7 @@ camel_certdb_save
camel_certdb_touch
camel_certdb_get_host
camel_certdb_put
+camel_certdb_list_certs
camel_certdb_remove_host
camel_certdb_clear
<SUBSECTION Standard>
@@ -304,6 +316,7 @@ camel_db_flush_in_memory_transactions
camel_db_get_folder_preview
camel_db_write_preview_record
camel_db_reset_folder_version
+camel_db_maybe_run_maintenance
<SUBSECTION Private>
CamelDBPrivate
</SECTION>
@@ -311,6 +324,7 @@ CamelDBPrivate
<SECTION>
<FILE>camel-filter-driver</FILE>
<TITLE>CamelFilterDriver</TITLE>
+camel_filter_status_t
CamelFilterDriver
CamelFilterGetFolderFunc
camel_filter_driver_new
@@ -755,6 +769,7 @@ camel_internet_address_find_name
camel_internet_address_find_address
camel_internet_address_encode_address
camel_internet_address_format_address
+camel_internet_address_ensure_ascii_domains
<SUBSECTION Standard>
CAMEL_INTERNET_ADDRESS
CAMEL_IS_INTERNET_ADDRESS
@@ -1441,6 +1456,7 @@ camel_network_settings_set_security_method
camel_network_settings_get_user
camel_network_settings_dup_user
camel_network_settings_set_user
+camel_network_settings_dup_host_ensure_ascii
<SUBSECTION Standard>
CAMEL_NETWORK_SETTINGS
CAMEL_IS_NETWORK_SETTINGS
@@ -1684,7 +1700,6 @@ CamelProviderConfType
CamelProviderConfEntry
CamelProviderPortEntry
CamelProviderAutoDetectFunc
-CamelProvider
CamelProviderModule
camel_provider_init
camel_provider_load
@@ -2114,6 +2129,7 @@ camel_store_rename_folder_finish
camel_store_synchronize_sync
camel_store_synchronize
camel_store_synchronize_finish
+camel_store_maybe_run_db_maintenance
<SUBSECTION Standard>
CAMEL_STORE
CAMEL_IS_STORE
@@ -2760,7 +2776,6 @@ camel_mktime_utc
camel_localtime_with_offset
CamelTransferEncoding
camel_header_references
-camel_header_param
CamelContentType
camel_header_raw
CamelContentDisposition
@@ -2980,6 +2995,7 @@ NI_NAMEREQD
NI_DGRAM
camel_getaddrinfo
camel_freeaddrinfo
+camel_host_idna_to_ascii
<SUBSECTION Private>
addrinfo
sockaddr
@@ -3358,6 +3374,30 @@ camel_imapx_command_queue_ref_by_tag
</SECTION>
<SECTION>
+<FILE>camel-imapx-conn-manager</FILE>
+<TITLE>CamelIMAPXConnManager</TITLE>
+CamelIMAPXConnManager
+camel_imapx_conn_manager_new
+camel_imapx_conn_manager_ref_store
+camel_imapx_conn_manager_get_connection
+camel_imapx_conn_manager_get_connections
+camel_imapx_conn_manager_update_con_info
+camel_imapx_conn_manager_close_connections
+camel_imapx_conn_manager_dump_queue_status
+<SUBSECTION Standard>
+CAMEL_IMAPX_CONN_MANAGER
+CAMEL_IMAPX_CONN_MANAGER_CLASS
+CAMEL_IMAPX_CONN_MANAGER_GET_CLASS
+CAMEL_IS_IMAPX_CONN_MANAGER
+CAMEL_IS_IMAPX_CONN_MANAGER_CLASS
+CAMEL_TYPE_IMAPX_CONN_MANAGER
+CamelIMAPXConnManagerClass
+camel_imapx_conn_manager_get_type
+<SUBSECTION Private>
+CamelIMAPXConnManagerPrivate
+</SECTION>
+
+<SECTION>
<FILE>camel-imapx-folder</FILE>
<TITLE>CamelIMAPXFolder</TITLE>
CamelIMAPXFolder
@@ -3369,6 +3409,8 @@ camel_imapx_folder_copy_message_map
camel_imapx_folder_add_move_to_real_junk
camel_imapx_folder_add_move_to_real_trash
camel_imapx_folder_invalidate_local_cache
+camel_imapx_folder_get_check_folder
+camel_imapx_folder_set_check_folder
<SUBSECTION Standard>
CAMEL_IMAPX_FOLDER
CAMEL_IS_IMAPX_FOLDER
@@ -3438,6 +3480,7 @@ camel_imapx_job_ref_mailbox
camel_imapx_job_set_mailbox
camel_imapx_job_get_cancellable
camel_imapx_job_take_error
+camel_imapx_job_set_error_if_failed
<SUBSECTION Private>
uidset_state
</SECTION>
@@ -3542,6 +3585,14 @@ camel_imapx_mailbox_has_attribute
camel_imapx_mailbox_handle_list_response
camel_imapx_mailbox_handle_lsub_response
camel_imapx_mailbox_handle_status_response
+camel_imapx_mailbox_dup_folder_path
+camel_imapx_mailbox_get_permanentflags
+camel_imapx_mailbox_set_permanentflags
+CamelIMAPXMailboxState
+camel_imapx_mailbox_get_state
+camel_imapx_mailbox_set_state
+camel_imapx_mailbox_lock_update
+camel_imapx_mailbox_unlock_update
<SUBSECTION Standard>
CAMEL_IMAPX_MAILBOX
CAMEL_IS_IMAPX_MAILBOX
@@ -3565,6 +3616,8 @@ camel_imapx_namespace_equal
camel_imapx_namespace_get_category
camel_imapx_namespace_get_prefix
camel_imapx_namespace_get_separator
+camel_imapx_namespace_response_add
+camel_imapx_namespace_response_remove
<SUBSECTION Standard>
CAMEL_IMAPX_NAMESPACE
CAMEL_IS_IMAPX_NAMESPACE
@@ -3607,6 +3660,7 @@ CamelIMAPXSearch
camel_imapx_search_new
camel_imapx_search_ref_store
camel_imapx_search_set_store
+camel_imapx_search_set_cancellable_and_error
<SUBSECTION Standard>
CAMEL_IMAPX_SEARCH
CAMEL_IS_IMAPX_SEARCH
@@ -3649,6 +3703,15 @@ camel_imapx_server_subscribe_mailbox
camel_imapx_server_unsubscribe_mailbox
camel_imapx_server_update_quota_info
camel_imapx_server_uid_search
+camel_imapx_server_dump_queue_status
+camel_imapx_server_folder_name_in_jobs
+camel_imapx_server_get_command_count
+camel_imapx_server_has_expensive_command
+camel_imapx_server_is_connected
+camel_imapx_server_ref_job
+CamelIMAPXServerError
+CAMEL_IMAPX_SERVER_ERROR
+camel_imapx_server_error_quark
CamelIMAPXUntaggedRespHandlerDesc
camel_imapx_server_register_untagged_handler
<SUBSECTION Standard>
@@ -3710,6 +3773,12 @@ camel_imapx_settings_get_use_shell_command
camel_imapx_settings_set_use_shell_command
camel_imapx_settings_get_use_subscriptions
camel_imapx_settings_set_use_subscriptions
+camel_imapx_settings_get_concurrent_connections
+camel_imapx_settings_get_ignore_other_users_namespace
+camel_imapx_settings_get_ignore_shared_folders_namespace
+camel_imapx_settings_set_concurrent_connections
+camel_imapx_settings_set_ignore_other_users_namespace
+camel_imapx_settings_set_ignore_shared_folders_namespace
<SUBSECTION Standard>
CAMEL_IMAPX_SETTINGS
CAMEL_IS_IMAPX_SETTINGS
@@ -3755,6 +3824,19 @@ CamelIMAPXStore
camel_imapx_store_ref_server
camel_imapx_store_dup_quota_info
camel_imapx_store_set_quota_info
+camel_imapx_store_dump_queue_status
+camel_imapx_store_emit_mailbox_updated
+camel_imapx_store_folder_op_done
+camel_imapx_store_handle_list_response
+camel_imapx_store_handle_lsub_response
+camel_imapx_store_handle_mailbox_rename
+camel_imapx_store_is_connecting_concurrent_connection
+camel_imapx_store_list_mailboxes
+camel_imapx_store_ref_job
+camel_imapx_store_ref_mailbox
+camel_imapx_store_ref_namespaces
+camel_imapx_store_set_connecting_server
+camel_imapx_store_set_namespaces
<SUBSECTION Standard>
CAMEL_IMAPX_STORE
CAMEL_IS_IMAPX_STORE
diff --git a/docs/reference/eds/eds-sections.txt b/docs/reference/eds/eds-sections.txt
index 1825096..9139209 100644
--- a/docs/reference/eds/eds-sections.txt
+++ b/docs/reference/eds/eds-sections.txt
@@ -30,6 +30,11 @@ e_backend_trust_prompt_finish
e_backend_get_destination_address
e_backend_is_destination_reachable
e_backend_prepare_shutdown
+e_backend_credentials_required
+e_backend_credentials_required_finish
+e_backend_credentials_required_sync
+e_backend_schedule_authenticate
+e_backend_schedule_credentials_required
<SUBSECTION Standard>
EBackendPrivate
E_BACKEND
@@ -320,6 +325,7 @@ e_book_backend_sexp_get_type
<SECTION>
<FILE>e-book-sqlite</FILE>
<TITLE>EBookSqlite</TITLE>
+E_BOOK_SQL_SYNC_DATA_KEY
E_BOOK_SQLITE_ERROR
EbSqlChangeType
EbSqlChangeCallback
@@ -341,6 +347,7 @@ e_book_sqlite_unlock
e_book_sqlite_set_locale
e_book_sqlite_get_locale
e_book_sqlite_ref_collator
+e_book_sqlite_ref_source
e_book_sqlite_add_contact
e_book_sqlite_add_contacts
e_book_sqlite_remove_contact
@@ -363,6 +370,9 @@ e_book_sqlite_cursor_set_target_alphabetic_index
e_book_sqlite_cursor_set_sexp
e_book_sqlite_cursor_calculate
e_book_sqlite_cursor_compare_contact
+ebsql_get_contact_extra_unlocked
+ebsql_get_contact_unlocked
+ebsql_get_vcard_unlocked
EbSqlCursor
<SUBSECTION Standard>
EBookSqlitePrivate
@@ -1408,6 +1418,8 @@ e_cal_util_component_has_rdates
e_cal_util_component_has_rrules
e_cal_util_component_has_attendee
e_cal_util_event_dates_match
+e_cal_util_is_first_instance
+e_cal_util_split_at_instance
CAL_STATIC_CAPABILITY_NO_ALARM_REPEAT
CAL_STATIC_CAPABILITY_NO_AUDIO_ALARMS
CAL_STATIC_CAPABILITY_NO_DISPLAY_ALARMS
@@ -1528,6 +1540,12 @@ e_client_get_backend_property_sync
e_client_refresh
e_client_refresh_finish
e_client_refresh_sync
+e_client_retrieve_properties
+e_client_retrieve_properties_finish
+e_client_retrieve_properties_sync
+e_client_wait_for_connected
+e_client_wait_for_connected_finish
+e_client_wait_for_connected_sync
e_client_util_parse_comma_strings
e_client_dup_bus_name
e_client_set_bus_name
@@ -1616,6 +1634,7 @@ e_collection_backend_create_resource_finish
e_collection_backend_delete_resource_sync
e_collection_backend_delete_resource
e_collection_backend_delete_resource_finish
+e_collection_backend_authenticate_children
<SUBSECTION Standard>
ECollectionBackendPrivate
E_COLLECTION_BACKEND
@@ -1701,6 +1720,7 @@ e_contact_pretty_name
e_contact_vcard_attribute
e_contact_field_id
e_contact_field_id_from_vcard
+e_contact_field_is_string
<SUBSECTION Standard>
EContactPrivate
E_CONTACT
@@ -2073,6 +2093,8 @@ e_util_utf8_data_make_valid
e_util_utf8_normalize
e_util_ensure_gdbus_string
e_util_gthread_id
+e_util_safe_free_string
+e_util_win32_initialize
e_filename_make_safe
e_filename_mkdir_encoded
e_utf8_strftime
@@ -2098,8 +2120,10 @@ e_util_get_prefix
e_util_get_cp_prefix
e_util_get_localedir
e_util_replace_prefix
+E_TYPE_NAMED_PARAMETERS
e_named_parameters_new
e_named_parameters_new_strv
+e_named_parameters_new_clone
e_named_parameters_free
e_named_parameters_clear
e_named_parameters_assign
@@ -2119,6 +2143,9 @@ e_util_copy_string_slist
e_util_copy_object_slist
e_data_server_util_get_dbus_call_timeout
e_data_server_util_set_dbus_call_timeout
+e_binding_bind_property
+e_binding_bind_property_full
+e_binding_bind_property_with_closures
ENamedParameters
EAsyncClosure
tm
@@ -2326,6 +2353,14 @@ e_flag_timed_wait
</SECTION>
<SECTION>
+<FILE>e-free-form-exp</FILE>
+<TITLE>EFreeFormExp</TITLE>
+EFreeFormExpBuildSexpFunc
+EFreeFormExpSymbol
+e_free_form_exp_to_sexp
+</SECTION>
+
+<SECTION>
<FILE>e-gdbus-templates</FILE>
<TITLE>EGdbusAsyncOpKeeper</TITLE>
e_gdbus_templates_init_main_thread
@@ -2730,6 +2765,23 @@ e_server_side_source_get_type
</SECTION>
<SECTION>
+<FILE>e-server-side-source-credentials-provider</FILE>
+<TITLE>EServerSideSourceCredentialsProvider</TITLE>
+EServerSideSourceCredentialsProvider
+EServerSideSourceCredentialsProviderClass
+e_server_side_source_credentials_provider_new
+<SUBSECTION Standard>
+EServerSideSourceCredentialsProviderPrivate
+E_IS_SERVER_SIDE_SOURCE_CREDENTIALS_PROVIDER
+E_IS_SERVER_SIDE_SOURCE_CREDENTIALS_PROVIDER_CLASS
+E_SERVER_SIDE_SOURCE_CREDENTIALS_PROVIDER
+E_SERVER_SIDE_SOURCE_CREDENTIALS_PROVIDER_CLASS
+E_SERVER_SIDE_SOURCE_CREDENTIALS_PROVIDER_GET_CLASS
+E_TYPE_SERVER_SIDE_SOURCE_CREDENTIALS_PROVIDER
+e_server_side_source_credentials_provider_get_type
+</SECTION>
+
+<SECTION>
<FILE>e-sexp</FILE>
<TITLE>ESExp</TITLE>
ESExpResultType
@@ -2798,6 +2850,9 @@ e_soup_ssl_trust_connect
<FILE>e-source</FILE>
<TITLE>ESource</TITLE>
E_SOURCE_PARAM_SETTING
+E_SOURCE_CREDENTIAL_USERNAME
+E_SOURCE_CREDENTIAL_PASSWORD
+E_SOURCE_CREDENTIAL_SSL_TRUST
ESource
ESourceClass
e_source_new
@@ -2851,6 +2906,24 @@ e_source_lookup_password_finish
e_source_delete_password_sync
e_source_delete_password
e_source_delete_password_finish
+e_source_get_connection_status
+e_source_set_connection_status
+e_source_emit_credentials_required
+e_source_get_last_credentials_required_arguments
+e_source_get_last_credentials_required_arguments_finish
+e_source_get_last_credentials_required_arguments_sync
+e_source_unset_last_credentials_required_arguments
+e_source_unset_last_credentials_required_arguments_finish
+e_source_unset_last_credentials_required_arguments_sync
+e_source_invoke_authenticate
+e_source_invoke_authenticate_finish
+e_source_invoke_authenticate_sync
+e_source_invoke_credentials_required
+e_source_invoke_credentials_required_finish
+e_source_invoke_credentials_required_sync
+ESourceConnectionStatus
+E_TYPE_SOURCE_CONNECTION_STATUS
+e_source_connection_status_get_type
<SUBSECTION Standard>
ESourcePrivate
E_IS_SOURCE
@@ -2925,6 +2998,9 @@ e_source_authentication_set_remember_password
e_source_authentication_get_user
e_source_authentication_dup_user
e_source_authentication_set_user
+e_source_authentication_dup_credential_name
+e_source_authentication_get_credential_name
+e_source_authentication_set_credential_name
<SUBSECTION Standard>
ESourceAuthenticationPrivate
E_IS_SOURCE_AUTHENTICATION
@@ -2998,6 +3074,26 @@ e_source_backend_summary_setup_get_type
</SECTION>
<SECTION>
+<FILE>e-source-contacts</FILE>
+<TITLE>ESourceContacts</TITLE>
+E_SOURCE_EXTENSION_CONTACTS_BACKEND
+ESourceContacts
+ESourceContactsClass
+e_source_contacts_get_type
+e_source_contacts_get_include_me
+e_source_contacts_set_include_me
+<SUBSECTION Standard>
+ESourceContactsPrivate
+E_IS_SOURCE_CONTACTS
+E_IS_SOURCE_CONTACTS_CLASS
+E_SOURCE_CONTACTS
+E_SOURCE_CONTACTS_CLASS
+E_SOURCE_CONTACTS_GET_CLASS
+E_TYPE_SOURCE_CONTACTS
+e_source_address_book_get_type
+</SECTION>
+
+<SECTION>
<FILE>e-source-calendar</FILE>
<TITLE>ESourceCalendar</TITLE>
E_SOURCE_EXTENSION_CALENDAR
@@ -3097,6 +3193,75 @@ e_source_collection_get_type
</SECTION>
<SECTION>
+<FILE>e-source-credentials-provider</FILE>
+<TITLE>ESourceCredentialsProvider</TITLE>
+ESourceCredentialsProvider
+ESourceCredentialsProviderClass
+e_source_credentials_provider_new
+e_source_credentials_provider_ref_credentials_source
+e_source_credentials_provider_ref_registry
+e_source_credentials_provider_ref_source
+e_source_credentials_provider_can_prompt
+e_source_credentials_provider_can_store
+e_source_credentials_provider_delete
+e_source_credentials_provider_delete_finish
+e_source_credentials_provider_delete_sync
+e_source_credentials_provider_lookup
+e_source_credentials_provider_lookup_finish
+e_source_credentials_provider_lookup_sync
+e_source_credentials_provider_store
+e_source_credentials_provider_store_finish
+e_source_credentials_provider_store_sync
+e_source_credentials_provider_register_impl
+e_source_credentials_provider_unregister_impl
+ESourceCredentialsReason
+E_TYPE_SOURCE_CREDENTIALS_REASON
+e_source_credentials_reason_get_type
+<SUBSECTION Standard>
+ESourceCredentialsProviderPrivate
+E_IS_SOURCE_CREDENTIALS_PROVIDER
+E_IS_SOURCE_CREDENTIALS_PROVIDER_CLASS
+E_SOURCE_CREDENTIALS_PROVIDER
+E_SOURCE_CREDENTIALS_PROVIDER_CLASS
+E_SOURCE_CREDENTIALS_PROVIDER_GET_CLASS
+E_TYPE_SOURCE_CREDENTIALS_PROVIDER
+e_source_credentials_provider_get_type
+</SECTION>
+
+<SECTION>
+<FILE>e-source-credentials-provider-impl</FILE>
+<TITLE>ESourceCredentialsProviderImpl</TITLE>
+ESourceCredentialsProviderImpl
+ESourceCredentialsProviderImplClass
+ESourceCredentialsProviderImplPassword
+ESourceCredentialsProviderImplPasswordClass
+e_source_credentials_provider_impl_get_provider
+e_source_credentials_provider_impl_can_process
+e_source_credentials_provider_impl_can_prompt
+e_source_credentials_provider_impl_can_store
+e_source_credentials_provider_impl_lookup_sync
+e_source_credentials_provider_impl_store_sync
+e_source_credentials_provider_impl_delete_sync
+<SUBSECTION Standard>
+ESourceCredentialsProviderImplPrivate
+E_IS_SOURCE_CREDENTIALS_PROVIDER_IMPL
+E_IS_SOURCE_CREDENTIALS_PROVIDER_IMPL_CLASS
+E_SOURCE_CREDENTIALS_PROVIDER_IMPL
+E_SOURCE_CREDENTIALS_PROVIDER_IMPL_CLASS
+E_SOURCE_CREDENTIALS_PROVIDER_IMPL_GET_CLASS
+E_TYPE_SOURCE_CREDENTIALS_PROVIDER_IMPL
+e_source_credentials_provider_impl_get_type
+ESourceCredentialsProviderImplPasswordPrivate
+E_IS_SOURCE_CREDENTIALS_PROVIDER_IMPL_PASSWORD
+E_IS_SOURCE_CREDENTIALS_PROVIDER_IMPL_PASSWORD_CLASS
+E_SOURCE_CREDENTIALS_PROVIDER_IMPL_PASSWORD
+E_SOURCE_CREDENTIALS_PROVIDER_IMPL_PASSWORD_CLASS
+E_SOURCE_CREDENTIALS_PROVIDER_IMPL_PASSWORD_GET_CLASS
+E_TYPE_SOURCE_CREDENTIALS_PROVIDER_IMPL_PASSWORD
+e_source_credentials_provider_impl_password_get_type
+</SECTION>
+
+<SECTION>
<FILE>e-source-enums</FILE>
EMdnResponsePolicy
EProxyMethod
@@ -3133,6 +3298,8 @@ E_SOURCE_EXTENSION_CLASS
E_SOURCE_EXTENSION_GET_CLASS
E_TYPE_SOURCE_EXTENSION
e_source_extension_get_type
+e_source_extension_property_lock
+e_source_extension_property_unlock
</SECTION>
<SECTION>
@@ -3162,6 +3329,69 @@ e_source_goa_get_type
</SECTION>
<SECTION>
+<FILE>e-source-ldap</FILE>
+<TITLE>ESourceLDAP</TITLE>
+E_SOURCE_EXTENSION_LDAP_BACKEND
+ESourceLDAP
+ESourceLDAPClass
+ESourceLDAPAuthentication
+E_TYPE_SOURCE_LDAP_AUTHENTICATION
+e_source_ldap_authentication_get_type
+ESourceLDAPScope
+E_TYPE_SOURCE_LDAP_SCOPE
+e_source_ldap_scope_get_type
+ESourceLDAPSecurity
+E_TYPE_SOURCE_LDAP_SECURITY
+e_source_ldap_security_get_type
+e_source_ldap_dup_filter
+e_source_ldap_dup_root_dn
+e_source_ldap_get_authentication
+e_source_ldap_get_can_browse
+e_source_ldap_get_filter
+e_source_ldap_get_limit
+e_source_ldap_get_root_dn
+e_source_ldap_get_scope
+e_source_ldap_get_security
+e_source_ldap_get_type
+e_source_ldap_set_authentication
+e_source_ldap_set_can_browse
+e_source_ldap_set_filter
+e_source_ldap_set_limit
+e_source_ldap_set_root_dn
+e_source_ldap_set_scope
+e_source_ldap_set_security
+<SUBSECTION Standard>
+ESourceLDAPPrivate
+E_IS_SOURCE_LDAP
+E_IS_SOURCE_LDAP_CLASS
+E_SOURCE_LDAP
+E_SOURCE_LDAP_CLASS
+E_SOURCE_LDAP_GET_CLASS
+E_TYPE_SOURCE_LDAP
+e_source_autocomplete_get_type
+</SECTION>
+
+<SECTION>
+<FILE>e-source-local</FILE>
+<TITLE>ESourceLocal</TITLE>
+E_SOURCE_EXTENSION_LOCAL_BACKEND
+ESourceLocal
+ESourceLocalClass
+e_source_local_dup_custom_file
+e_source_local_get_custom_file
+e_source_local_set_custom_file
+<SUBSECTION Standard>
+ESourceLocalPrivate
+E_IS_SOURCE_LOCAL
+E_IS_SOURCE_LOCAL_CLASS
+E_SOURCE_LOCAL
+E_SOURCE_LOCAL_CLASS
+E_SOURCE_LOCAL_GET_CLASS
+E_TYPE_SOURCE_LOCAL
+e_source_local_get_type
+</SECTION>
+
+<SECTION>
<FILE>e-source-mail-account</FILE>
<TITLE>ESourceMailAccount</TITLE>
E_SOURCE_EXTENSION_MAIL_ACCOUNT
@@ -3170,6 +3400,9 @@ ESourceMailAccountClass
e_source_mail_account_get_identity_uid
e_source_mail_account_dup_identity_uid
e_source_mail_account_set_identity_uid
+e_source_mail_account_dup_archive_folder
+e_source_mail_account_get_archive_folder
+e_source_mail_account_set_archive_folder
<SUBSECTION Standard>
ESourceMailAccountPrivate
E_IS_SOURCE_MAIL_ACCOUNT
@@ -3370,6 +3603,8 @@ e_source_openpgp_dup_signing_algorithm
e_source_openpgp_set_signing_algorithm
e_source_openpgp_get_sign_by_default
e_source_openpgp_set_sign_by_default
+e_source_openpgp_get_encrypt_by_default
+e_source_openpgp_set_encrypt_by_default
<SUBSECTION Standard>
ESourceOpenPGPPrivate
E_IS_SOURCE_OPENPGP
@@ -3506,6 +3741,8 @@ e_source_registry_ref_default_task_list
e_source_registry_set_default_task_list
e_source_registry_ref_default_for_extension_name
e_source_registry_set_default_for_extension_name
+e_source_registry_debug_enabled
+e_source_registry_debug_print
<SUBSECTION Standard>
ESourceRegistryPrivate
E_IS_SOURCE_REGISTRY
@@ -3537,6 +3774,7 @@ e_source_registry_server_find_extension
e_source_registry_server_ref_backend
e_source_registry_server_ref_backend_factory
e_source_registry_server_load_all
+e_source_registry_server_ref_credentials_provider
<SUBSECTION Standard>
ESourceRegistryServerPrivate
E_IS_SOURCE_REGISTRY_SERVER
@@ -3682,6 +3920,31 @@ e_source_uoa_get_type
</SECTION>
<SECTION>
+<FILE>e-source-weather</FILE>
+<TITLE>ESourceWeather</TITLE>
+E_SOURCE_EXTENSION_WEATHER_BACKEND
+ESourceWeather
+ESourceWeatherClass
+ESourceWeatherUnits
+E_TYPE_SOURCE_WEATHER_UNITS
+e_source_weather_units_get_type
+e_source_weather_dup_location
+e_source_weather_get_location
+e_source_weather_get_units
+e_source_weather_set_location
+e_source_weather_set_units
+<SUBSECTION Standard>
+ESourceWeatherPrivate
+E_IS_SOURCE_WEATHER
+E_IS_SOURCE_WEATHER_CLASS
+E_SOURCE_WEATHER
+E_SOURCE_WEATHER_CLASS
+E_SOURCE_WEATHER_GET_CLASS
+E_TYPE_SOURCE_WEATHER
+e_source_weather_get_type
+</SECTION>
+
+<SECTION>
<FILE>e-source-webdav</FILE>
<TITLE>ESourceWebdav</TITLE>
E_SOURCE_EXTENSION_WEBDAV_BACKEND
@@ -3709,6 +3972,8 @@ e_source_webdav_set_ssl_trust
e_source_webdav_dup_soup_uri
e_source_webdav_set_soup_uri
e_source_webdav_unset_temporary_ssl_trust
+e_source_webdav_update_ssl_trust
+e_source_webdav_verify_ssl_trust
<SUBSECTION Standard>
ESourceWebdavPrivate
E_IS_SOURCE_WEBDAV
@@ -3721,6 +3986,59 @@ e_source_webdav_get_type
</SECTION>
<SECTION>
+<FILE>e-webdav-discover</FILE>
+<TITLE>WebDAV Sources Discover</TITLE>
+EWebDAVDiscoverSupports
+EWebDAVDiscoveredSource
+e_webdav_discover_free_discovered_sources
+e_webdav_discover_sources
+e_webdav_discover_sources_finish
+e_webdav_discover_sources_sync
+</SECTION>
+
+<SECTION>
+<FILE>e-subprocess-factory</FILE>
+<TITLE>ESubprocessFactory</TITLE>
+E_TYPE_SUBPROCESS_FACTORY
+</SECTION>
+
+<SECTION>
+<FILE>e-subprocess-book-factory</FILE>
+<TITLE>ESubprocessBookFactory</TITLE>
+EDS_SUBPROCESS_BOOK_PATH
+ESubprocessBookFactory
+ESubprocessBookFactoryClass
+e_subprocess_book_factory_new
+<SUBSECTION Standard>
+ESubprocessBookFactoryPrivate
+E_IS_SUBPROCESS_BOOK_FACTORY
+E_IS_SUBPROCESS_BOOK_FACTORY_CLASS
+E_SUBPROCESS_BOOK_FACTORY
+E_SUBPROCESS_BOOK_FACTORY_CLASS
+E_SUBPROCESS_BOOK_FACTORY_GET_CLASS
+E_TYPE_SUBPROCESS_BOOK_FACTORY
+e_subprocess_book_factory_get_type
+</SECTION>
+
+<SECTION>
+<FILE>e-subprocess-cal-factory</FILE>
+<TITLE>ESubprocessCalFactory</TITLE>
+EDS_SUBPROCESS_CAL_PATH
+ESubprocessCalFactory
+ESubprocessCalFactoryClass
+e_subprocess_cal_factory_new
+<SUBSECTION Standard>
+ESubprocessCalFactoryPrivate
+E_IS_SUBPROCESS_CAL_FACTORY
+E_IS_SUBPROCESS_CAL_FACTORY_CLASS
+E_SUBPROCESS_CAL_FACTORY
+E_SUBPROCESS_CAL_FACTORY_CLASS
+E_SUBPROCESS_CAL_FACTORY_GET_CLASS
+E_TYPE_SUBPROCESS_CAL_FACTORY
+e_subprocess_cal_factory_get_type
+</SECTION>
+
+<SECTION>
<FILE>e-sqlite3-vfs</FILE>
<TITLE>SQLite vfs</TITLE>
e_sqlite3_vfs_init
@@ -4052,6 +4370,7 @@ eds_check_version
E_DATA_SERVER_EXTENSIONDIR
E_DATA_SERVER_IMAGESDIR
E_DATA_SERVER_UI_UIDIR
+E_DATA_SERVER_CREDENTIALMODULEDIR
</SECTION>
<SECTION>
diff --git a/libebackend/e-backend-factory.h b/libebackend/e-backend-factory.h
index 6619694..47b1550 100644
--- a/libebackend/e-backend-factory.h
+++ b/libebackend/e-backend-factory.h
@@ -68,6 +68,8 @@ struct _EBackendFactory {
* EBackendFactoryClass:
* @get_hash_key: Get the hash key for this factory
* @new_backend: Create a new #EBackend of the appropriate type for the passed #ESource
+ * @e_module: An #EModule associated with this backend factory
+ * @share_subprocess: Whether subporcesses for this backend factory should share one process
*
* Base class structure for the #EBackendFactory class
*
diff --git a/libebackend/e-backend.c b/libebackend/e-backend.c
index 9593f27..8b7efcd 100644
--- a/libebackend/e-backend.c
+++ b/libebackend/e-backend.c
@@ -901,7 +901,7 @@ e_backend_ref_main_context (EBackend *backend)
* @reason: an #ESourceCredentialsReason, why the credentials are required
* @certificate_pem: PEM-encoded secure connection certificate, or an empty string
* @certificate_errors: a bit-or of #GTlsCertificateFlags for secure connection certificate
- * @op_error: (allow none): a #GError with a description of the previous credentials error, or %NULL
+ * @op_error: (allow-none): a #GError with a description of the previous credentials error, or %NULL
* @cancellable: optional #GCancellable object, or %NULL
* @error: return location for a #GError, or %NULL
*
@@ -985,9 +985,8 @@ backend_credentials_required_thread (GTask *task,
* @reason: an #ESourceCredentialsReason, why the credentials are required
* @certificate_pem: PEM-encoded secure connection certificate, or an empty string
* @certificate_errors: a bit-or of #GTlsCertificateFlags for secure connection certificate
- * @op_error: (allow none): a #GError with a description of the previous credentials error, or %NULL
+ * @op_error: (allow-none): a #GError with a description of the previous credentials error, or %NULL
* @cancellable: optional #GCancellable object, or %NULL
- * @error: return location for a #GError, or %NULL
*
* Asynchronously calls the e_backend_credentials_required_sync() on the @backend,
* to inform clients that credentials are required.
@@ -1082,9 +1081,9 @@ backend_scheduled_credentials_required_done_cb (GObject *source_object,
* @reason: an #ESourceCredentialsReason, why the credentials are required
* @certificate_pem: PEM-encoded secure connection certificate, or an empty string
* @certificate_errors: a bit-or of #GTlsCertificateFlags for secure connection certificate
- * @op_error: (allow none): a #GError with a description of the previous credentials error, or %NULL
+ * @op_error: (allow-none): a #GError with a description of the previous credentials error, or %NULL
* @cancellable: optional #GCancellable object, or %NULL
- * @who_calls: (allow none): an identification who calls this
+ * @who_calls: (allow-none): an identification who calls this
*
* Asynchronously invokes e_backend_credentials_required(), but installs its
* own callback which only prints a runtime warning on the console when
@@ -1112,7 +1111,7 @@ e_backend_schedule_credentials_required (EBackend *backend,
/**
* e_backend_schedule_authenticate:
* @backend: an #EBackend
- * @credentials: (allow none): a credentials to use to authenticate, or %NULL
+ * @credentials: (allow-none): a credentials to use to authenticate, or %NULL
*
* Schedules a new authenticate session, cancelling any previously run.
* This is usually done automatically, when an 'authenticate' signal is
diff --git a/libebackend/e-backend.h b/libebackend/e-backend.h
index bed359a..c9eca51 100644
--- a/libebackend/e-backend.h
+++ b/libebackend/e-backend.h
@@ -69,9 +69,8 @@ struct _EBackend {
/**
* EBackendClass:
* @authenticate_sync: Authenticate synchronously
- * @authenticate: Initiate authentication
- * @authenticate_finish: Complete authentication
* @get_destination_address: Fetch the destination address
+ * @prepare_shutdown: Prepare for shutdown
*
* Base class structure for the #EBackend class
*
diff --git a/libebackend/e-collection-backend-factory.h b/libebackend/e-collection-backend-factory.h
index 255e0a2..4ef1814 100644
--- a/libebackend/e-collection-backend-factory.h
+++ b/libebackend/e-collection-backend-factory.h
@@ -58,11 +58,13 @@ typedef struct _ECollectionBackendFactoryPrivate ECollectionBackendFactoryPrivat
* Since: 3.6
**/
struct _ECollectionBackendFactory {
+ /*< private >*/
EBackendFactory parent;
ECollectionBackendFactoryPrivate *priv;
};
struct _ECollectionBackendFactoryClass {
+ /*< private >*/
EBackendFactoryClass parent_class;
const gchar *factory_name;
@@ -74,6 +76,7 @@ struct _ECollectionBackendFactoryClass {
ESource *mail_identity_source,
ESource *mail_transport_source);
+ /*< private >*/
gpointer reserved[16];
};
diff --git a/libebackend/e-collection-backend.h b/libebackend/e-collection-backend.h
index adb44bb..410b2a3 100644
--- a/libebackend/e-collection-backend.h
+++ b/libebackend/e-collection-backend.h
@@ -60,11 +60,13 @@ typedef struct _ECollectionBackendPrivate ECollectionBackendPrivate;
* Since: 3.6
**/
struct _ECollectionBackend {
+ /*< private >*/
EBackend parent;
ECollectionBackendPrivate *priv;
};
struct _ECollectionBackendClass {
+ /*< private >*/
EBackendClass parent_class;
/* Methods */
@@ -106,6 +108,7 @@ struct _ECollectionBackendClass {
GAsyncResult *result,
GError **error);
+ /*< private >*/
gpointer reserved[10];
};
diff --git a/libebackend/e-subprocess-factory.c b/libebackend/e-subprocess-factory.c
index 3363ffe..8a935ae 100644
--- a/libebackend/e-subprocess-factory.c
+++ b/libebackend/e-subprocess-factory.c
@@ -480,11 +480,11 @@ e_subprocess_factory_set_backend_callbacks (ESubprocessFactory *subprocess_facto
g_return_if_fail (backend != NULL);
g_return_if_fail (E_DBUS_SUBPROCESS_IS_BACKEND (proxy));
- /**
+ /*
* Install a toggle reference on the backend
* so we can signal it to shutdown once all
* client connections are closed
- **/
+ */
g_object_add_toggle_ref (
G_OBJECT (backend),
subprocess_factory_toggle_notify_cb,
diff --git a/libedataserver/e-client.c b/libedataserver/e-client.c
index e939452..02971f4 100644
--- a/libedataserver/e-client.c
+++ b/libedataserver/e-client.c
@@ -126,8 +126,11 @@ G_DEFINE_QUARK (e-client-error-quark, e_client_error)
/**
* e_client_error_to_string:
+ * @code: an #EClientError error code
*
- * FIXME: Document me.
+ * Get localized human readable description of the given error code.
+ *
+ * Returns: Localized human readable description of the given error code
*
* Since: 3.2
**/
@@ -1870,7 +1873,7 @@ client_wait_for_connected_thread (GTask *task,
* e_client_wait_for_connected:
* @client: an #EClient
* @timeout_seconds: a timeout for the wait, in seconds
- * @cancellable: (allow none): a #GCancellable; or %NULL
+ * @cancellable: (allow-none): a #GCancellable; or %NULL
* @callback: callback to call when a result is ready
* @user_data: user data for the @callback
*
@@ -1906,7 +1909,7 @@ e_client_wait_for_connected (EClient *client,
* e_client_wait_for_connected_finish:
* @client: an #EClient
* @result: a #GAsyncResult
- * @error: (out): (allow none): a #GError to set an error, or %NULL
+ * @error: (out): (allow-none): a #GError to set an error, or %NULL
*
* Finishes previous call of e_client_wait_for_connected().
*
@@ -1950,11 +1953,11 @@ client_wait_for_connected_notify_cb (ESource *source,
}
/**
+ * e_client_wait_for_connected_sync:
* @client: an #EClient
* @timeout_seconds: a timeout for the wait, in seconds
- * @cancellable: (allow none): a #GCancellable; or %NULL
- * @callback: callback to call when a result is ready
- * @error: (out): (allow none): a #GError to set an error, or %NULL
+ * @cancellable: (allow-none): a #GCancellable; or %NULL
+ * @error: (out): (allow-none): a #GError to set an error, or %NULL
*
* Synchronously waits until the @client is connected (according
* to @ESource::connection-status property), but not longer than @timeout_seconds.
@@ -2027,8 +2030,8 @@ e_client_wait_for_connected_sync (EClient *client,
/**
* e_client_retrieve_properties_sync:
* @client: an #EClient
- * @cancellable: (allow none): optional #GCancellable object, or %NULL
- * @error: (allow none): return location for a #GError, or %NULL
+ * @cancellable: (allow-none): optional #GCancellable object, or %NULL
+ * @error: (allow-none): return location for a #GError, or %NULL
*
* Retrieves @client properties to match server-side values, without waiting
* for the D-Bus property change notifications delivery.
@@ -2076,7 +2079,7 @@ client_retrieve_properties_thread (GTask *task,
/**
* e_client_retrieve_properties:
* @client: an #EClient
- * @cancellable: (allow none): optional #GCancellable object, or %NULL
+ * @cancellable: (allow-none): optional #GCancellable object, or %NULL
* @callback: a #GAsyncReadyCallback to call when the request is satisfied
* @user_data: data to pass to the callback function
*
diff --git a/libedataserver/e-client.h b/libedataserver/e-client.h
index d421671..4267e47 100644
--- a/libedataserver/e-client.h
+++ b/libedataserver/e-client.h
@@ -118,8 +118,28 @@ GQuark e_client_error_quark (void) G_GNUC_CONST;
/**
* EClientError:
- *
- * FIXME Document each code.
+ * @E_CLIENT_ERROR_INVALID_ARG: Invalid argument was used
+ * @E_CLIENT_ERROR_BUSY: The client is busy
+ * @E_CLIENT_ERROR_SOURCE_NOT_LOADED: The source is not loaded
+ * @E_CLIENT_ERROR_SOURCE_ALREADY_LOADED: The source is already loaded
+ * @E_CLIENT_ERROR_AUTHENTICATION_FAILED: Authentication failed
+ * @E_CLIENT_ERROR_AUTHENTICATION_REQUIRED: Authentication required
+ * @E_CLIENT_ERROR_REPOSITORY_OFFLINE: The repository (client) is offline
+ * @E_CLIENT_ERROR_OFFLINE_UNAVAILABLE: The operation is unavailable in offline mode
+ * @E_CLIENT_ERROR_PERMISSION_DENIED: Permission denied for the operation
+ * @E_CLIENT_ERROR_CANCELLED: The operation was cancelled
+ * @E_CLIENT_ERROR_COULD_NOT_CANCEL: The operation cannot be cancelled
+ * @E_CLIENT_ERROR_NOT_SUPPORTED: The operation is not supported
+ * @E_CLIENT_ERROR_TLS_NOT_AVAILABLE: TLS is not available
+ * @E_CLIENT_ERROR_UNSUPPORTED_AUTHENTICATION_METHOD: Requested authentication method is not supported
+ * @E_CLIENT_ERROR_SEARCH_SIZE_LIMIT_EXCEEDED: Search size limit exceeded
+ * @E_CLIENT_ERROR_SEARCH_TIME_LIMIT_EXCEEDED: Search time limit exceeded
+ * @E_CLIENT_ERROR_INVALID_QUERY: The query was invalid
+ * @E_CLIENT_ERROR_QUERY_REFUSED: The query was refused by the server side
+ * @E_CLIENT_ERROR_DBUS_ERROR: A D-Bus error occurred
+ * @E_CLIENT_ERROR_OTHER_ERROR: Other error
+ * @E_CLIENT_ERROR_NOT_OPENED: The client is not opened
+ * @E_CLIENT_ERROR_OUT_OF_SYNC: The clien tis out of sync
*
* Error codes for #EClient operations.
*
@@ -165,11 +185,13 @@ typedef struct _EClientClass EClientClass;
typedef struct _EClientPrivate EClientPrivate;
struct _EClient {
+ /*< private >*/
GObject parent;
EClientPrivate *priv;
};
struct _EClientClass {
+ /*< private >*/
GObjectClass parent;
/* This method is deprecated. */
diff --git a/libedataserver/e-module.c b/libedataserver/e-module.c
index daff3b5..db3af10 100644
--- a/libedataserver/e-module.c
+++ b/libedataserver/e-module.c
@@ -320,7 +320,7 @@ e_module_load_all_in_directory (const gchar *dirname)
/**
* e_module_load_file:
- * @dirname: filename of the module to load
+ * @filename: filename of the module to load
*
* Load the module from the specified filename into memory. If
* you want to unload it (enabling on-demand loading) you must call
diff --git a/libedataserver/e-source-credentials-provider-impl.c
b/libedataserver/e-source-credentials-provider-impl.c
index 6867ee8..af44353 100644
--- a/libedataserver/e-source-credentials-provider-impl.c
+++ b/libedataserver/e-source-credentials-provider-impl.c
@@ -209,9 +209,9 @@ e_source_credentials_provider_impl_can_prompt (ESourceCredentialsProviderImpl *p
* e_source_credentials_provider_impl_lookup_sync:
* @provider_impl: an #ESourceCredentialsProviderImpl
* @source: an #ESource
- * @cancellable: (allow none): optional #GCancellable object, or %NULL
+ * @cancellable: (allow-none): optional #GCancellable object, or %NULL
* @out_credentials: an #ENamedParameters to be set with stored credentials
- * @error: (allow none): return location for a #GError, or %NULL
+ * @error: (allow-none): return location for a #GError, or %NULL
*
* Asks @provider_impl to lookup for stored credentials for @source.
* The @out_credentials is populated with them. If the result is not
@@ -251,8 +251,8 @@ e_source_credentials_provider_impl_lookup_sync (ESourceCredentialsProviderImpl *
* @source: an #ESource
* @credentials: an #ENamedParameters containing credentials to store
* @permanently: whether to store credentials permanently, or for the current session only
- * @cancellable: (allow none): optional #GCancellable object, or %NULL
- * @error: (allow none): return location for a #GError, or %NULL
+ * @cancellable: (allow-none): optional #GCancellable object, or %NULL
+ * @error: (allow-none): return location for a #GError, or %NULL
*
* Asks @provider_impl to store @credentials for @source.
*
@@ -288,8 +288,8 @@ e_source_credentials_provider_impl_store_sync (ESourceCredentialsProviderImpl *p
* e_source_credentials_provider_impl_delete_sync:
* @provider_impl: an #ESourceCredentialsProviderImpl
* @source: an #ESource
- * @cancellable: (allow none): optional #GCancellable object, or %NULL
- * @error: (allow none): return location for a #GError, or %NULL
+ * @cancellable: (allow-none): optional #GCancellable object, or %NULL
+ * @error: (allow-none): return location for a #GError, or %NULL
*
* Asks @provider_impl to delete any stored credentials for @source.
*
diff --git a/libedataserver/e-source.c b/libedataserver/e-source.c
index ba59ced..27824a3 100644
--- a/libedataserver/e-source.c
+++ b/libedataserver/e-source.c
@@ -4716,9 +4716,9 @@ e_source_delete_password_finish (ESource *source,
* @reason: an #ESourceCredentialsReason, why the credentials are required
* @certificate_pem: PEM-encoded secure connection certificate, or an empty string
* @certificate_errors: a bit-or of #GTlsCertificateFlags for secure connection certificate
- * @op_error: (allow none): a #GError with a description of the previous credentials error, or %NULL
- * @cancellable: (allow none): optional #GCancellable object, or %NULL
- * @error: (allow none): return location for a #GError, or %NULL
+ * @op_error: (allow-none): a #GError with a description of the previous credentials error, or %NULL
+ * @cancellable: (allow-none): optional #GCancellable object, or %NULL
+ * @error: (allow-none): return location for a #GError, or %NULL
*
* Let's the client-side know that credentials are required. The @reason defines which
* parameters are used. The client passed the credentials with an e_source_authenitcate()
@@ -4880,8 +4880,8 @@ source_invoke_credentials_required_thread (GTask *task,
* @reason: an #ESourceCredentialsReason, why the credentials are required
* @certificate_pem: PEM-encoded secure connection certificate, or an empty string
* @certificate_errors: a bit-or of #GTlsCertificateFlags for secure connection certificate
- * @op_error: (allow none): a #GError with a description of the previous credentials error, or %NULL
- * @cancellable: (allow none): optional #GCancellable object, or %NULL
+ * @op_error: (allow-none): a #GError with a description of the previous credentials error, or %NULL
+ * @cancellable: (allow-none): optional #GCancellable object, or %NULL
* @callback: a #GAsyncReadyCallback to call when the request is satisfied
* @user_data: data to pass to the callback function
*
@@ -4927,7 +4927,7 @@ e_source_invoke_credentials_required (ESource *source,
* e_source_invoke_credentials_required_finish:
* @source: an #ESource
* @result: a #GAsyncResult
- * @error: (allow none): return location for a #GError, or %NULL
+ * @error: (allow-none): return location for a #GError, or %NULL
*
* Finishes the operation started with e_source_invoke_credentials_required().
*
@@ -4955,10 +4955,10 @@ e_source_invoke_credentials_required_finish (ESource *source,
/**
* e_source_invoke_authenticate_sync:
* @source: an #ESource
- * @credentials: (allow none): an #ENamedParameters structure with credentials to use; can be %NULL
+ * @credentials: (allow-none): an #ENamedParameters structure with credentials to use; can be %NULL
* to use those from the last call
- * @cancellable: (allow none): optional #GCancellable object, or %NULL
- * @error: (allow none): return location for a #GError, or %NULL
+ * @cancellable: (allow-none): optional #GCancellable object, or %NULL
+ * @error: (allow-none): return location for a #GError, or %NULL
*
* Calls the InvokeAuthenticate method on the server side, thus the backend
* knows what credentials to use to connect to its (possibly remote) data store.
@@ -5061,9 +5061,9 @@ source_invoke_authenticate_thread (GTask *task,
/**
* e_source_invoke_authenticate:
* @source: an #ESource
- * @credentials: (allow none): an #ENamedParameters structure with credentials to use; can be %NULL
+ * @credentials: (allow-none): an #ENamedParameters structure with credentials to use; can be %NULL
* to use those from the last call
- * @cancellable: (allow none): optional #GCancellable object, or %NULL
+ * @cancellable: (allow-none): optional #GCancellable object, or %NULL
* @callback: a #GAsyncReadyCallback to call when the request is satisfied
* @user_data: data to pass to the callback function
*
@@ -5103,7 +5103,7 @@ e_source_invoke_authenticate (ESource *source,
* e_source_invoke_authenticate_finish:
* @source: an #ESource
* @result: a #GAsyncResult
- * @error: (allow none): return location for a #GError, or %NULL
+ * @error: (allow-none): return location for a #GError, or %NULL
*
* Finishes the operation started with e_source_invoke_authenticate().
*
@@ -5133,7 +5133,7 @@ e_source_invoke_authenticate_finish (ESource *source,
* @reason: an #ESourceCredentialsReason, why the credentials are required
* @certificate_pem: PEM-encoded secure connection certificate, or an empty string
* @certificate_errors: a bit-or of #GTlsCertificateFlags for secure connection certificate
- * @op_error: (allow none): a #GError with a description of the previous credentials error, or %NULL
+ * @op_error: (allow-none): a #GError with a description of the previous credentials error, or %NULL
*
* Emits localy (in this process only) the ESource::credentials-required
* signal with given parameters. That's the difference with e_source_invoke_credentials_required(),
@@ -5160,8 +5160,8 @@ e_source_emit_credentials_required (ESource *source,
* @out_certificate_pem: (out): PEM-encoded secure connection certificate, or an empty string
* @out_certificate_errors: (out): a bit-or of #GTlsCertificateFlags for secure connection certificate
* @out_op_error: (out): a #GError with a description of the previous credentials error
- * @cancellable: (allow none): optional #GCancellable object, or %NULL
- * @error: (allow none): return location for a #GError, or %NULL
+ * @cancellable: (allow-none): optional #GCancellable object, or %NULL
+ * @error: (allow-none): return location for a #GError, or %NULL
*
* Retrieves the last used arguments of the 'credentials-required' signal emission.
* If there was none emitted yet, or a corresponding 'authenitcate' had been emitted
@@ -5274,7 +5274,7 @@ source_get_last_credentials_required_arguments_thread (GTask *task,
/**
* e_source_get_last_credentials_required_arguments:
* @source: an #ESource
- * @cancellable: (allow none): optional #GCancellable object, or %NULL
+ * @cancellable: (allow-none): optional #GCancellable object, or %NULL
* @callback: a #GAsyncReadyCallback to call when the request is satisfied
* @user_data: data to pass to the callback function
*
@@ -5315,7 +5315,7 @@ e_source_get_last_credentials_required_arguments (ESource *source,
* @out_certificate_pem: (out): PEM-encoded secure connection certificate, or an empty string
* @out_certificate_errors: (out): a bit-or of #GTlsCertificateFlags for secure connection certificate
* @out_op_error: (out): a #GError with a description of the previous credentials error
- * @error: (allow none): return location for a #GError, or %NULL
+ * @error: (allow-none): return location for a #GError, or %NULL
*
* Finishes the operation started with e_source_get_last_credentials_required_arguments().
* See e_source_get_last_credentials_required_arguments_sync() for more information
@@ -5366,8 +5366,8 @@ e_source_get_last_credentials_required_arguments_finish (ESource *source,
/**
* e_source_unset_last_credentials_required_arguments_sync:
* @source: an #ESource
- * @cancellable: (allow none): optional #GCancellable object, or %NULL
- * @error: (allow none): return location for a #GError, or %NULL
+ * @cancellable: (allow-none): optional #GCancellable object, or %NULL
+ * @error: (allow-none): return location for a #GError, or %NULL
*
* Unsets the last used arguments of the 'credentials-required' signal emission.
*
@@ -5432,7 +5432,7 @@ source_unset_last_credentials_required_arguments_thread (GTask *task,
/**
* e_source_unset_last_credentials_required_arguments:
* @source: an #ESource
- * @cancellable: (allow none): optional #GCancellable object, or %NULL
+ * @cancellable: (allow-none): optional #GCancellable object, or %NULL
* @callback: a #GAsyncReadyCallback to call when the request is satisfied
* @user_data: data to pass to the callback function
*
@@ -5468,7 +5468,7 @@ e_source_unset_last_credentials_required_arguments (ESource *source,
* e_source_unset_last_credentials_required_arguments_finish:
* @source: an #ESource
* @result: a #GAsyncResult
- * @error: (allow none): return location for a #GError, or %NULL
+ * @error: (allow-none): return location for a #GError, or %NULL
*
* Finishes the operation started with e_source_unset_last_credentials_required_arguments().
*
diff --git a/libedataserver/e-webdav-discover.c b/libedataserver/e-webdav-discover.c
index c2424b7..61642b8 100644
--- a/libedataserver/e-webdav-discover.c
+++ b/libedataserver/e-webdav-discover.c
@@ -1652,10 +1652,17 @@ e_webdav_discover_cancelled_cb (GCancellable *cancellable,
* @url_use_path: (allow-none): optional URL override, or %NULL
* @only_supports: bit-or of EWebDAVDiscoverSupports, to limit what type of sources to search
* @credentials: (allow-none): credentials to use for authentication to the server
+ * @out_certificate_pem: (out): (allow-none): optional return location
+ * for a server SSL certificate in PEM format, when the operation failed
+ * with an SSL error
+ * @out_certificate_errors: (out): (allow-none): optional #GTlsCertificateFlags,
+ * with certificate error flags when the operation failed with SSL error
+ * @out_discovered_sources: (out): (element-type EWebDAVDiscoveredSource): a #GSList
+ * of all discovered sources
+ * @out_calendar_user_addresses: (out): (allow-none): (element-type gchar *): a #GSList of
+ * all discovered mail addresses for calendar sources
* @cancellable: (allow-none): optional #GCancellable object, or %NULL
- * @callback: (scope async): a #GAsyncReadyCallback to call when the request
- * is satisfied
- * @user_data: (closure): data to pass to the callback function
+ * @error: (allow-none): return location for a #GError, or %NULL
*
* Synchronously runs discovery of the WebDAV sources (CalDAV and CardDAV), eventually
* limited by the @only_supports filter, which can be %E_WEBDAV_DISCOVER_SUPPORTS_NONE
diff --git a/libedataserverui/e-credentials-prompter-impl.c b/libedataserverui/e-credentials-prompter-impl.c
index 60f6f9a..4a432f6 100644
--- a/libedataserverui/e-credentials-prompter-impl.c
+++ b/libedataserverui/e-credentials-prompter-impl.c
@@ -89,7 +89,7 @@ e_credentials_prompter_impl_class_init (ECredentialsPrompterImplClass *klass)
* ECredentialsPrompterImpl::prompt-finished:
* @prompter_impl: an #ECredentialsPrompterImpl which emitted the signal
* @prompt_id: an ID of the prompt which was finished
- * @credentials: (allow none): entered credentials, or %NULL for cancelled prompts
+ * @credentials: (allow-none): entered credentials, or %NULL for cancelled prompts
*
* Emitted when a prompt of ID @prompt_id is finished.
*
@@ -143,7 +143,7 @@ e_credentials_prompter_impl_get_credentials_prompter (ECredentialsPrompterImpl *
* @prompt_id: a prompt ID to be passed to e_credentials_prompter_impl_prompt_finish()
* @auth_source: an #ESource, to prompt the credentials for (the source which asked for credentials)
* @cred_source: a parent #ESource, from which credentials were taken, or should be stored to
- * @error_text: (allow none): an optional error text from the previous credentials prompt; can be %NULL
+ * @error_text: (allow-none): an optional error text from the previous credentials prompt; can be %NULL
* @credentials: credentials, as saved in keyring; can be empty, but not %NULL
*
* Runs a credentials prompt for the @prompter_impl. The actual prompter implementation
@@ -185,7 +185,7 @@ e_credentials_prompter_impl_prompt (ECredentialsPrompterImpl *prompter_impl,
* e_credentials_prompter_impl_prompt_finish:
* @prompter_impl: an #ECredentialsPrompterImpl
* @prompt_id: a prompt ID
- * @credentials: (allow none): credentials to use; can be %NULL for cancelled prompts
+ * @credentials: (allow-none): credentials to use; can be %NULL for cancelled prompts
*
* The actual credentials prompt implementation finishes a previously started
* credentials prompt @prompt_id with ECredentialsPrompterImplClass::process_prompt()
diff --git a/libedataserverui/e-credentials-prompter.c b/libedataserverui/e-credentials-prompter.c
index ec537c5..3c3a072 100644
--- a/libedataserverui/e-credentials-prompter.c
+++ b/libedataserverui/e-credentials-prompter.c
@@ -1270,7 +1270,7 @@ e_credentials_prompter_get_dialog_parent (ECredentialsPrompter *prompter)
/**
* e_credentials_prompter_register_impl:
* @prompter: an #ECredentialsPrompter
- * @authentication_method: (allow none): an authentication method to registr @prompter_impl for; or %NULL
+ * @authentication_method: (allow-none): an authentication method to registr @prompter_impl for; or %NULL
* @prompter_impl: an #ECredentialsPrompterImpl
*
* Registers a prompter implementation for a given authentication method. If there is
@@ -1324,7 +1324,7 @@ e_credentials_prompter_register_impl (ECredentialsPrompter *prompter,
/**
* e_credentials_prompter_unregister_impl:
* @prompter: an #ECredentialsPrompter
- * @authentication_method: (allow none): an authentication method to registr @prompter_impl for; or %NULL
+ * @authentication_method: (allow-none): an authentication method to registr @prompter_impl for; or %NULL
* @prompter_impl: an #ECredentialsPrompterImpl
*
* Unregisters previously registered @prompter_impl for the given @autnetication_method with
@@ -1471,9 +1471,9 @@ e_credentials_prompter_process_source (ECredentialsPrompter *prompter,
* e_credentials_prompter_prompt:
* @prompter: an #ECredentialsPrompter
* @source: an #ESource, which prompt the credentials for
- * @error_text: (allow none): Additional error text to show to a user, or %NULL
+ * @error_text: (allow-none): Additional error text to show to a user, or %NULL
* @flags: a bit-or of #ECredentialsPrompterPromptFlags
- * @callback: (allow none): a callback to call when the credentials are ready, or %NULL
+ * @callback: (allow-none): a callback to call when the credentials are ready, or %NULL
* @user_data: user data passed into @callback
*
* Asks the @prompter to prompt for credentials, which are returned
@@ -1514,7 +1514,7 @@ e_credentials_prompter_prompt (ECredentialsPrompter *prompter,
* e_credentials_prompter_prompt_finish:
* @prompter: an #ECredentialsPrompter
* @result: a #GAsyncResult
- * @out_source: (transfer full): (allow none): optionally set to an #ESource, on which the prompt was
started; can be %NULL
+ * @out_source: (transfer full): (allow-none): optionally set to an #ESource, on which the prompt was
started; can be %NULL
* @out_credentials: (transfer full): set to an #ENamedParameters with provied credentials
* @error: return location for a #GError, or %NULL
*
@@ -1571,8 +1571,8 @@ e_credentials_prompter_prompt_finish (ECredentialsPrompter *prompter,
* @prompter: an #ECredentialsPrompter
* @async_result: a #GSimpleAsyncResult
* @source: an #ESource, on which the prompt was started
- * @credentials: (allow none): credentials, as provided by a user, on %NULL, when the prompt was cancelled
- * @error: (allow none): a resulting #GError, or %NULL
+ * @credentials: (allow-none): credentials, as provided by a user, on %NULL, when the prompt was cancelled
+ * @error: (allow-none): a resulting #GError, or %NULL
*
* Completes an ongoing credentials prompt on idle, by finishing the @async_result.
* This function is meant to be used by an #ECredentialsPrompterImpl implementation.
@@ -1695,8 +1695,8 @@ credentials_prompter_prompt_sync (ECredentialsPrompter *prompter,
* @flags: a bit-or of #ECredentialsPrompterPromptFlags initial flags
* @func: an #ECredentialsPrompterLoopPromptFunc user function to call to check provided credentials
* @user_data: user data to pass to @func
- * @cancellable: (allow none): an optional #GCancellable, or %NULL
- * @error: (allow none): a #GError, to store any errors to, or %NULL
+ * @cancellable: (allow-none): an optional #GCancellable, or %NULL
+ * @error: (allow-none): a #GError, to store any errors to, or %NULL
*
* Runs a credentials prompt loop for @source, as long as the @func doesn't
* indicate that the provided credentials can be used to successfully
diff --git a/libedataserverui/e-trust-prompt.c b/libedataserverui/e-trust-prompt.c
index 9c6c62c..0ff6e17 100644
--- a/libedataserverui/e-trust-prompt.c
+++ b/libedataserverui/e-trust-prompt.c
@@ -376,12 +376,12 @@ e_trust_prompt_run_with_dialog_ready_callback (GtkWindow *parent,
/**
* e_trust_prompt_run_modal:
* @parent: A #GtkWindow to use as a parent for the trust prompt dialog
- * @source_extension: (allow none): an #ESource extension, to identify a kind of the source; or %NULL
- * @source_display_name: (allow none): an #ESource display name, to identify what prompts; or %NULL
+ * @source_extension: (allow-none): an #ESource extension, to identify a kind of the source; or %NULL
+ * @source_display_name: (allow-none): an #ESource display name, to identify what prompts; or %NULL
* @host: a host name to which the certificate belongs
* @certificate_pem: a PEM-encoded certificate for which to show the trust prompt
* @certificate_errors: errors of the @certificate_pem
- * @error_text: (allow none): an optional error text to show in the dialog; can be %NULL
+ * @error_text: (allow-none): an optional error text to show in the dialog; can be %NULL
*
* Runs modal (doesn't return until the dialog is closed) a trust prompt dialog,
* it is a prompt whether a user wants to accept or reject the @certificate_pem
@@ -492,9 +492,9 @@ save_source_thread (GTask *task,
* @source: an #ESource, with %E_SOURCE_EXTENSION_AUTHENTICATION
* @certificate_pem: a PEM-encoded certificate for which to show the trust prompt
* @certificate_errors: errors of the @certificate_pem
- * @error_text: (allow none): an optional error text to show in the dialog; can be %NULL
+ * @error_text: (allow-none): an optional error text to show in the dialog; can be %NULL
* @allow_source_save: whether can also save any @source changes
- * @cancellable: (allow none): a #GCancellable, or %NULL
+ * @cancellable: (allow-none): a #GCancellable, or %NULL
* @callback: a callback to call, when the prompt (an @source save) is done
* @user_data: user data passed into @callback
*
diff --git a/libedataserverui/e-webdav-discover-widget.c b/libedataserverui/e-webdav-discover-widget.c
index 69801b2..d4e2fbe 100644
--- a/libedataserverui/e-webdav-discover-widget.c
+++ b/libedataserverui/e-webdav-discover-widget.c
@@ -73,7 +73,7 @@ e_webdav_discover_content_data_free (gpointer ptr)
/**
* e_webdav_discover_content_new:
* @credentials_prompter: an #ECredentialsPrompter to use to ask for credentials
- * @source: (allow none): optional #ESource to use for authentication, or %NULL
+ * @source: (allow-none): optional #ESource to use for authentication, or %NULL
* @base_url: (allow-none): optional base URL to use for discovery, or %NULL
* @supports_filter: a bit-or of #EWebDAVDiscoverSupports, a filter to limit what source
* types will be shown in the dialog content; use %E_WEBDAV_DISCOVER_SUPPORTS_NONE
@@ -779,7 +779,7 @@ e_webdav_discover_info_bar_response_cb (GtkInfoBar *info_bar,
/**
* e_webdav_discover_content_refresh:
* @content: a WebDAV discovery content, created by e_webdav_discover_content_new()
- * @display_name: (allow none): optional display name to use for scratch sources
+ * @display_name: (allow-none): optional display name to use for scratch sources
* @cancellable: (allow-none): optional #GCancellable object, or %NULL
* @callback: (scope async): a #GAsyncReadyCallback to call when the request
* is satisfied
@@ -960,7 +960,7 @@ e_webdav_discover_info_bar_error_response_cb (GtkInfoBar *info_bar,
/**
* e_webdav_discover_content_show_error:
* @content: a WebDAV discovery content, created by e_webdav_discover_content_new()
- * @error: (allow none): a #GError to show in the UI, or %NULL
+ * @error: (allow-none): a #GError to show in the UI, or %NULL
*
* Shows the @error within @content, unless it's a #G_IO_ERROR_CANCELLED, or %NULL,
* which are safely ignored. The advantage of this function is that the error
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
