[evolution-data-server] Fix some of the gtk-doc warnings
- From: Milan Crha <mcrha src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [evolution-data-server] Fix some of the gtk-doc warnings
- Date: Thu, 10 Nov 2016 09:27:29 +0000 (UTC)
commit fbf9371fb38e552ec29a40022e2460b032a49bb9
Author: Milan Crha <mcrha redhat com>
Date: Thu Nov 10 10:27:36 2016 +0100
Fix some of the gtk-doc warnings
.../evolution-data-server-cursor-example.sgml.in | 10 +-
.../e-source-backend-summary-setup.h | 1 +
src/addressbook/libedata-book/e-book-sqlite.h | 2 +-
.../libedata-book/e-data-book-cursor-sqlite.h | 2 +
src/addressbook/libedata-book/e-data-book-cursor.h | 2 +-
src/addressbook/libedata-book/e-data-book-view.c | 1 +
src/addressbook/libedata-book/e-data-book.c | 4 +-
src/calendar/libecal/e-cal-client.c | 2 +
src/calendar/libecal/e-timezone-cache.h | 6 +
src/calendar/libedata-cal/e-data-cal.c | 40 ++-
src/calendar/libedata-cal/e-data-cal.h | 29 ++-
src/camel/camel-block-file.c | 68 ++--
src/camel/camel-block-file.h | 2 +-
src/camel/camel-certdb.c | 17 +-
src/camel/camel-charset-map.c | 12 +-
src/camel/camel-cipher-context.c | 12 +-
src/camel/camel-data-cache.c | 6 +-
src/camel/camel-db.c | 456 +++++++++++++++-----
src/camel/camel-db.h | 181 +++++---
src/camel/camel-debug.c | 13 +-
src/camel/camel-debug.h | 10 +-
src/camel/camel-enums.h | 15 +-
src/camel/camel-filter-driver.c | 77 +++-
src/camel/camel-filter-driver.h | 2 +-
src/camel/camel-folder.h | 6 +
src/camel/camel-local-settings.h | 2 +
src/camel/camel-mime-filter-progress.h | 1 +
src/camel/camel-mime-parser.c | 28 +-
src/camel/camel-msgport.h | 3 +
src/camel/camel-offline-settings.h | 1 +
src/camel/camel-provider.h | 3 +
src/camel/camel-settings.h | 1 +
src/camel/camel-sexp.h | 31 ++
src/camel/camel-store-settings.h | 1 +
src/camel/camel-vee-data-cache.h | 16 +
src/camel/camel.c | 5 +
.../providers/imapx/camel-imapx-list-response.h | 1 +
src/camel/providers/imapx/camel-imapx-logger.h | 1 +
src/camel/providers/imapx/camel-imapx-mailbox.h | 1 +
.../imapx/camel-imapx-namespace-response.h | 1 +
src/camel/providers/imapx/camel-imapx-namespace.h | 1 +
src/camel/providers/imapx/camel-imapx-search.h | 1 +
src/camel/providers/imapx/camel-imapx-server.h | 10 +-
.../providers/imapx/camel-imapx-status-response.h | 1 +
src/libebackend/e-backend.c | 4 +-
src/libebackend/e-data-factory.h | 1 +
src/libebackend/e-dbus-server.h | 1 +
src/libebackend/e-file-cache.h | 1 +
src/libebackend/e-oauth2-support.h | 5 +
src/libebackend/e-offline-listener.h | 1 +
.../e-server-side-source-credentials-provider.h | 1 +
src/libebackend/e-server-side-source.h | 1 +
src/libebackend/e-source-registry-server.h | 1 +
src/libebackend/e-subprocess-factory.h | 9 +-
src/libebackend/e-user-prompter-server-extension.h | 1 +
src/libebackend/e-user-prompter-server.h | 1 +
src/libebackend/e-user-prompter.h | 4 +
src/libedataserver/e-client.c | 3 +-
src/libedataserver/e-client.h | 1 +
src/libedataserver/e-credentials.c | 73 +++-
src/libedataserver/e-credentials.h | 14 +-
src/libedataserver/e-data-server-util.c | 5 +
src/libedataserver/e-debug-log.c | 47 ++
src/libedataserver/e-extension.h | 1 +
src/libedataserver/e-gdbus-templates.c | 2 +
src/libedataserver/e-iterator.c | 69 +++-
src/libedataserver/e-iterator.h | 1 +
src/libedataserver/e-module.h | 1 +
src/libedataserver/e-network-monitor.h | 1 +
src/libedataserver/e-operation-pool.c | 6 +-
src/libedataserver/e-proxy.c | 14 +
src/libedataserver/e-proxy.h | 1 +
src/libedataserver/e-secret-store.c | 1 +
src/libedataserver/e-sexp.c | 3 +
src/libedataserver/e-soup-auth-bearer.h | 1 +
src/libedataserver/e-source-address-book.h | 1 +
src/libedataserver/e-source-alarms.h | 1 +
src/libedataserver/e-source-authentication.h | 1 +
src/libedataserver/e-source-autocomplete.h | 1 +
src/libedataserver/e-source-backend.h | 1 +
src/libedataserver/e-source-calendar.h | 3 +
src/libedataserver/e-source-camel.h | 1 +
src/libedataserver/e-source-collection.h | 1 +
src/libedataserver/e-source-contacts.h | 1 +
.../e-source-credentials-provider-impl-google.h | 1 +
.../e-source-credentials-provider-impl-password.h | 1 +
.../e-source-credentials-provider-impl.h | 1 +
src/libedataserver/e-source-credentials-provider.h | 1 +
src/libedataserver/e-source-enums.h | 7 +-
src/libedataserver/e-source-extension.h | 1 +
src/libedataserver/e-source-goa.h | 1 +
src/libedataserver/e-source-ldap.h | 1 +
src/libedataserver/e-source-local.h | 1 +
src/libedataserver/e-source-mail-account.h | 1 +
src/libedataserver/e-source-mail-composition.h | 1 +
src/libedataserver/e-source-mail-identity.h | 1 +
src/libedataserver/e-source-mail-signature.h | 1 +
src/libedataserver/e-source-mail-submission.h | 1 +
src/libedataserver/e-source-mail-transport.h | 1 +
src/libedataserver/e-source-mdn.h | 1 +
src/libedataserver/e-source-offline.h | 1 +
src/libedataserver/e-source-openpgp.h | 1 +
src/libedataserver/e-source-proxy.h | 1 +
src/libedataserver/e-source-refresh.h | 1 +
src/libedataserver/e-source-registry.c | 2 +-
src/libedataserver/e-source-registry.h | 1 +
src/libedataserver/e-source-resource.h | 1 +
src/libedataserver/e-source-revision-guards.h | 1 +
src/libedataserver/e-source-security.h | 1 +
src/libedataserver/e-source-selectable.h | 1 +
src/libedataserver/e-source-smime.h | 1 +
src/libedataserver/e-source-uoa.h | 1 +
src/libedataserver/e-source-weather.h | 1 +
src/libedataserver/e-source-webdav.c | 2 +
src/libedataserver/e-source-webdav.h | 1 +
src/libedataserver/e-source.c | 1 +
src/libedataserver/e-source.h | 1 +
tests/test-server-utils/e-test-server-utils.h | 2 +
118 files changed, 1104 insertions(+), 310 deletions(-)
---
diff --git a/docs/reference/evolution-data-server/evolution-data-server-cursor-example.sgml.in
b/docs/reference/evolution-data-server/evolution-data-server-cursor-example.sgml.in
index 5cb83b1..be999ae 100644
--- a/docs/reference/evolution-data-server/evolution-data-server-cursor-example.sgml.in
+++ b/docs/reference/evolution-data-server/evolution-data-server-cursor-example.sgml.in
@@ -70,7 +70,7 @@
<programlisting>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
parse="text"
- href="@CMAKE_SOURCE_DIR@/examples/cursor/cursor-example.c"/>
+ href="@CMAKE_SOURCE_DIR@/src/examples/cursor/cursor-example.c"/>
</programlisting>
</informalexample>
</refsect1>
@@ -88,7 +88,7 @@
<programlisting>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
parse="text"
- href="@CMAKE_SOURCE_DIR@/examples/cursor/cursor-navigator.c"/>
+ href="@CMAKE_SOURCE_DIR@/src/examples/cursor/cursor-navigator.c"/>
</programlisting>
</informalexample>
</refsect1>
@@ -106,7 +106,7 @@
<programlisting>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
parse="text"
- href="@CMAKE_SOURCE_DIR@/examples/cursor/cursor-search.c"/>
+ href="@CMAKE_SOURCE_DIR@/src/examples/cursor/cursor-search.c"/>
</programlisting>
</informalexample>
</refsect1>
@@ -122,7 +122,7 @@
<programlisting>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
parse="text"
- href="@CMAKE_SOURCE_DIR@/examples/cursor/cursor-slot.c"/>
+ href="@CMAKE_SOURCE_DIR@/src/examples/cursor/cursor-slot.c"/>
</programlisting>
</informalexample>
</refsect1>
@@ -139,7 +139,7 @@
<programlisting>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
parse="text"
- href="@CMAKE_SOURCE_DIR@/examples/cursor/cursor-data.c"/>
+ href="@CMAKE_SOURCE_DIR@/src/examples/cursor/cursor-data.c"/>
</programlisting>
</informalexample>
</refsect1>
diff --git a/src/addressbook/libebook-contacts/e-source-backend-summary-setup.h
b/src/addressbook/libebook-contacts/e-source-backend-summary-setup.h
index 0c7b64b..0206859 100644
--- a/src/addressbook/libebook-contacts/e-source-backend-summary-setup.h
+++ b/src/addressbook/libebook-contacts/e-source-backend-summary-setup.h
@@ -74,6 +74,7 @@ typedef struct _ESourceBackendSummarySetupPrivate ESourceBackendSummarySetupPriv
* Since: 3.8
**/
struct _ESourceBackendSummarySetup {
+ /*< private >*/
ESourceBackend parent;
ESourceBackendSummarySetupPrivate *priv;
};
diff --git a/src/addressbook/libedata-book/e-book-sqlite.h b/src/addressbook/libedata-book/e-book-sqlite.h
index 41c9a61..d29d50d 100644
--- a/src/addressbook/libedata-book/e-book-sqlite.h
+++ b/src/addressbook/libedata-book/e-book-sqlite.h
@@ -384,7 +384,7 @@ gboolean e_book_sqlite_get_contact (EBookSqlite *ebsql,
gboolean ebsql_get_contact_unlocked (EBookSqlite *ebsql,
const gchar *uid,
gboolean meta_contact,
- EContact **ret_contact,
+ EContact **contact,
GError **error);
gboolean e_book_sqlite_get_vcard (EBookSqlite *ebsql,
const gchar *uid,
diff --git a/src/addressbook/libedata-book/e-data-book-cursor-sqlite.h
b/src/addressbook/libedata-book/e-data-book-cursor-sqlite.h
index 234c596..8edc037 100644
--- a/src/addressbook/libedata-book/e-data-book-cursor-sqlite.h
+++ b/src/addressbook/libedata-book/e-data-book-cursor-sqlite.h
@@ -49,6 +49,7 @@ typedef struct _EDataBookCursorSqlitePrivate EDataBookCursorSqlitePrivate;
* Since: 3.12
*/
struct _EDataBookCursorSqlite {
+ /*< private >*/
EDataBookCursor parent;
EDataBookCursorSqlitePrivate *priv;
};
@@ -61,6 +62,7 @@ struct _EDataBookCursorSqlite {
* Since: 3.12
*/
struct _EDataBookCursorSqliteClass {
+ /*< private >*/
EDataBookCursorClass parent;
};
diff --git a/src/addressbook/libedata-book/e-data-book-cursor.h
b/src/addressbook/libedata-book/e-data-book-cursor.h
index 9813d0d..785f30e 100644
--- a/src/addressbook/libedata-book/e-data-book-cursor.h
+++ b/src/addressbook/libedata-book/e-data-book-cursor.h
@@ -244,8 +244,8 @@ typedef gboolean (*EDataBookCursorLoadLocaleFunc) (EDataBookCursor *cursor,
* Since: 3.12
*/
struct _EDataBookCursor {
+ /*< private >*/
GObject parent;
-
EDataBookCursorPrivate *priv;
};
diff --git a/src/addressbook/libedata-book/e-data-book-view.c
b/src/addressbook/libedata-book/e-data-book-view.c
index 3f70c4b..14731d1 100644
--- a/src/addressbook/libedata-book/e-data-book-view.c
+++ b/src/addressbook/libedata-book/e-data-book-view.c
@@ -936,6 +936,7 @@ e_data_book_view_notify_update (EDataBookView *view,
/**
* e_data_book_view_notify_update_vcard:
* @view: an #EDataBookView
+ * @id: a unique id of the @vcard
* @vcard: a plain vCard
*
* Notify listeners that @vcard has changed. This can
diff --git a/src/addressbook/libedata-book/e-data-book.c b/src/addressbook/libedata-book/e-data-book.c
index 58f2ed9..130218f 100644
--- a/src/addressbook/libedata-book/e-data-book.c
+++ b/src/addressbook/libedata-book/e-data-book.c
@@ -1468,9 +1468,11 @@ e_data_book_respond_refresh (EDataBook *book,
* e_data_book_respond_get_contact:
* @book: An #EDataBook
* @opid: An operation ID
- * @error: Operation error, if any, automatically freed if passed it
+ * @error: (nullable) (transfer full): Operation error, if any, automatically freed if passed it
+ * @vcard: (nullable): the found vCard, as string, or %NULL, if it could not be found
*
* Notifies listeners of the completion of the get_contact method call.
+ * Only one of @error and @vcard can be set.
*/
void
e_data_book_respond_get_contact (EDataBook *book,
diff --git a/src/calendar/libecal/e-cal-client.c b/src/calendar/libecal/e-cal-client.c
index 66b2a52..b30f913 100644
--- a/src/calendar/libecal/e-cal-client.c
+++ b/src/calendar/libecal/e-cal-client.c
@@ -2294,6 +2294,8 @@ e_cal_client_resolve_tzid_cb (const gchar *tzid,
* e_cal_client_resolve_tzid_sync:
* @tzid: ID of the timezone to resolve.
* @cal_client: User data for the callback, in this case #ECalClient.
+ * @cancellable: optional #GCancellable object, or %NULL
+ * @error: return location for a #GError, or %NULL
*
* Resolves TZIDs for the recurrence generator.
*
diff --git a/src/calendar/libecal/e-timezone-cache.h b/src/calendar/libecal/e-timezone-cache.h
index 01aa8a1..fb5dfe0 100644
--- a/src/calendar/libecal/e-timezone-cache.h
+++ b/src/calendar/libecal/e-timezone-cache.h
@@ -50,12 +50,18 @@ typedef struct _ETimezoneCacheInterface ETimezoneCacheInterface;
/**
* ETimezoneCacheInterface:
+ * @add_timezone: a method to add timezone to the cache
+ * @get_timezone: a method to get timezone from the cache, identified by its timezone id
+ * @list_timezones: a method to get list of all stored timezones
+ * @timezone_added: a signal emitted when a timezone is added to the cache
*
* Since: 3.8
**/
struct _ETimezoneCacheInterface {
+ /*< private >*/
GTypeInterface parent_interface;
+ /*< public >*/
/* Methods */
void (*add_timezone) (ETimezoneCache *cache,
icaltimezone *zone);
diff --git a/src/calendar/libedata-cal/e-data-cal.c b/src/calendar/libedata-cal/e-data-cal.c
index 5b6722d..f53e606 100644
--- a/src/calendar/libedata-cal/e-data-cal.c
+++ b/src/calendar/libedata-cal/e-data-cal.c
@@ -393,6 +393,9 @@ e_data_cal_error_quark (void)
/**
* e_data_cal_status_to_string:
+ * @status: an #EDataCalCallStatus
+ *
+ * Returns: A localized text representation of the @status.
*
* Since: 2.32
**/
@@ -448,7 +451,7 @@ e_data_cal_status_to_string (EDataCalCallStatus status)
* @custom_msg: Custom message to use for the error. When NULL,
* then uses a default message based on the @status code.
*
- * Returns: NULL, when the @status is Success,
+ * Returns: (nullable) (transfer full): %NULL, when the @status is Success,
* or a newly allocated GError, which should be freed
* with g_error_free() call.
*
@@ -466,9 +469,17 @@ e_data_cal_create_error (EDataCalCallStatus status,
/**
* e_data_cal_create_error_fmt:
+ * @status: an #EDataCalCallStatus
+ * @custom_msg_fmt: (nullable): message format, or %NULL to use the default message for the @status
+ * @...: arguments for the format
*
* Similar as e_data_cal_create_error(), only here, instead of custom_msg,
- * is used a printf() format to create a custom_msg for the error.
+ * is used a printf() format to create a custom message for the error.
+ *
+ * Returns: (nullable) (transfer full): %NULL, when the @status is Success,
+ * or a newly allocated #GError, which should be freed with g_error_free() call.
+ * The #GError has set the custom message, or the default message for
+ * @status, when @custom_msg_fmt is %NULL.
*
* Since: 2.32
**/
@@ -1617,6 +1628,7 @@ data_cal_handle_close_cb (EDBusCalendar *dbus_interface,
/**
* e_data_cal_respond_open:
* @cal: A calendar client interface.
+ * @opid: associated operation id
* @error: Operation error, if any, automatically freed if passed it.
*
* Notifies listeners of the completion of the open method call.
@@ -1654,6 +1666,7 @@ e_data_cal_respond_open (EDataCal *cal,
/**
* e_data_cal_respond_refresh:
* @cal: A calendar client interface.
+ * @opid: associated operation id
* @error: Operation error, if any, automatically freed if passed it.
*
* Notifies listeners of the completion of the refresh method call.
@@ -1691,6 +1704,7 @@ e_data_cal_respond_refresh (EDataCal *cal,
/**
* e_data_cal_respond_get_object:
* @cal: A calendar client interface.
+ * @opid: associated operation id
* @error: Operation error, if any, automatically freed if passed it.
* @object: The object retrieved as an iCalendar string.
*
@@ -1743,6 +1757,7 @@ e_data_cal_respond_get_object (EDataCal *cal,
/**
* e_data_cal_respond_get_object_list:
* @cal: A calendar client interface.
+ * @opid: associated operation id
* @error: Operation error, if any, automatically freed if passed it.
* @objects: List of retrieved objects.
*
@@ -1797,6 +1812,7 @@ e_data_cal_respond_get_object_list (EDataCal *cal,
/**
* e_data_cal_respond_get_free_busy:
* @cal: A calendar client interface.
+ * @opid: associated operation id
* @error: Operation error, if any, automatically freed if passed it.
* @freebusy: a #GSList of iCalendar strings with all gathered free/busy components.
*
@@ -1848,6 +1864,7 @@ e_data_cal_respond_get_free_busy (EDataCal *cal,
/**
* e_data_cal_respond_create_objects:
* @cal: A calendar client interface.
+ * @opid: associated operation id
* @error: Operation error, if any, automatically freed if passed it.
* @uids: UIDs of the objects created.
* @new_components: The newly created #ECalComponent objects.
@@ -1916,6 +1933,7 @@ e_data_cal_respond_create_objects (EDataCal *cal,
/**
* e_data_cal_respond_modify_objects:
* @cal: A calendar client interface.
+ * @opid: associated operation id
* @error: Operation error, if any, automatically freed if passed it.
* @old_components: The old #ECalComponents.
* @new_components: The new #ECalComponents.
@@ -1991,6 +2009,7 @@ e_data_cal_respond_modify_objects (EDataCal *cal,
/**
* e_data_cal_respond_remove_objects:
* @cal: A calendar client interface.
+ * @opid: associated operation id
* @error: Operation error, if any, automatically freed if passed it.
* @ids: IDs of the removed objects.
* @old_components: The old #ECalComponents.
@@ -2086,6 +2105,7 @@ e_data_cal_respond_remove_objects (EDataCal *cal,
/**
* e_data_cal_respond_receive_objects:
* @cal: A calendar client interface.
+ * @opid: associated operation id
* @error: Operation error, if any, automatically freed if passed it.
*
* Notifies listeners of the completion of the receive_objects method call.
@@ -2123,6 +2143,7 @@ e_data_cal_respond_receive_objects (EDataCal *cal,
/**
* e_data_cal_respond_send_objects:
* @cal: A calendar client interface.
+ * @opid: associated operation id
* @error: Operation error, if any, automatically freed if passed it.
* @users: List of users.
* @calobj: An iCalendar string representing the object sent.
@@ -2177,6 +2198,7 @@ e_data_cal_respond_send_objects (EDataCal *cal,
/**
* e_data_cal_respond_get_attachment_uris:
* @cal: A calendar client interface.
+ * @opid: associated operation id
* @error: Operation error, if any, automatically freed if passed it.
* @attachment_uris: List of retrieved attachment uri's.
*
@@ -2226,6 +2248,7 @@ e_data_cal_respond_get_attachment_uris (EDataCal *cal,
/**
* e_data_cal_respond_discard_alarm:
* @cal: A calendar client interface.
+ * @opid: associated operation id
* @error: Operation error, if any, automatically freed if passed it.
*
* Notifies listeners of the completion of the discard_alarm method call.
@@ -2263,6 +2286,7 @@ e_data_cal_respond_discard_alarm (EDataCal *cal,
/**
* e_data_cal_respond_get_timezone:
* @cal: A calendar client interface.
+ * @opid: associated operation id
* @error: Operation error, if any, automatically freed if passed it.
* @tzobject: The requested timezone as an iCalendar string.
*
@@ -2307,6 +2331,7 @@ e_data_cal_respond_get_timezone (EDataCal *cal,
/**
* e_data_cal_respond_add_timezone:
* @cal: A calendar client interface.
+ * @opid: associated operation id
* @error: Operation error, if any, automatically freed if passed it.
*
* Notifies listeners of the completion of the add_timezone method call.
@@ -2343,8 +2368,10 @@ e_data_cal_respond_add_timezone (EDataCal *cal,
/**
* e_data_cal_report_error:
+ * @cal: an #EDataCal
+ * @message: an error message to report
*
- * FIXME: Document me.
+ * Emits an error message, thus the clients can be notified about it.
*
* Since: 3.2
**/
@@ -2360,8 +2387,10 @@ e_data_cal_report_error (EDataCal *cal,
/**
* e_data_cal_report_free_busy_data:
+ * @cal: an #EDataCal
+ * @freebusy: (element-type utf8): a #GSList of free/busy components encoded as string
*
- * FIXME: Document me.
+ * Reports result of a free/busy query on the @cal.
*
* Since: 3.2
**/
@@ -2392,6 +2421,9 @@ e_data_cal_report_free_busy_data (EDataCal *cal,
/**
* e_data_cal_report_backend_property_changed:
+ * @cal: an #EDataCal
+ * @prop_name: property name
+ * @prop_value: new property value
*
* Notifies client about certain property value change
*
diff --git a/src/calendar/libedata-cal/e-data-cal.h b/src/calendar/libedata-cal/e-data-cal.h
index 97d4a11..4ec1b95 100644
--- a/src/calendar/libedata-cal/e-data-cal.h
+++ b/src/calendar/libedata-cal/e-data-cal.h
@@ -70,8 +70,35 @@ struct _EDataCalClass {
/**
* EDataCalCallStatus:
+ * @Success: call finished successfully
+ * @Busy: the backend is busy
+ * @RepositoryOffline: the backend is offline
+ * @PermissionDenied: the call failed due to permission restrictions
+ * @InvalidRange: the provided range for the call is invalid
+ * @ObjectNotFound: the requested object could not be found
+ * @InvalidObject: the provided object is invalid
+ * @ObjectIdAlreadyExists: the provided object has an ID which already exists
+ * @AuthenticationFailed: failed to authenticate with given credentials
+ * @AuthenticationRequired: authentication credentials are required to connect to the calendar
+ * @UnsupportedField: requested field is not supported
+ * @UnsupportedMethod: requested method is not supported
+ * @UnsupportedAuthenticationMethod: requested authentication method is not supported
+ * @TLSNotAvailable: TLS for connection is not available for the calendar
+ * @NoSuchCal: requested calendar does not exist
+ * @UnknownUser: provided user is unknown
+ * @OfflineUnavailable: requested data are not available in offline
+ * @SearchSizeLimitExceeded: a successful search doesn't contain all responses due to size limit
+ * @SearchTimeLimitExceeded: a successful search doesn't contain all responses due to time limit
+ * @InvalidQuery: a requested search query is invalid
+ * @QueryRefused: a requested search query had been refused, possibly by the server
+ * @CouldNotCancel: an ongoing operation cannot be cancelled
+ * @OtherError: a generic error happened
+ * @InvalidServerVersion: server version is invalid
+ * @InvalidArg: one of the arguments of the call was invalid
+ * @NotSupported: the operation is not supported
+ * @NotOpened: the calendar is not opened
*
- * FIXME Document me!
+ * Response statuses of the calls.
*
* Since: 3.6
**/
diff --git a/src/camel/camel-block-file.c b/src/camel/camel-block-file.c
index c0b333f..b9fae3b 100644
--- a/src/camel/camel-block-file.c
+++ b/src/camel/camel-block-file.c
@@ -343,9 +343,10 @@ block_file_unuse (CamelBlockFile *bs)
/**
* camel_block_file_new:
- * @path:
- * @:
- * @block_size:
+ * @path: a path with file name of the the new #CamelBlockFile
+ * @flags: file open flags to use
+ * @version: a version string
+ * @block_size: block size, currently ignored
*
* Allocate a new block file, stored at @path. @version contains an 8 character
* version string which must match the head of the file, or the file will be
@@ -470,6 +471,15 @@ camel_block_file_set_cache_limit (CamelBlockFile *bs,
bs->priv->block_cache_limit = block_cache_limit;
}
+/**
+ * camel_block_file_rename:
+ * @bs: a #CamelBlockFile
+ * @path: path with filename to rename to
+ *
+ * Renames existing block file to a new @path.
+ *
+ * Returns: 0 on success, -1 on error; errno is set on failure
+ **/
gint
camel_block_file_rename (CamelBlockFile *bs,
const gchar *path)
@@ -504,6 +514,14 @@ camel_block_file_rename (CamelBlockFile *bs,
return ret;
}
+/**
+ * camel_block_file_delete:
+ * @bs: a #CamelBlockFile
+ *
+ * Deletes existing block file.
+ *
+ * Returns: 0 on success, -1 on error.
+ **/
gint
camel_block_file_delete (CamelBlockFile *bs)
{
@@ -532,7 +550,7 @@ camel_block_file_delete (CamelBlockFile *bs)
/**
* camel_block_file_new_block: (skip)
- * @bs:
+ * @bs: a #CamelBlockFile
*
* Allocate a new block, return a pointer to it. Old blocks
* may be flushed to disk during this call.
@@ -572,8 +590,8 @@ fail:
/**
* camel_block_file_free_block:
- * @bs:
- * @id:
+ * @bs: a #CamelBlockFile
+ * @id: a #camel_block_t
*
*
**/
@@ -604,8 +622,8 @@ camel_block_file_free_block (CamelBlockFile *bs,
/**
* camel_block_file_get_block: (skip)
- * @bs:
- * @id:
+ * @bs: a #CamelBlockFile
+ * @id: a #camel_block_t
*
* Retreive a block @id.
*
@@ -699,8 +717,8 @@ camel_block_file_get_block (CamelBlockFile *bs,
/**
* camel_block_file_detach_block:
- * @bs:
- * @bl:
+ * @bs: a #CamelBlockFile
+ * @bl: a #CamelBlock
*
* Detatch a block from the block file's cache. The block should
* be unref'd or attached when finished with. The block file will
@@ -725,8 +743,8 @@ camel_block_file_detach_block (CamelBlockFile *bs,
/**
* camel_block_file_attach_block:
- * @bs:
- * @bl:
+ * @bs: a #CamelBlockFile
+ * @bl: a #CamelBlock
*
* Reattach a block that has been detached.
**/
@@ -748,8 +766,8 @@ camel_block_file_attach_block (CamelBlockFile *bs,
/**
* camel_block_file_touch_block:
- * @bs:
- * @bl:
+ * @bs: a #CamelBlockFile
+ * @bl: a #CamelBlock
*
* Mark a block as dirty. The block will be written to disk if
* it ever expires from the cache.
@@ -779,8 +797,8 @@ camel_block_file_touch_block (CamelBlockFile *bs,
/**
* camel_block_file_unref_block:
- * @bs:
- * @bl:
+ * @bs: a #CamelBlockFile
+ * @bl: a #CamelBlock
*
* Mark a block as unused. If a block is used it will not be
* written to disk, or flushed from memory.
@@ -855,8 +873,8 @@ sync_nolock (CamelBlockFile *bs)
/**
* camel_block_file_sync_block:
- * @bs:
- * @bl:
+ * @bs: a #CamelBlockFile
+ * @bl: a #CamelBlock
*
* Flush a block to disk immediately. The block will only
* be flushed to disk if it is marked as dirty (touched).
@@ -885,7 +903,7 @@ camel_block_file_sync_block (CamelBlockFile *bs,
/**
* camel_block_file_sync:
- * @bs:
+ * @bs: a #CamelBlockFile
*
* Sync all dirty blocks to disk, including the root block.
*
@@ -1095,7 +1113,7 @@ key_file_unuse (CamelKeyFile *kf)
/**
* camel_key_file_new:
- * @path:
+ * @path: a filename with path of the #CamelKeyFile to create
* @flags: open flags
* @version: Version string (header) of file. Currently
* written but not checked.
@@ -1211,10 +1229,10 @@ camel_key_file_delete (CamelKeyFile *kf)
/**
* camel_key_file_write:
- * @kf:
- * @parent:
- * @len:
- * @records:
+ * @kf: a #CamelKeyFile
+ * @parent: a #camel_block_t
+ * @len: how many @records to write
+ * @records: an array of #camel_key_t to write
*
* Write a new list of records to the key file.
*
@@ -1274,7 +1292,7 @@ camel_key_file_write (CamelKeyFile *kf,
/**
* camel_key_file_read:
- * @kf:
+ * @kf: a #CamelKeyFile
* @start: The record pointer. This will be set to the next record pointer on success.
* @len: Number of records read, if != NULL.
* @records: Records, allocated, must be freed with g_free, if != NULL.
diff --git a/src/camel/camel-block-file.h b/src/camel/camel-block-file.h
index 3a3e8da..a556dda 100644
--- a/src/camel/camel-block-file.h
+++ b/src/camel/camel-block-file.h
@@ -136,7 +136,7 @@ void camel_block_file_set_cache_limit(CamelBlockFile *bs,
gint block_cache_limit);
gint camel_block_file_rename (CamelBlockFile *bs,
const gchar *path);
-gint camel_block_file_delete (CamelBlockFile *kf);
+gint camel_block_file_delete (CamelBlockFile *bs);
CamelBlock * camel_block_file_new_block (CamelBlockFile *bs);
gint camel_block_file_free_block (CamelBlockFile *bs,
camel_block_t id);
diff --git a/src/camel/camel-certdb.c b/src/camel/camel-certdb.c
index 31a301b..695fb94 100644
--- a/src/camel/camel-certdb.c
+++ b/src/camel/camel-certdb.c
@@ -654,8 +654,12 @@ camel_certdb_touch (CamelCertDB *certdb)
/**
* camel_certdb_get_host:
+ * @certdb: a #CamelCertDB
+ * @hostname: a host name of a certificate
+ * @fingerprint: a fingerprint of a certificate
*
- * FIXME Document me!
+ * Returns: (nullable) (transfer full): a #CamelCert corresponding to the pair of @hostname
+ * and @fingerprint, or %NULL, if no such certificate is stored in the @certdb.
*
* Since: 3.6
**/
@@ -686,8 +690,12 @@ camel_certdb_get_host (CamelCertDB *certdb,
/**
* camel_certdb_put:
+ * @certdb: a #CamelCertDB
+ * @cert: a #CamelCert
*
- * FIXME Document me!
+ * Puts a certificate to the database. In case there exists a certificate
+ * with the same hostname and fingerprint, then it is replaced. This adds
+ * its own reference on the @cert.
*
* Since: 3.6
**/
@@ -724,8 +732,11 @@ camel_certdb_put (CamelCertDB *certdb,
/**
* camel_certdb_remove_host:
+ * @certdb: a #CamelCertDB
+ * @hostname: a host name of a certificate
+ * @fingerprint: a fingerprint of a certificate
*
- * FIXME Document me!
+ * Removes a certificate identified by the @hostname and @fingerprint.
*
* Since: 3.6
**/
diff --git a/src/camel/camel-charset-map.c b/src/camel/camel-charset-map.c
index 1e765c3..c886eea 100644
--- a/src/camel/camel-charset-map.c
+++ b/src/camel/camel-charset-map.c
@@ -318,7 +318,11 @@ camel_charset_init (CamelCharset *c)
/**
* camel_charset_step:
- * @in: (array length=len) (type gchar):
+ * @cc: a #CamelCharset
+ * @in: (array length=len) (type gchar): input text
+ * @len: length of the input text
+ *
+ * Processes more input text with the @cc.
**/
void
camel_charset_step (CamelCharset *cc,
@@ -387,9 +391,11 @@ camel_charset_best_name (CamelCharset *charset)
/**
* camel_charset_best:
- * @in: (array length=len) (type gchar):
+ * @in: (array length=len) (type gchar): input text
+ * @len: length of the input text
+ *
+ * Finds the minimum charset for this string NULL means US-ASCII.
*
- * finds the minimum charset for this string NULL means US-ASCII
* Returns: (nullable): the minimum charset or NULL for US_ASCII.
**/
const gchar *
diff --git a/src/camel/camel-cipher-context.c b/src/camel/camel-cipher-context.c
index d05a866..2b185bc 100644
--- a/src/camel/camel-cipher-context.c
+++ b/src/camel/camel-cipher-context.c
@@ -1159,10 +1159,10 @@ camel_cipher_validity_clone (CamelCipherValidity *vin)
/**
* camel_cipher_validity_add_certinfo:
- * @vin:
- * @mode:
- * @name:
- * @email:
+ * @vin: a #CamelCipherValidity
+ * @mode: a #CamelCipherValidityMode, where to add the additional certificate information
+ * @name: a name to add
+ * @email: an e-mail address to add
*
* Add a cert info to the signer or encrypter info.
*
@@ -1319,8 +1319,8 @@ camel_cipher_validity_set_certinfo_property (CamelCipherValidity *vin,
/**
* camel_cipher_validity_envelope:
- * @parent:
- * @valid:
+ * @parent: a #CamelCipherValidity
+ * @valid: a new #CamelCipherValidity to conglomerate the @parent with
*
* Calculate a conglomerate validity based on wrapping one secure part inside
* another one.
diff --git a/src/camel/camel-data-cache.c b/src/camel/camel-data-cache.c
index 13615a0..cb3c75f 100644
--- a/src/camel/camel-data-cache.c
+++ b/src/camel/camel-data-cache.c
@@ -497,13 +497,13 @@ camel_data_cache_get_filename (CamelDataCache *cdc,
/**
* camel_data_cache_remove:
* @cdc: A #CamelDataCache
- * @path:
- * @key:
+ * @path: Path to the (sub) cache the item exists in.
+ * @key: Key for the cache item.
* @error: return location for a #GError, or %NULL
*
* Remove/expire a cache item.
*
- * Returns:
+ * Returns: 0 on success, -1 on error
**/
gint
camel_data_cache_remove (CamelDataCache *cdc,
diff --git a/src/camel/camel-db.c b/src/camel/camel-db.c
index 4e585ef..bb73c20 100644
--- a/src/camel/camel-db.c
+++ b/src/camel/camel-db.c
@@ -536,14 +536,14 @@ camel_db_init (CamelDB *cdb)
cdb->priv->timer = NULL;
}
-/**
+/*
* cdb_sql_exec
* @db:
* @stmt:
* @error:
*
* Callers should hold the lock
- **/
+ */
static gint
cdb_sql_exec (sqlite3 *db,
const gchar *stmt,
@@ -771,7 +771,7 @@ camel_db_command_internal (CamelDB *cdb,
/**
* camel_db_new:
* @filename: A filename with the database to open/create
- * @error: (out): a #GError for error messages
+ * @error: return location for a #GError, or %NULL
*
* Returns: (transfer full): A new #CamelDB with @filename as its database file.
* Free it with g_object_unref() when no longer needed.
@@ -904,7 +904,14 @@ camel_db_get_filename (CamelDB *cdb)
/**
* camel_db_set_collate:
- * @func: (scope call):
+ * @cdb: a #CamelDB
+ * @col: a column name; currently unused
+ * @collate: collation name
+ * @func: (scope call): a #CamelDBCollate collation function
+ *
+ * Defines a collation @collate, which can be used in SQL (SQLite)
+ * statement as a collation function. The @func is called when
+ * colation is used.
*
* Since: 2.24
**/
@@ -930,6 +937,13 @@ camel_db_set_collate (CamelDB *cdb,
/**
* camel_db_command:
+ * @cdb: a #CamelDB
+ * @stmt: an SQL (SQLite) statement to execute
+ * @error: return location for a #GError, or %NULL
+ *
+ * Executes an SQLite command.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
@@ -943,6 +957,12 @@ camel_db_command (CamelDB *cdb,
/**
* camel_db_begin_transaction:
+ * @cdb: a #CamelDB
+ * @error: return location for a #GError, or %NULL
+ *
+ * Begins transaction. End it with camel_db_end_transaction() or camel_db_abort_transaction().
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
@@ -969,6 +989,12 @@ camel_db_begin_transaction (CamelDB *cdb,
/**
* camel_db_end_transaction:
+ * @cdb: a #CamelDB
+ * @error: return location for a #GError, or %NULL
+ *
+ * Ends an ongoing transaction by committing the changes.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
@@ -995,6 +1021,12 @@ camel_db_end_transaction (CamelDB *cdb,
/**
* camel_db_abort_transaction:
+ * @cdb: a #CamelDB
+ * @error: return location for a #GError, or %NULL
+ *
+ * Ends an ongoing transaction by ignoring the changes.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
@@ -1017,12 +1049,19 @@ camel_db_abort_transaction (CamelDB *cdb,
/**
* camel_db_add_to_transaction:
+ * @cdb: a #CamelDB
+ * @query: an SQL (SQLite) statement
+ * @error: return location for a #GError, or %NULL
+ *
+ * Adds a statement to an ongoing transaction.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
gint
camel_db_add_to_transaction (CamelDB *cdb,
- const gchar *stmt,
+ const gchar *query,
GError **error)
{
if (!cdb)
@@ -1030,19 +1069,24 @@ camel_db_add_to_transaction (CamelDB *cdb,
g_return_val_if_fail (cdb_is_in_transaction (cdb), -1);
- return (cdb_sql_exec (cdb->priv->db, stmt, NULL, NULL, NULL, error));
+ return (cdb_sql_exec (cdb->priv->db, query, NULL, NULL, NULL, error));
}
/**
* camel_db_transaction_command:
* @cdb: a #CamelDB
* @qry_list: (element-type utf8) (transfer none): A #GList of querries
+ * @error: return location for a #GError, or %NULL
+ *
+ * Runs the list of commands as a single transaction.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
gint
camel_db_transaction_command (CamelDB *cdb,
- GList *qry_list,
+ const GList *qry_list,
GError **error)
{
gboolean in_transaction = FALSE;
@@ -1094,6 +1138,15 @@ count_cb (gpointer data,
/**
* camel_db_count_message_info:
+ * @cdb: a #CamelDB
+ * @query: a COUNT() query
+ * @count: (out): the result of the query
+ * @error: return location for a #GError, or %NULL
+ *
+ * Executes a COUNT() query (like "SELECT COUNT(*) FROM table") and provides
+ * the result of it as an unsigned 32-bit integer.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.26
**/
@@ -1120,6 +1173,14 @@ camel_db_count_message_info (CamelDB *cdb,
/**
* camel_db_count_junk_message_info:
+ * @cdb: a #CamelDB
+ * @table_name: name of the table
+ * @count: (out): where to store the resulting count
+ * @error: return location for a #GError, or %NULL
+ *
+ * Counts how many junk messages is stored in the given table.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
@@ -1145,6 +1206,14 @@ camel_db_count_junk_message_info (CamelDB *cdb,
/**
* camel_db_count_unread_message_info:
+ * @cdb: a #CamelDB
+ * @table_name: name of the table
+ * @count: (out): where to store the resulting count
+ * @error: return location for a #GError, or %NULL
+ *
+ * Counts how many unread messages is stored in the given table.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
@@ -1170,6 +1239,14 @@ camel_db_count_unread_message_info (CamelDB *cdb,
/**
* camel_db_count_visible_unread_message_info:
+ * @cdb: a #CamelDB
+ * @table_name: name of the table
+ * @count: (out): where to store the resulting count
+ * @error: return location for a #GError, or %NULL
+ *
+ * Counts how many visible (not deleted and not junk) and unread messages is stored in the given table.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
@@ -1195,6 +1272,14 @@ camel_db_count_visible_unread_message_info (CamelDB *cdb,
/**
* camel_db_count_visible_message_info:
+ * @cdb: a #CamelDB
+ * @table_name: name of the table
+ * @count: (out): where to store the resulting count
+ * @error: return location for a #GError, or %NULL
+ *
+ * Counts how many visible (not deleted and not junk) messages is stored in the given table.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
@@ -1220,6 +1305,14 @@ camel_db_count_visible_message_info (CamelDB *cdb,
/**
* camel_db_count_junk_not-deleted_message_info:
+ * @cdb: a #CamelDB
+ * @table_name: name of the table
+ * @count: (out): where to store the resulting count
+ * @error: return location for a #GError, or %NULL
+ *
+ * Counts how many junk, but not deleted, messages is stored in the given table.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
@@ -1245,6 +1338,14 @@ camel_db_count_junk_not_deleted_message_info (CamelDB *cdb,
/**
* camel_db_count_deleted_message_info:
+ * @cdb: a #CamelDB
+ * @table_name: name of the table
+ * @count: (out): where to store the resulting count
+ * @error: return location for a #GError, or %NULL
+ *
+ * Counts how many deleted messages is stored in the given table.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
@@ -1270,6 +1371,14 @@ camel_db_count_deleted_message_info (CamelDB *cdb,
/**
* camel_db_count_total_message_info:
+ * @cdb: a #CamelDB
+ * @table_name: name of the table
+ * @count: (out): where to store the resulting count
+ * @error: return location for a #GError, or %NULL
+ *
+ * Counts how many messages is stored in the given table.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
@@ -1296,7 +1405,15 @@ camel_db_count_total_message_info (CamelDB *cdb,
/**
* camel_db_select:
- * @callback: (scope async):
+ * @cdb: a #CamelDB
+ * @stmt: a SELECT statment to execute
+ * @callback: (scope call) (closure user_data): a callback to call for each row
+ * @user_data: user data for the @callback
+ * @error: return location for a #GError, or %NULL
+ *
+ * Executes a SELECT staement and calls the @callback for each selected row.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
@@ -1359,23 +1476,32 @@ read_uids_to_hash_callback (gpointer ref_hash,
/**
* camel_db_get_folder_uids:
+ * @cdb: a #CamelDB
+ * @folder_name: full name of the folder
+ * @sort_by: (nullable): optional ORDER BY clause (without the "ORDER BY" prefix)
+ * @collate: (nullable): optional collate function name to use
+ * @hash: (element-type utf8 guint32): a hash table to fill
+ * @error: return location for a #GError, or %NULL
*
- * Fills hash with uid->GUINT_TO_POINTER (flag)
+ * Fills hash with uid->GUINT_TO_POINTER (flag). Use camel_pstring_free()
+ * to free the keys of the @hash.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
gint
-camel_db_get_folder_uids (CamelDB *db,
+camel_db_get_folder_uids (CamelDB *cdb,
const gchar *folder_name,
const gchar *sort_by,
const gchar *collate,
GHashTable *hash,
GError **error)
{
- gchar *sel_query;
- gint ret;
+ gchar *sel_query;
+ gint ret;
- sel_query = sqlite3_mprintf (
+ sel_query = sqlite3_mprintf (
"SELECT uid,flags FROM %Q%s%s%s%s",
folder_name,
sort_by ? " order by " : "",
@@ -1383,72 +1509,89 @@ camel_db_get_folder_uids (CamelDB *db,
(sort_by && collate) ? " collate " : "",
(sort_by && collate) ? collate : "");
- ret = camel_db_select (db, sel_query, read_uids_to_hash_callback, hash, error);
- sqlite3_free (sel_query);
+ ret = camel_db_select (cdb, sel_query, read_uids_to_hash_callback, hash, error);
+ sqlite3_free (sel_query);
- return ret;
+ return ret;
}
/**
* camel_db_get_folder_junk_uids:
+ * @cdb: a #CamelDB
+ * @folder_name: full name of the folder
+ * @error: return location for a #GError, or %NULL
*
- * Returns: (element-type utf8) (transfer full):
+ * Returns: (element-type utf8) (transfer full) (nullable): An array
+ * of the UID-s of the junk messages in the given folder. Use
+ * camel_pstring_free() to free the elements.
*
* Since: 2.24
**/
GPtrArray *
-camel_db_get_folder_junk_uids (CamelDB *db,
+camel_db_get_folder_junk_uids (CamelDB *cdb,
const gchar *folder_name,
GError **error)
{
- gchar *sel_query;
- gint ret;
- GPtrArray *array = g_ptr_array_new ();
+ gchar *sel_query;
+ gint ret;
+ GPtrArray *array = g_ptr_array_new ();
- sel_query = sqlite3_mprintf ("SELECT uid FROM %Q where junk=1", folder_name);
+ sel_query = sqlite3_mprintf ("SELECT uid FROM %Q where junk=1", folder_name);
- ret = camel_db_select (db, sel_query, read_uids_callback, array, error);
+ ret = camel_db_select (cdb, sel_query, read_uids_callback, array, error);
- sqlite3_free (sel_query);
+ sqlite3_free (sel_query);
+
+ if (!array->len || ret != 0) {
+ g_ptr_array_free (array, TRUE);
+ array = NULL;
+ }
- if (!array->len || ret != 0) {
- g_ptr_array_free (array, TRUE);
- array = NULL;
- }
- return array;
+ return array;
}
/**
* camel_db_get_folder_deleted_uids:
+ * @cdb: a #CamelDB
+ * @folder_name: full name of the folder
+ * @error: return location for a #GError, or %NULL
*
- * Returns: (element-type utf8) (transfer full):
+ * Returns: (element-type utf8) (transfer full) (nullable): An array
+ * of the UID-s of the deleted messages in the given folder. Use
+ * camel_pstring_free() to free the elements.
*
* Since: 2.24
**/
GPtrArray *
-camel_db_get_folder_deleted_uids (CamelDB *db,
+camel_db_get_folder_deleted_uids (CamelDB *cdb,
const gchar *folder_name,
GError **error)
{
- gchar *sel_query;
- gint ret;
- GPtrArray *array = g_ptr_array_new ();
+ gchar *sel_query;
+ gint ret;
+ GPtrArray *array = g_ptr_array_new ();
- sel_query = sqlite3_mprintf ("SELECT uid FROM %Q where deleted=1", folder_name);
+ sel_query = sqlite3_mprintf ("SELECT uid FROM %Q where deleted=1", folder_name);
- ret = camel_db_select (db, sel_query, read_uids_callback, array, error);
- sqlite3_free (sel_query);
+ ret = camel_db_select (cdb, sel_query, read_uids_callback, array, error);
+ sqlite3_free (sel_query);
- if (!array->len || ret != 0) {
- g_ptr_array_free (array, TRUE);
- array = NULL;
- }
+ if (!array->len || ret != 0) {
+ g_ptr_array_free (array, TRUE);
+ array = NULL;
+ }
- return array;
+ return array;
}
/**
* camel_db_create_folders_table:
+ * @cdb: a #CamelDB
+ * @error: return location for a #GError, or %NULL
+ *
+ * Creates a 'folders' table, if it doesn't exist yet.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
@@ -1700,6 +1843,14 @@ camel_db_migrate_folder_recreate (CamelDB *cdb,
/**
* camel_db_reset_folder_version:
+ * @cdb: a #CamelDB
+ * @folder_name: full name of the folder
+ * @reset_version: version number to set
+ * @error: return location for a #GError, or %NULL
+ *
+ * Sets a version number for the given folder.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.28
**/
@@ -1787,6 +1938,13 @@ camel_db_get_folder_version (CamelDB *cdb,
/**
* camel_db_prepare_message_info_table:
+ * @cdb: a #CamelDB
+ * @folder_name: full name of the folder
+ * @error: return location for a #GError, or %NULL
+ *
+ * Prepares message info table for the given folder.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
@@ -1846,15 +2004,26 @@ exit:
return ret;
}
-static gint
-write_mir (CamelDB *cdb,
- const gchar *folder_name,
- CamelMIRecord *record,
- GError **error,
- gboolean delete_old_record)
+/**
+ * camel_db_write_message_info_record:
+ * @cdb: a #CamelDB
+ * @folder_name: full name of the folder
+ * @record: a #CamelMIRecord
+ * @error: return location for a #GError, or %NULL
+ *
+ * Write the @record to the message info table of the given folder.
+ *
+ * Returns: 0 on success, -1 on error
+ *
+ * Since: 2.24
+ **/
+gint
+camel_db_write_message_info_record (CamelDB *cdb,
+ const gchar *folder_name,
+ CamelMIRecord *record,
+ GError **error)
{
gint ret;
- /*char *del_query;*/
gchar *ins_query;
if (!record) {
@@ -1862,8 +2031,6 @@ write_mir (CamelDB *cdb,
return -1;
}
- /* FIXME: We should migrate from this DELETE followed by INSERT model to an INSERT OR REPLACE model
as pointed out by pvanhoof */
-
/* NB: UGLIEST Hack. We can't modify the schema now. We are using dirty (an unsed one to notify of
FLAGGED/Dirty infos */
ins_query = sqlite3_mprintf (
@@ -1909,35 +2076,14 @@ write_mir (CamelDB *cdb,
}
/**
- * camel_db_write_fresh_message_info_record:
+ * camel_db_write_folder_info_record:
+ * @cdb: a #CamelDB
+ * @record: a #CamelFIRecord
+ * @error: return location for a #GError, or %NULL
*
- * Since: 2.26
- **/
-gint
-camel_db_write_fresh_message_info_record (CamelDB *cdb,
- const gchar *folder_name,
- CamelMIRecord *record,
- GError **error)
-{
- return write_mir (cdb, folder_name, record, error, FALSE);
-}
-
-/**
- * camel_db_write_message_info_record:
+ * Write the @record to the 'folders' table.
*
- * Since: 2.24
- **/
-gint
-camel_db_write_message_info_record (CamelDB *cdb,
- const gchar *folder_name,
- CamelMIRecord *record,
- GError **error)
-{
- return write_mir (cdb, folder_name, record, error, TRUE);
-}
-
-/**
- * camel_db_write_folder_info_record:
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
@@ -2048,6 +2194,14 @@ read_fir_callback (gpointer ref,
/**
* camel_db_read_folder_info_record:
+ * @cdb: a #CamelDB
+ * @folder_name: full name of the folder
+ * @record: (out caller-allocates): a #CamelFIRecord
+ * @error: return location for a #GError, or %NULL
+ *
+ * reads folder information for the given folder and stores it into the @record.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
@@ -2076,7 +2230,17 @@ camel_db_read_folder_info_record (CamelDB *cdb,
/**
* camel_db_read_message_info_record_with_uid:
- * @read_mir_callback: (scope async) (closure user_data):
+ * @cdb: a #CamelDB
+ * @folder_name: full name of the folder
+ * @uid: a message info UID to read the record for
+ * @user_data: user data of the @callback
+ * @callback: (scope call) (closure user_data): callback to call for the found row
+ * @error: return location for a #GError, or %NULL
+ *
+ * Selects single message info for the given @uid in folder @folder_name and calls
+ * the @callback for it.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
@@ -2085,7 +2249,7 @@ camel_db_read_message_info_record_with_uid (CamelDB *cdb,
const gchar *folder_name,
const gchar *uid,
gpointer user_data,
- CamelDBSelectCB read_mir_callback,
+ CamelDBSelectCB callback,
GError **error)
{
gchar *query;
@@ -2096,7 +2260,7 @@ camel_db_read_message_info_record_with_uid (CamelDB *cdb,
"mail_from, mail_to, mail_cc, mlist, part, labels, "
"usertags, cinfo, bdata FROM %Q WHERE uid = %Q",
folder_name, uid);
- ret = camel_db_select (cdb, query, read_mir_callback, user_data, error);
+ ret = camel_db_select (cdb, query, callback, user_data, error);
sqlite3_free (query);
return (ret);
@@ -2104,7 +2268,15 @@ camel_db_read_message_info_record_with_uid (CamelDB *cdb,
/**
* camel_db_read_message_info_records:
- * @read_mir_callback: (scope async) (closure user_data):
+ * @cdb: a #CamelDB
+ * @folder_name: full name of the folder
+ * @user_data: user data for the @callback
+ * @callback: (scope async) (closure user_data): callback to call for each found row
+ * @error: return location for a #GError, or %NULL
+ *
+ * Reads all mesasge info records for the given folder and calls @callback for them.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
@@ -2112,7 +2284,7 @@ gint
camel_db_read_message_info_records (CamelDB *cdb,
const gchar *folder_name,
gpointer user_data,
- CamelDBSelectCB read_mir_callback,
+ CamelDBSelectCB callback,
GError **error)
{
gchar *query;
@@ -2122,7 +2294,7 @@ camel_db_read_message_info_records (CamelDB *cdb,
"SELECT uid, flags, size, dsent, dreceived, subject, "
"mail_from, mail_to, mail_cc, mlist, part, labels, "
"usertags, cinfo, bdata FROM %Q ", folder_name);
- ret = camel_db_select (cdb, query, read_mir_callback, user_data, error);
+ ret = camel_db_select (cdb, query, callback, user_data, error);
sqlite3_free (query);
return (ret);
@@ -2130,12 +2302,21 @@ camel_db_read_message_info_records (CamelDB *cdb,
/**
* camel_db_delete_uid:
+ * @cdb: a #CamelDB
+ * @folder_name: full name of the folder
+ * @uid: a message info UID to delete
+ * @error: return location for a #GError, or %NULL
+ *
+ * Deletes single mesage info in the given folder with
+ * the given UID.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
gint
camel_db_delete_uid (CamelDB *cdb,
- const gchar *folder,
+ const gchar *folder_name,
const gchar *uid,
GError **error)
{
@@ -2144,7 +2325,7 @@ camel_db_delete_uid (CamelDB *cdb,
camel_db_begin_transaction (cdb, error);
- tab = sqlite3_mprintf ("DELETE FROM %Q WHERE uid = %Q", folder, uid);
+ tab = sqlite3_mprintf ("DELETE FROM %Q WHERE uid = %Q", folder_name, uid);
ret = camel_db_add_to_transaction (cdb, tab, error);
sqlite3_free (tab);
@@ -2157,7 +2338,7 @@ camel_db_delete_uid (CamelDB *cdb,
static gint
cdb_delete_ids (CamelDB *cdb,
const gchar *folder_name,
- GList *uids,
+ const GList *uids,
const gchar *uid_prefix,
const gchar *field,
GError **error)
@@ -2166,7 +2347,7 @@ cdb_delete_ids (CamelDB *cdb,
gint ret = 0;
gboolean first = TRUE;
GString *str = g_string_new ("DELETE FROM ");
- GList *iterator;
+ const GList *iterator;
camel_db_begin_transaction (cdb, error);
@@ -2211,14 +2392,20 @@ cdb_delete_ids (CamelDB *cdb,
/**
* camel_db_delete_uids:
* @cdb: a #CamelDB
+ * @folder_name: full name of the folder
* @uids: (element-type utf8) (transfer none): A #GList of uids
+ * @error: return location for a #GError, or %NULL
+ *
+ * Deletes a list of message UIDs as one transaction.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
gint
camel_db_delete_uids (CamelDB *cdb,
const gchar *folder_name,
- GList *uids,
+ const GList *uids,
GError **error)
{
if (!uids || !uids->data)
@@ -2229,20 +2416,28 @@ camel_db_delete_uids (CamelDB *cdb,
/**
* camel_db_clear_folder_summary:
+ * @cdb: a #CamelDB
+ * @folder_name: full name of the folder
+ * @error: return location for a #GError, or %NULL
+ *
+ * Deletes the given folder from the 'folders' table and empties
+ * its message info table.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
gint
camel_db_clear_folder_summary (CamelDB *cdb,
- const gchar *folder,
+ const gchar *folder_name,
GError **error)
{
gint ret;
gchar *folders_del;
gchar *msginfo_del;
- folders_del = sqlite3_mprintf ("DELETE FROM folders WHERE folder_name = %Q", folder);
- msginfo_del = sqlite3_mprintf ("DELETE FROM %Q ", folder);
+ folders_del = sqlite3_mprintf ("DELETE FROM folders WHERE folder_name = %Q", folder_name);
+ msginfo_del = sqlite3_mprintf ("DELETE FROM %Q ", folder_name);
camel_db_begin_transaction (cdb, error);
@@ -2259,12 +2454,20 @@ camel_db_clear_folder_summary (CamelDB *cdb,
/**
* camel_db_delete_folder:
+ * @cdb: a #CamelDB
+ * @folder_name: full name of the folder
+ * @error: return location for a #GError, or %NULL
+ *
+ * Deletes the given folder from the 'folders' table and also drops
+ * its message info table.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
gint
camel_db_delete_folder (CamelDB *cdb,
- const gchar *folder,
+ const gchar *folder_name,
GError **error)
{
gint ret;
@@ -2272,11 +2475,11 @@ camel_db_delete_folder (CamelDB *cdb,
camel_db_begin_transaction (cdb, error);
- del = sqlite3_mprintf ("DELETE FROM folders WHERE folder_name = %Q", folder);
+ del = sqlite3_mprintf ("DELETE FROM folders WHERE folder_name = %Q", folder_name);
ret = camel_db_add_to_transaction (cdb, del, error);
sqlite3_free (del);
- del = sqlite3_mprintf ("DROP TABLE %Q ", folder);
+ del = sqlite3_mprintf ("DROP TABLE %Q ", folder_name);
ret = camel_db_add_to_transaction (cdb, del, error);
sqlite3_free (del);
@@ -2288,13 +2491,21 @@ camel_db_delete_folder (CamelDB *cdb,
/**
* camel_db_rename_folder:
+ * @cdb: a #CamelDB
+ * @old_folder_name: full name of the existing folder
+ * @new_folder_name: full name of the folder to rename it to
+ * @error: return location for a #GError, or %NULL
+ *
+ * Renames tables for the @old_folder_name to be used with @new_folder_name.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.24
**/
gint
camel_db_rename_folder (CamelDB *cdb,
- const gchar *old_folder,
- const gchar *new_folder,
+ const gchar *old_folder_name,
+ const gchar *new_folder_name,
GError **error)
{
gint ret;
@@ -2302,19 +2513,19 @@ camel_db_rename_folder (CamelDB *cdb,
camel_db_begin_transaction (cdb, error);
- cmd = sqlite3_mprintf ("ALTER TABLE %Q RENAME TO %Q", old_folder, new_folder);
+ cmd = sqlite3_mprintf ("ALTER TABLE %Q RENAME TO %Q", old_folder_name, new_folder_name);
ret = camel_db_add_to_transaction (cdb, cmd, error);
sqlite3_free (cmd);
- cmd = sqlite3_mprintf ("ALTER TABLE '%q_version' RENAME TO '%q_version'", old_folder, new_folder);
+ cmd = sqlite3_mprintf ("ALTER TABLE '%q_version' RENAME TO '%q_version'", old_folder_name,
new_folder_name);
ret = camel_db_add_to_transaction (cdb, cmd, error);
sqlite3_free (cmd);
- cmd = sqlite3_mprintf ("UPDATE %Q SET modified=strftime(\"%%s\", 'now'), created=strftime(\"%%s\",
'now')", new_folder);
+ cmd = sqlite3_mprintf ("UPDATE %Q SET modified=strftime(\"%%s\", 'now'), created=strftime(\"%%s\",
'now')", new_folder_name);
ret = camel_db_add_to_transaction (cdb, cmd, error);
sqlite3_free (cmd);
- cmd = sqlite3_mprintf ("UPDATE folders SET folder_name = %Q WHERE folder_name = %Q", new_folder,
old_folder);
+ cmd = sqlite3_mprintf ("UPDATE folders SET folder_name = %Q WHERE folder_name = %Q", new_folder_name,
old_folder_name);
ret = camel_db_add_to_transaction (cdb, cmd, error);
sqlite3_free (cmd);
@@ -2326,6 +2537,9 @@ camel_db_rename_folder (CamelDB *cdb,
/**
* camel_db_camel_mir_free:
+ * @record: (nullable): a #CamelMIRecord
+ *
+ * Frees the @record and all of its associated data.
*
* Since: 2.24
**/
@@ -2354,6 +2568,12 @@ camel_db_camel_mir_free (CamelMIRecord *record)
/**
* camel_db_sqlize_string:
+ * @string: a string to "sqlize"
+ *
+ * Converts the @string to be usable in the SQLite statements.
+ *
+ * Returns: (transfer full): A newly allocated sqlized @string. The returned
+ * value should be freed with camel_db_sqlize_string(), when no longer needed.
*
* Since: 2.24
**/
@@ -2365,14 +2585,17 @@ camel_db_sqlize_string (const gchar *string)
/**
* camel_db_free_sqlized_string:
+ * @string: (nullable): a string to free
+ *
+ * Frees a string previosuly returned by camel_db_sqlize_string().
*
* Since: 2.24
**/
void
camel_db_free_sqlized_string (gchar *string)
{
- sqlite3_free (string);
- string = NULL;
+ if (string)
+ sqlite3_free (string);
}
/*
@@ -2391,6 +2614,10 @@ followup_due_by TEXT ," */
/**
* camel_db_get_column_name:
+ * @raw_name: raw name to find the column name for
+ *
+ * Returns: (nullable): A corresponding column name in the message info table
+ * for the @raw_name, or %NULL, when there is no corresponding column in the summary.
*
* Since: 2.24
**/
@@ -2430,6 +2657,13 @@ camel_db_get_column_name (const gchar *raw_name)
/**
* camel_db_start_in_memory_transactions:
+ * @cdb: a #CamelDB
+ * @error: return location for a #GError, or %NULL
+ *
+ * Creates an in-memory table for a batch transactions. Use camel_db_flush_in_memory_transactions()
+ * to commit the changes and free the in-memory table.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.26
**/
@@ -2482,6 +2716,14 @@ camel_db_start_in_memory_transactions (CamelDB *cdb,
/**
* camel_db_flush_in_memory_transactions:
+ * @cdb: a #CamelDB
+ * @folder_name: full name of the folder
+ * @error: return location for a #GError, or %NULL
+ *
+ * A pair function for camel_db_start_in_memory_transactions(),
+ * to commit the changes to @folder_name and free the in-memory table.
+ *
+ * Returns: 0 on success, -1 on error
*
* Since: 2.26
**/
@@ -2550,10 +2792,10 @@ static struct _known_column_names {
/**
* camel_db_get_column_ident:
- * @hash: (inout):
- * @index:
+ * @hash: (inout): a #GHashTable
+ * @index: an index to start with, between 0 and @ncols
* @ncols: number of @col_names
- * @col_names: (array length=ncols):
+ * @col_names: (array length=ncols): column names to traverse
*
* Traverses column name from index @index into an enum
* #CamelDBKnownColumnNames value. The @col_names contains @ncols columns.
@@ -2626,7 +2868,7 @@ get_number_cb (gpointer data,
/**
* camel_db_maybe_run_maintenance:
- * @cdb: a #CamelDB instance
+ * @cdb: a #CamelDB
* @error: (allow-none): a #GError or %NULL
*
* Runs a @cdb maintenance, which includes vacuum, if necessary.
diff --git a/src/camel/camel-db.h b/src/camel/camel-db.h
index 77a88b9..42e3205 100644
--- a/src/camel/camel-db.h
+++ b/src/camel/camel-db.h
@@ -58,11 +58,13 @@ typedef struct _CamelDBPrivate CamelDBPrivate;
* Since: 2.24
**/
struct _CamelDB {
+ /*< private >*/
GObject parent;
CamelDBPrivate *priv;
};
struct _CamelDBClass {
+ /*< private >*/
GObjectClass parent_class;
/* Padding for future expansion */
@@ -71,10 +73,19 @@ struct _CamelDBClass {
/**
* CamelDBCollate:
+ * @enc: a used encoding (SQLITE_UTF8)
+ * @length1: length of the @data1
+ * @data1: the first value, of lenth @length1
+ * @length2: length of the @data2
+ * @data2: the second value, of lenth @length2
+ *
+ * A collation callback function.
+ *
+ * Returns: less than zero, zero, or greater than zero value, the same as for example strcmp() does.
*
* Since: 2.24
**/
-typedef gint (*CamelDBCollate)(gpointer enc, gint length1, gconstpointer data1, gint length2, gconstpointer
data2);
+typedef gint (* CamelDBCollate)(gpointer enc, gint length1, gconstpointer data1, gint length2, gconstpointer
data2);
/**
* CAMEL_DB_FILE:
@@ -123,56 +134,32 @@ typedef gint (*CamelDBCollate)(gpointer enc, gint length1, gconstpointer data1,
/**
* CamelMIRecord:
- * @uid:
- * Message UID
- * @flags:
- * Camel Message info flags
- * @msg_type:
- * @dirty:
- * @read:
- * boolean read status
- * @deleted:
- * boolean deleted status
- * @replied:
- * boolean replied status
- * @important:
- * boolean important status
- * @junk:
- * boolean junk status
- * @attachment:
- * boolean attachment status
- * @size:
- * size of the mail
- * @dsent:
- * date sent
- * @dreceived:
- * date received
- * @subject:
- * subject of the mail
- * @from:
- * sender
- * @to:
- * recipient
- * @cc:
- * CC members
- * @mlist:
- * message list headers
- * @followup_flag:
- * followup flag / also can be queried to see for followup or not
- * @followup_completed_on:
- * completed date, can be used to see if completed
- * @followup_due_by:
- * to see the due by date
- * @part:
- * part / references / thread id
- * @labels:
- * labels of mails also called as userflags
- * @usertags:
- * composite string of user tags
- * @cinfo:
- * content info string - composite string
- * @bdata:
- * provider specific data
+ * @uid: Message UID
+ * @flags: Camel Message info flags
+ * @msg_type: unused
+ * @dirty: whether the message info requires upload to the server; it corresponds to
#CAMEL_MESSAGE_FOLDER_FLAGGED
+ * @read: boolean read status
+ * @deleted: boolean deleted status
+ * @replied: boolean replied status
+ * @important: boolean important status
+ * @junk: boolean junk status
+ * @attachment: boolean attachment status
+ * @size: size of the mail
+ * @dsent: date sent
+ * @dreceived: date received
+ * @subject: subject of the mail
+ * @from: sender
+ * @to: recipient
+ * @cc: CC members
+ * @mlist: message list headers
+ * @followup_flag: followup flag / also can be queried to see for followup or not
+ * @followup_completed_on: completed date, can be used to see if completed
+ * @followup_due_by: to see the due by date
+ * @part: part / references / thread id
+ * @labels: labels of mails also called as userflags
+ * @usertags: composite string of user tags
+ * @cinfo: content info string - composite string
+ * @bdata: provider specific data
*
* The extensive DB format, supporting basic searching and sorting.
*
@@ -209,6 +196,20 @@ typedef struct _CamelMIRecord {
/**
* CamelFIRecord:
+ * @folder_name: name of the folder
+ * @version: version of the saved information
+ * @flags: folder flags
+ * @nextuid: next free uid
+ * @timestamp: timestamp of the summary
+ * @saved_count: count of all messages
+ * @unread_count: count of unread messages
+ * @deleted_count: count of deleted messages
+ * @junk_count: count of junk messages
+ * @visible_count: count of visible (not deleted and not junk) messages
+ * @jnd_count: count of junk and not deleted messages
+ * @bdata: custom data of the #CamelFolderSummary descendants
+ *
+ * Values to store/load for single folder's #CamelFolderSummary structure.
*
* Since: 2.24
**/
@@ -229,6 +230,44 @@ typedef struct _CamelFIRecord {
/**
* CamelDBKnownColumnNames:
+ * @CAMEL_DB_COLUMN_UNKNOWN: unknown column name
+ * @CAMEL_DB_COLUMN_ATTACHMENT: attachment
+ * @CAMEL_DB_COLUMN_BDATA: bdata
+ * @CAMEL_DB_COLUMN_CINFO: cinfo
+ * @CAMEL_DB_COLUMN_DELETED: deleted
+ * @CAMEL_DB_COLUMN_DELETED_COUNT: deleted_count
+ * @CAMEL_DB_COLUMN_DRECEIVED: dreceived
+ * @CAMEL_DB_COLUMN_DSENT: dsent
+ * @CAMEL_DB_COLUMN_FLAGS: flags
+ * @CAMEL_DB_COLUMN_FOLDER_NAME: folder_name
+ * @CAMEL_DB_COLUMN_FOLLOWUP_COMPLETED_ON: followup_completed_on
+ * @CAMEL_DB_COLUMN_FOLLOWUP_DUE_BY: followup_due_by
+ * @CAMEL_DB_COLUMN_FOLLOWUP_FLAG: followup_flag
+ * @CAMEL_DB_COLUMN_IMPORTANT: important
+ * @CAMEL_DB_COLUMN_JND_COUNT: jnd_count
+ * @CAMEL_DB_COLUMN_JUNK: junk
+ * @CAMEL_DB_COLUMN_JUNK_COUNT: junk_count
+ * @CAMEL_DB_COLUMN_LABELS: labels
+ * @CAMEL_DB_COLUMN_MAIL_CC: mail_cc
+ * @CAMEL_DB_COLUMN_MAIL_FROM: mail_from
+ * @CAMEL_DB_COLUMN_MAIL_TO: mail_to
+ * @CAMEL_DB_COLUMN_MLIST: mlist
+ * @CAMEL_DB_COLUMN_NEXTUID: nextuid
+ * @CAMEL_DB_COLUMN_PART: part
+ * @CAMEL_DB_COLUMN_READ: read
+ * @CAMEL_DB_COLUMN_REPLIED: replied
+ * @CAMEL_DB_COLUMN_SAVED_COUNT: saved_count
+ * @CAMEL_DB_COLUMN_SIZE: size
+ * @CAMEL_DB_COLUMN_SUBJECT: subject
+ * @CAMEL_DB_COLUMN_TIME: time
+ * @CAMEL_DB_COLUMN_UID: uid
+ * @CAMEL_DB_COLUMN_UNREAD_COUNT: unread_count
+ * @CAMEL_DB_COLUMN_USERTAGS: usertags
+ * @CAMEL_DB_COLUMN_VERSION: version
+ * @CAMEL_DB_COLUMN_VISIBLE_COUNT: visible_count
+ * @CAMEL_DB_COLUMN_VUID: vuid
+ *
+ * An enum of all the known columns, which can be used for a quick column lookups.
*
* Since: 3.4
**/
@@ -275,10 +314,19 @@ CamelDBKnownColumnNames camel_db_get_column_ident (GHashTable **hash, gint index
/**
* CamelDBSelectCB:
+ * @user_data: a callback user data
+ * @ncol: how many columns is provided
+ * @colvalues: (array length=ncol): array of column values, as UTF-8 strings
+ * @colnames: (array length=ncol): array of column names
+ *
+ * A callback called for the SELECT statements. The items at the same index of @colvalues
+ * and @colnames correspond to each other.
+ *
+ * Returns: 0 to continue the SELECT execution, non-zero to abort the execution.
*
* Since: 2.24
**/
-typedef gint (*CamelDBSelectCB) (gpointer user_data, gint ncol, gchar **colvalues, gchar **colnames);
+typedef gint (* CamelDBSelectCB) (gpointer user_data, gint ncol, gchar **colvalues, gchar **colnames);
GType camel_db_get_type (void) G_GNUC_CONST;
@@ -289,7 +337,7 @@ gint camel_db_command (CamelDB *cdb,
const gchar *stmt,
GError **error);
gint camel_db_transaction_command (CamelDB *cdb,
- GList *qry_list,
+ const GList *qry_list,
GError **error);
gint camel_db_begin_transaction (CamelDB *cdb,
GError **error);
@@ -301,22 +349,22 @@ gint camel_db_end_transaction (CamelDB *cdb,
gint camel_db_abort_transaction (CamelDB *cdb,
GError **error);
gint camel_db_clear_folder_summary (CamelDB *cdb,
- const gchar *folder,
+ const gchar *folder_name,
GError **error);
gint camel_db_rename_folder (CamelDB *cdb,
- const gchar *old_folder,
- const gchar *new_folder,
+ const gchar *old_folder_name,
+ const gchar *new_folder_name,
GError **error);
gint camel_db_delete_folder (CamelDB *cdb,
- const gchar *folder,
+ const gchar *folder_name,
GError **error);
gint camel_db_delete_uid (CamelDB *cdb,
- const gchar *folder,
+ const gchar *folder_name,
const gchar *uid,
GError **error);
gint camel_db_delete_uids (CamelDB *cdb,
const gchar *folder_name,
- GList *uids,
+ const GList *uids,
GError **error);
gint camel_db_create_folders_table (CamelDB *cdb,
GError **error);
@@ -343,23 +391,18 @@ gint camel_db_write_message_info_record
const gchar *folder_name,
CamelMIRecord *record,
GError **error);
-gint camel_db_write_fresh_message_info_record
- (CamelDB *cdb,
- const gchar *folder_name,
- CamelMIRecord *record,
- GError **error);
gint camel_db_read_message_info_records
(CamelDB *cdb,
const gchar *folder_name,
gpointer user_data,
- CamelDBSelectCB read_mir_callback,
+ CamelDBSelectCB callback,
GError **error);
gint camel_db_read_message_info_record_with_uid
(CamelDB *cdb,
const gchar *folder_name,
const gchar *uid,
gpointer user_data,
- CamelDBSelectCB read_mir_callback,
+ CamelDBSelectCB callback,
GError **error);
gint camel_db_count_junk_message_info
(CamelDB *cdb,
@@ -400,17 +443,17 @@ gint camel_db_count_message_info (CamelDB *cdb,
const gchar *query,
guint32 *count,
GError **error);
-gint camel_db_get_folder_uids (CamelDB *db,
+gint camel_db_get_folder_uids (CamelDB *cdb,
const gchar *folder_name,
const gchar *sort_by,
const gchar *collate,
GHashTable *hash,
GError **error);
-GPtrArray * camel_db_get_folder_junk_uids (CamelDB *db,
+GPtrArray * camel_db_get_folder_junk_uids (CamelDB *cdb,
const gchar *folder_name,
GError **error);
GPtrArray * camel_db_get_folder_deleted_uids
- (CamelDB *db,
+ (CamelDB *cdb,
const gchar *folder_name,
GError **error);
gint camel_db_set_collate (CamelDB *cdb,
diff --git a/src/camel/camel-debug.c b/src/camel/camel-debug.c
index a0677ab..911c7e0 100644
--- a/src/camel/camel-debug.c
+++ b/src/camel/camel-debug.c
@@ -78,16 +78,17 @@ camel_debug_init (void)
/**
* camel_debug:
- * @mode:
+ * @mode: string name of the mode to check for
*
* Check to see if a debug mode is activated. @mode takes one of two forms,
* a fully qualified 'module:target', or a wildcard 'module' name. It
* returns a boolean to indicate if the module or module and target is
* currently activated for debug output.
*
- * Returns:
+ * Returns: Whether the debug @mode is activated
**/
-gboolean camel_debug (const gchar *mode)
+gboolean
+camel_debug (const gchar *mode)
{
if (camel_verbose_debug)
return TRUE;
@@ -124,13 +125,13 @@ gboolean camel_debug (const gchar *mode)
static GMutex debug_lock;
/**
* camel_debug_start:
- * @mode:
+ * @mode: string name of the mode to start the debug for
*
* Start debug output for a given mode, used to make sure debug output
* is output atomically and not interspersed with unrelated stuff.
*
- * Returns: Returns true if mode is set, and in which case, you must
- * call debug_end when finished any screen output.
+ * Returns: %TRUE if mode is set, and in which case, you must
+ * call camel_debug_end() when finished any screen output.
**/
gboolean
camel_debug_start (const gchar *mode)
diff --git a/src/camel/camel-debug.h b/src/camel/camel-debug.h
index d39725f..62163e3 100644
--- a/src/camel/camel-debug.h
+++ b/src/camel/camel-debug.h
@@ -40,8 +40,12 @@ void camel_debug_end (void);
/**
* CAMEL_CHECK_GERROR:
+ * @object: a #GObject descendant
+ * @method: a method which was run
+ * @expr: an expression to test, which evaluates to %TRUE or %FALSE
+ * @error: a pointer to a pointer of a #GError, set by the @method
*
- * This sanity checks return values and #GErrors. If returning
+ * This sanity checks return values and #GError. If returning
* failure, make sure the #GError is set. If returning success,
* make sure the #GError is NOT set.
*
@@ -79,6 +83,10 @@ void camel_debug_end (void);
/**
* CAMEL_CHECK_LOCAL_GERROR:
+ * @object: a #GObject descendant
+ * @method: a method which was run
+ * @expr: an expression to test, which evaluates to %TRUE or %FALSE
+ * @error: a pointer to a #GError, set by the @method
*
* Same as CAMEL_CHECK_GERROR, but for direct #GError pointers.
*
diff --git a/src/camel/camel-enums.h b/src/camel/camel-enums.h
index d456579..3e3bb9a 100644
--- a/src/camel/camel-enums.h
+++ b/src/camel/camel-enums.h
@@ -97,11 +97,11 @@ typedef enum { /*< flags >*/
* The folder contains memos, instead of mail messages.
* @CAMEL_FOLDER_TYPE_TASKS:
* The folder contains tasks, instead of mail messages.
- * @CAMEL_FOLDER_TYPE_ALL
+ * @CAMEL_FOLDER_TYPE_ALL:
* This folder contains all the messages. Used by RFC 6154.
- * @CAMEL_FOLDER_TYPE_ARCHIVE
+ * @CAMEL_FOLDER_TYPE_ARCHIVE:
* This folder contains archived messages. Used by RFC 6154.
- * @CAMEL_FOLDER_TYPE_DRAFTS
+ * @CAMEL_FOLDER_TYPE_DRAFTS:
* This folder contains drafts. Used by RFC 6154.
* @CAMEL_FOLDER_READONLY:
* The folder is read only.
@@ -109,6 +109,9 @@ typedef enum { /*< flags >*/
* The folder is write only.
* @CAMEL_FOLDER_FLAGGED:
* This folder contains flagged messages. Some clients call this "starred". Used by RFC 6154.
+ * @CAMEL_FOLDER_FLAGS_LAST:
+ * The last define bit of the flags. The #CamelProvider can use this and
+ * upper bits to store its own flags.
*
* These flags are abstractions. It's up to the CamelProvider to give
* them suitable interpretations. Use #CAMEL_FOLDER_TYPE_MASK to isolate
@@ -146,7 +149,7 @@ typedef enum { /*< flags >*/
CAMEL_FOLDER_WRITEONLY = 1 << 17,
CAMEL_FOLDER_FLAGGED = 1 << 18,
- CAMEL_FOLDER_FLAGS_LAST = 1 << 24 /*< skip >*/
+ CAMEL_FOLDER_FLAGS_LAST = 1 << 24
} CamelFolderInfoFlags;
#define CAMEL_FOLDER_TYPE_MASK (0x3F << CAMEL_FOLDER_TYPE_BIT)
@@ -358,6 +361,10 @@ typedef enum {
* Provider may use a real trash folder instead of a virtual folder.
* @CAMEL_PROVIDER_ALLOW_REAL_JUNK_FOLDER:
* Provider may use a real junk folder instead of a virtual folder.
+ * @CAMEL_PROVIDER_DISABLE_SENT_FOLDER:
+ * Provider requests to not use the Sent folder when sending with it.
+ * @CAMEL_PROVIDER_SUPPORTS_SSL:
+ * Provider supports SSL/TLS connections.
* @CAMEL_PROVIDER_SUPPORTS_MOBILE_DEVICES:
* Download limited set of emails instead of operating on full cache.
* @CAMEL_PROVIDER_SUPPORTS_BATCH_FETCH:
diff --git a/src/camel/camel-filter-driver.c b/src/camel/camel-filter-driver.c
index eacab5d..be2c2c2 100644
--- a/src/camel/camel-filter-driver.c
+++ b/src/camel/camel-filter-driver.c
@@ -304,7 +304,11 @@ camel_filter_driver_new (CamelSession *session)
/**
* camel_filter_driver_set_folder_func:
- * @get_folder: (scope call):
+ * @d: a #CamelFilterDriver
+ * @get_folder: (scope call) (closure user_data): a callback to get a folder
+ * @user_data: user data to pass to @get_folder
+ *
+ * Sets a callback (of type #CamelFilterGetFolderFunc) to get a folder.
**/
void
camel_filter_driver_set_folder_func (CamelFilterDriver *d,
@@ -315,6 +319,13 @@ camel_filter_driver_set_folder_func (CamelFilterDriver *d,
d->priv->data = user_data;
}
+/**
+ * camel_filter_driver_set_logfile:
+ * @d: a #CamelFilterDriver
+ * @logfile: (nullable): a FILE handle where to write logging
+ *
+* Sets a log file to use for logging.
+ **/
void
camel_filter_driver_set_logfile (CamelFilterDriver *d,
FILE *logfile)
@@ -324,7 +335,11 @@ camel_filter_driver_set_logfile (CamelFilterDriver *d,
/**
* camel_filter_driver_set_status_func:
- * @func: (scope call):
+ * @d: a #CamelFilterDriver
+ * @func: (scope call) (closure user_data): a callback to report progress
+ * @user_data: user data to pass to @func
+ *
+ * Sets a status callback, which is used to report progress/status.
**/
void
camel_filter_driver_set_status_func (CamelFilterDriver *d,
@@ -337,7 +352,12 @@ camel_filter_driver_set_status_func (CamelFilterDriver *d,
/**
* camel_filter_driver_set_shell_func:
- * @func: (scope call):
+ * @d: a #CamelFilterDriver
+ * @func: (scope call) (closure user_data): a shell command callback
+ * @user_data: user data to pass to @func
+ *
+ * Sets a shell command callback, which is called when a shell command
+ * execution is requested.
**/
void
camel_filter_driver_set_shell_func (CamelFilterDriver *d,
@@ -350,7 +370,11 @@ camel_filter_driver_set_shell_func (CamelFilterDriver *d,
/**
* camel_filter_driver_set_play_sound_func:
- * @func: (scope call):
+ * @d: a #CamelFilterDriver
+ * @func: (scope call) (closure user_data): a callback to play a sound
+ * @user_data: user data to pass to @func
+ *
+ * Sets a callback to call when a play of a sound is requested.
**/
void
camel_filter_driver_set_play_sound_func (CamelFilterDriver *d,
@@ -363,7 +387,11 @@ camel_filter_driver_set_play_sound_func (CamelFilterDriver *d,
/**
* camel_filter_driver_set_system_beep_func:
- * @func: (scope call):
+ * @d: a #CamelFilterDriver
+ * @func: (scope call) (closure user_data): a system beep callback
+ * @user_data: user data to pass to @func
+ *
+ * Sets a callback to use for system beep.
**/
void
camel_filter_driver_set_system_beep_func (CamelFilterDriver *d,
@@ -374,10 +402,21 @@ camel_filter_driver_set_system_beep_func (CamelFilterDriver *d,
d->priv->beepdata = user_data;
}
+/**
+ * camel_filter_driver_set_default_folder:
+ * @d: a #CamelFilterDriver
+ * @def: (nullable): a default #CamelFolder
+ *
+ * Sets a default folder for the driver. The function adds
+ * its own reference for the folder.
+ **/
void
camel_filter_driver_set_default_folder (CamelFilterDriver *d,
CamelFolder *def)
{
+ if (d->priv->defaultfolder == def)
+ return;
+
if (d->priv->defaultfolder) {
camel_folder_thaw (d->priv->defaultfolder);
g_object_unref (d->priv->defaultfolder);
@@ -391,6 +430,15 @@ camel_filter_driver_set_default_folder (CamelFilterDriver *d,
}
}
+/**
+ * camel_filter_driver_add_rule:
+ * @d: a #CamelFilterDriver
+ * @name: name of the rule
+ * @match: a code (#CamelSExp) to execute to check whether the rule can be applied
+ * @action: an action code (#CamelSExp) to execute, when the @match evaluates to %TRUE
+ *
+ * Adds a new rule to set of rules to process by the filter driver.
+ **/
void
camel_filter_driver_add_rule (CamelFilterDriver *d,
const gchar *name,
@@ -407,7 +455,16 @@ camel_filter_driver_add_rule (CamelFilterDriver *d,
g_queue_push_tail (&d->priv->rules, node);
}
-gint
+/**
+ * camel_filter_driver_remove_rule_by_name:
+ * @d: a #CamelFilterDriver
+ * @name: rule name
+ *
+ * Removes a rule by name, added by camel_filter_driver_add_rule().
+ *
+ * Returns: Whether the rule had been found and removed.
+ **/
+gboolean
camel_filter_driver_remove_rule_by_name (CamelFilterDriver *d,
const gchar *name)
{
@@ -427,10 +484,10 @@ camel_filter_driver_remove_rule_by_name (CamelFilterDriver *d,
g_free (rule->name);
g_free (rule);
- return 0;
+ return TRUE;
}
- return -1;
+ return FALSE;
}
static void
@@ -1320,7 +1377,7 @@ run_only_once (gpointer key,
/**
* camel_filter_driver_flush:
- * @driver:
+ * @driver: a #CamelFilterDriver
* @error: return location for a #GError, or %NULL
*
* Flush all of the only-once filter actions.
@@ -1368,7 +1425,7 @@ decode_flags_from_xev (const gchar *xev,
* camel_filter_driver_filter_mbox:
* @driver: CamelFilterDriver
* @mbox: mbox filename to be filtered
- * @original_source_url:
+ * @original_source_url: (nullable): URI of the @mbox, or %NULL
* @cancellable: optional #GCancellable object, or %NULL
* @error: return location for a #GError, or %NULL
*
diff --git a/src/camel/camel-filter-driver.h b/src/camel/camel-filter-driver.h
index 8425863..01d8ace 100644
--- a/src/camel/camel-filter-driver.h
+++ b/src/camel/camel-filter-driver.h
@@ -102,7 +102,7 @@ void camel_filter_driver_set_default_folder (CamelFilterDriver *d, CamelFolder
void camel_filter_driver_add_rule (CamelFilterDriver *d, const gchar *name, const gchar *match,
const gchar *action);
-gint camel_filter_driver_remove_rule_by_name (CamelFilterDriver *d, const gchar *name);
+gboolean camel_filter_driver_remove_rule_by_name (CamelFilterDriver *d, const gchar *name);
/*void camel_filter_driver_set_global(CamelFilterDriver *, const gchar *name, const gchar *value);*/
diff --git a/src/camel/camel-folder.h b/src/camel/camel-folder.h
index f68a192..0255382 100644
--- a/src/camel/camel-folder.h
+++ b/src/camel/camel-folder.h
@@ -88,6 +88,8 @@ typedef enum {
/**
* CamelFetchType:
+ * @CAMEL_FETCH_OLD_MESSAGES: fetch old messages
+ * @CAMEL_FETCH_NEW_MESSAGES: fetch new messages
*
* Since: 3.4
**/
@@ -110,6 +112,10 @@ typedef struct _CamelFolderQuotaInfo CamelFolderQuotaInfo;
/**
* CamelFolderQuotaInfo:
+ * @name: name, aka identification, of the quota type
+ * @used: how many bytes is currently in use
+ * @total: what is the maximum quota to use
+ * @next: a reference to a follwing #CamelFolderQuotaInfo
*
* Since: 2.24
**/
diff --git a/src/camel/camel-local-settings.h b/src/camel/camel-local-settings.h
index eedb42b..6775928 100644
--- a/src/camel/camel-local-settings.h
+++ b/src/camel/camel-local-settings.h
@@ -58,11 +58,13 @@ typedef struct _CamelLocalSettingsClass CamelLocalSettingsClass;
typedef struct _CamelLocalSettingsPrivate CamelLocalSettingsPrivate;
struct _CamelLocalSettings {
+ /*< private >*/
CamelStoreSettings parent;
CamelLocalSettingsPrivate *priv;
};
struct _CamelLocalSettingsClass {
+ /*< private >*/
CamelStoreSettingsClass parent_class;
/* Padding for future expansion */
diff --git a/src/camel/camel-mime-filter-progress.h b/src/camel/camel-mime-filter-progress.h
index e76f5b8..cf305eb 100644
--- a/src/camel/camel-mime-filter-progress.h
+++ b/src/camel/camel-mime-filter-progress.h
@@ -59,6 +59,7 @@ typedef struct _CamelMimeFilterProgressPrivate CamelMimeFilterProgressPrivate;
* Since: 2.24
**/
struct _CamelMimeFilterProgress {
+ /*< private >*/
CamelMimeFilter parent;
CamelMimeFilterProgressPrivate *priv;
};
diff --git a/src/camel/camel-mime-parser.c b/src/camel/camel-mime-parser.c
index cfbb4c5..b5f9eed 100644
--- a/src/camel/camel-mime-parser.c
+++ b/src/camel/camel-mime-parser.c
@@ -231,7 +231,7 @@ camel_mime_parser_init (CamelMimeParser *parser)
*
* Create a new CamelMimeParser object.
*
- * Returns: A new CamelMimeParser widget.
+ * Returns: (transfer full): A new CamelMimeParser widget.
**/
CamelMimeParser *
camel_mime_parser_new (void)
@@ -241,8 +241,8 @@ camel_mime_parser_new (void)
/**
* camel_mime_parser_filter_add:
- * @m:
- * @mf:
+ * @m: a #CamelMimeParser
+ * @mf: a #CamelMimeFilter
*
* Add a filter that will be applied to any body content before it is passed
* to the caller. Filters may be pipelined to perform multi-pass operations
@@ -282,8 +282,8 @@ camel_mime_parser_filter_add (CamelMimeParser *m,
/**
* camel_mime_parser_filter_remove:
- * @m:
- * @id:
+ * @m: a #CamelMimeParser
+ * @id: id of the filter to remove, as returned from camel_mime_parser_filter_add()
*
* Remove a processing filter from the pipeline. There is no
* restriction on the order the filters can be removed.
@@ -313,7 +313,7 @@ camel_mime_parser_filter_remove (CamelMimeParser *m,
/**
* camel_mime_parser_header:
- * @m:
+ * @m: a #CamelMimeParser
* @name: Name of header.
* @offset: Pointer that can receive the offset of the header in
* the stream from the start of parsing.
@@ -337,8 +337,8 @@ camel_mime_parser_header (CamelMimeParser *m,
}
/**
- * camel_mime_parser_headers_raw:
- * @m:
+ * camel_mime_parser_dup_headers:
+ * @m: a #CamelMimeParser
*
* Get the list of the raw headers which are defined for the
* current state of the parser. These headers are valid
@@ -381,7 +381,7 @@ byte_array_to_string (GByteArray *array)
/**
* camel_mime_parser_preface:
- * @m:
+ * @m: a #CamelMimeParser
*
* Retrieve the preface text for the current multipart.
* Can only be used when the state is CAMEL_MIME_PARSER_STATE_MULTIPART_END.
@@ -403,7 +403,7 @@ camel_mime_parser_preface (CamelMimeParser *m)
/**
* camel_mime_parser_postface:
- * @m:
+ * @m: a #CamelMimeParser
*
* Retrieve the postface text for the current multipart.
* Only returns valid data when the current state if
@@ -426,7 +426,7 @@ camel_mime_parser_postface (CamelMimeParser *m)
/**
* camel_mime_parser_from_line:
- * @m:
+ * @m: a #CamelMimeParser
*
* Get the last scanned "From " line, from a recently scanned from.
* This should only be called in the CAMEL_MIME_PARSER_STATE_FROM state. The
@@ -452,7 +452,7 @@ camel_mime_parser_from_line (CamelMimeParser *m)
/**
* camel_mime_parser_init_with_fd:
- * @m:
+ * @m: a #CamelMimeParser
* @fd: A valid file descriptor.
*
* Initialise the scanner with an fd. The scanner's offsets
@@ -473,8 +473,8 @@ camel_mime_parser_init_with_fd (CamelMimeParser *m,
/**
* camel_mime_parser_init_with_stream:
- * @m:
- * @stream:
+ * @m: a #CamelMimeParser
+ * @stream: a #CamelStream to init with
* @error: return location for a #GError, or %NULL
*
* Initialise the scanner with a source stream. The scanner's
diff --git a/src/camel/camel-msgport.h b/src/camel/camel-msgport.h
index 6e74031..1d10055 100644
--- a/src/camel/camel-msgport.h
+++ b/src/camel/camel-msgport.h
@@ -38,11 +38,14 @@ typedef struct _CamelMsgPort CamelMsgPort;
/**
* CamelMsg:
+ * @reply_port: a #CamelMsgPort this #CamelMsg belongs to
*
* Since: 2.24
**/
struct _CamelMsg {
CamelMsgPort *reply_port;
+
+ /*< private >*/
gint flags;
};
diff --git a/src/camel/camel-offline-settings.h b/src/camel/camel-offline-settings.h
index c0a562e..63452a0 100644
--- a/src/camel/camel-offline-settings.h
+++ b/src/camel/camel-offline-settings.h
@@ -58,6 +58,7 @@ typedef struct _CamelOfflineSettingsClass CamelOfflineSettingsClass;
typedef struct _CamelOfflineSettingsPrivate CamelOfflineSettingsPrivate;
struct _CamelOfflineSettings {
+ /*< private >*/
CamelStoreSettings parent;
CamelOfflineSettingsPrivate *priv;
};
diff --git a/src/camel/camel-provider.h b/src/camel/camel-provider.h
index 1a1d642..216759d 100644
--- a/src/camel/camel-provider.h
+++ b/src/camel/camel-provider.h
@@ -115,6 +115,9 @@ typedef struct {
/**
* CamelProviderPortEntry:
+ * @port: port number
+ * @desc: human description of the port
+ * @is_ssl: a boolean whether the port is used together with TLS/SSL
*
* Since: 3.2
**/
diff --git a/src/camel/camel-settings.h b/src/camel/camel-settings.h
index c8dcd89..1612b16 100644
--- a/src/camel/camel-settings.h
+++ b/src/camel/camel-settings.h
@@ -59,6 +59,7 @@ typedef struct _CamelSettingsClass CamelSettingsClass;
typedef struct _CamelSettingsPrivate CamelSettingsPrivate;
struct _CamelSettings {
+ /*< private >*/
GObject parent;
CamelSettingsPrivate *priv;
};
diff --git a/src/camel/camel-sexp.h b/src/camel/camel-sexp.h
index f300568..d825860 100644
--- a/src/camel/camel-sexp.h
+++ b/src/camel/camel-sexp.h
@@ -59,6 +59,14 @@ typedef struct _CamelSExpTerm CamelSExpTerm;
/**
* CamelSExpResultType:
+ * @CAMEL_SEXP_RES_ARRAY_PTR: type is a ptrarray, what it points to is implementation dependant
+ * @CAMEL_SEXP_RES_INT: type is a number
+ * @CAMEL_SEXP_RES_STRING: type is a pointer to a single string
+ * @CAMEL_SEXP_RES_BOOL: boolean type
+ * @CAMEL_SEXP_RES_TIME: time_t type
+ * @CAMEL_SEXP_RES_UNDEFINED: unknown type
+ *
+ * Defines type of a #CamelSExpResult.
*
* Since: 3.4
**/
@@ -73,6 +81,11 @@ typedef enum {
/**
* CamelSExpResult:
+ * @type: a #CamelSExpResultType, defining the @value type
+ * @value: a union with the actual value
+ * @time_generator: a boolean whether the occuring times are used
+ * @occuring_start: start time
+ * @occuring_end: end time
*
* Since: 3.4
**/
@@ -115,6 +128,15 @@ typedef CamelSExpResult *
/**
* CamelSExpTermType:
+ * @CAMEL_SEXP_TERM_INT: integer literal
+ * @CAMEL_SEXP_TERM_BOOL: boolean literal
+ * @CAMEL_SEXP_TERM_STRING: string literal
+ * @CAMEL_SEXP_TERM_TIME: time_t literal (number of seconds past the epoch)
+ * @CAMEL_SEXP_TERM_FUNC: normal function, arguments are evaluated before calling
+ * @CAMEL_SEXP_TERM_IFUNC: immediate function, raw terms are arguments
+ * @CAMEL_SEXP_TERM_VAR: variable reference
+ *
+ * Defines type of a #CamelSExpTerm and partly also #CamelSExpSymbol
*
* Since: 3.4
**/
@@ -130,6 +152,12 @@ typedef enum {
/**
* CamelSExpSymbol:
+ * @type: a type of the symbol, either CAMEL_SEXP_TERM_FUNC or CAMEL_SEXP_TERM_VAR
+ * @name: name of the symbol
+ * @data: user data for the callback
+ * @f: a #CamelSExpFunc or a #CamelSExpIFunc callback
+ *
+ * Describes a function or a variable symbol
*
* Since: 3.4
**/
@@ -145,6 +173,8 @@ struct _CamelSExpSymbol {
/**
* CamelSExpTerm:
+ * @type: a type of the term; one of #CamelSExpTermType
+ * @value: value of the term
*
* Since: 3.4
**/
@@ -170,6 +200,7 @@ struct _CamelSExpTerm {
* Since: 3.4
**/
struct _CamelSExp {
+ /*< private >*/
GObject parent;
CamelSExpPrivate *priv;
};
diff --git a/src/camel/camel-store-settings.h b/src/camel/camel-store-settings.h
index be1b32a..010fa86 100644
--- a/src/camel/camel-store-settings.h
+++ b/src/camel/camel-store-settings.h
@@ -58,6 +58,7 @@ typedef struct _CamelStoreSettingsClass CamelStoreSettingsClass;
typedef struct _CamelStoreSettingsPrivate CamelStoreSettingsPrivate;
struct _CamelStoreSettings {
+ /*< private >*/
CamelSettings parent;
CamelStoreSettingsPrivate *priv;
};
diff --git a/src/camel/camel-vee-data-cache.h b/src/camel/camel-vee-data-cache.h
index 4220500..095db37 100644
--- a/src/camel/camel-vee-data-cache.h
+++ b/src/camel/camel-vee-data-cache.h
@@ -97,16 +97,24 @@ typedef struct _CamelVeeDataCachePrivate CamelVeeDataCachePrivate;
/**
* CamelForeachInfoData:
+ * @mi_data: a #CamelVeeMessageInfoData
+ * @subfolder: a #CameFolder which @mi_data references
+ * @user_data: custom user data
*
+ * A callback prototype for camel_vee_data_cache_foreach_message_info_data()
**/
typedef void (*CamelForeachInfoData) (CamelVeeMessageInfoData *mi_data, CamelFolder *subfolder, gpointer
user_data);
/**
* CamelVeeSubfolderData:
*
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ *
* Since: 3.6
**/
struct _CamelVeeSubfolderData {
+ /*< private >*/
GObject parent;
CamelVeeSubfolderDataPrivate *priv;
};
@@ -132,9 +140,13 @@ const gchar * camel_vee_subfolder_data_get_folder_id
/**
* CamelVeeMessageInfoData:
*
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ *
* Since: 3.6
**/
struct _CamelVeeMessageInfoData {
+ /*< private >*/
GObject parent;
CamelVeeMessageInfoDataPrivate *priv;
};
@@ -165,9 +177,13 @@ const gchar * camel_vee_message_info_data_get_vee_message_uid
/**
* CamelVeeDataCache:
*
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ *
* Since: 3.6
**/
struct _CamelVeeDataCache {
+ /*< private >*/
GObject parent;
CamelVeeDataCachePrivate *priv;
};
diff --git a/src/camel/camel.c b/src/camel/camel.c
index 9a4564c..a9f0523 100644
--- a/src/camel/camel.c
+++ b/src/camel/camel.c
@@ -269,6 +269,11 @@ static GRecMutex camel_binding_lock;
/**
* camel_binding_bind_property:
+ * @source: (type GObject.Object): the source #GObject
+ * @source_property: the property on @source to bind
+ * @target: (type GObject.Object): the target #GObject
+ * @target_property: the property on @target to bind
+ * @flags: flags to pass to #GBinding
*
* Thread safe variant of g_object_bind_property(). See its documentation
* for more information on arguments and return value.
diff --git a/src/camel/providers/imapx/camel-imapx-list-response.h
b/src/camel/providers/imapx/camel-imapx-list-response.h
index 3fdb38d..09b1dde 100644
--- a/src/camel/providers/imapx/camel-imapx-list-response.h
+++ b/src/camel/providers/imapx/camel-imapx-list-response.h
@@ -78,6 +78,7 @@ typedef struct _CamelIMAPXListResponsePrivate CamelIMAPXListResponsePrivate;
* Since: 3.10
**/
struct _CamelIMAPXListResponse {
+ /*< private >*/
GObject parent;
CamelIMAPXListResponsePrivate *priv;
};
diff --git a/src/camel/providers/imapx/camel-imapx-logger.h b/src/camel/providers/imapx/camel-imapx-logger.h
index d697ad4..3f2fa74 100644
--- a/src/camel/providers/imapx/camel-imapx-logger.h
+++ b/src/camel/providers/imapx/camel-imapx-logger.h
@@ -54,6 +54,7 @@ typedef struct _CamelIMAPXLoggerPrivate CamelIMAPXLoggerPrivate;
* Since: 3.12
**/
struct _CamelIMAPXLogger {
+ /*< private >*/
GObject parent;
CamelIMAPXLoggerPrivate *priv;
};
diff --git a/src/camel/providers/imapx/camel-imapx-mailbox.h b/src/camel/providers/imapx/camel-imapx-mailbox.h
index 9421457..b592b06 100644
--- a/src/camel/providers/imapx/camel-imapx-mailbox.h
+++ b/src/camel/providers/imapx/camel-imapx-mailbox.h
@@ -63,6 +63,7 @@ typedef enum {
* Since: 3.12
**/
struct _CamelIMAPXMailbox {
+ /*< private >*/
GObject parent;
CamelIMAPXMailboxPrivate *priv;
};
diff --git a/src/camel/providers/imapx/camel-imapx-namespace-response.h
b/src/camel/providers/imapx/camel-imapx-namespace-response.h
index af71b8a..4444b8d 100644
--- a/src/camel/providers/imapx/camel-imapx-namespace-response.h
+++ b/src/camel/providers/imapx/camel-imapx-namespace-response.h
@@ -55,6 +55,7 @@ typedef struct _CamelIMAPXNamespaceResponsePrivate CamelIMAPXNamespaceResponsePr
* Since: 3.12
**/
struct _CamelIMAPXNamespaceResponse {
+ /*< private >*/
GObject parent;
CamelIMAPXNamespaceResponsePrivate *priv;
};
diff --git a/src/camel/providers/imapx/camel-imapx-namespace.h
b/src/camel/providers/imapx/camel-imapx-namespace.h
index 5d42cf2..7398480 100644
--- a/src/camel/providers/imapx/camel-imapx-namespace.h
+++ b/src/camel/providers/imapx/camel-imapx-namespace.h
@@ -72,6 +72,7 @@ typedef struct _CamelIMAPXNamespacePrivate CamelIMAPXNamespacePrivate;
* Since: 3.12
**/
struct _CamelIMAPXNamespace {
+ /*< private >*/
GObject parent;
CamelIMAPXNamespacePrivate *priv;
};
diff --git a/src/camel/providers/imapx/camel-imapx-search.h b/src/camel/providers/imapx/camel-imapx-search.h
index 93b8daa..98959a5 100644
--- a/src/camel/providers/imapx/camel-imapx-search.h
+++ b/src/camel/providers/imapx/camel-imapx-search.h
@@ -56,6 +56,7 @@ typedef struct _CamelIMAPXSearchPrivate CamelIMAPXSearchPrivate;
* Since: 3.8
**/
struct _CamelIMAPXSearch {
+ /*< private >*/
CamelFolderSearch parent;
CamelIMAPXSearchPrivate *priv;
};
diff --git a/src/camel/providers/imapx/camel-imapx-server.h b/src/camel/providers/imapx/camel-imapx-server.h
index c51e005..c8f7cfe 100644
--- a/src/camel/providers/imapx/camel-imapx-server.h
+++ b/src/camel/providers/imapx/camel-imapx-server.h
@@ -66,12 +66,10 @@ typedef struct _CamelIMAPXServerClass CamelIMAPXServerClass;
typedef struct _CamelIMAPXServerPrivate CamelIMAPXServerPrivate;
/* untagged response handling */
-typedef gboolean
- (*CamelIMAPXUntaggedRespHandler)
- (CamelIMAPXServer *server,
- GInputStream *input_stream,
- GCancellable *cancellable,
- GError **error);
+typedef gboolean (* CamelIMAPXUntaggedRespHandler) (CamelIMAPXServer *server,
+ GInputStream *input_stream,
+ GCancellable *cancellable,
+ GError **error);
/**
* CamelIMAPXUntaggedRespHandlerDesc:
diff --git a/src/camel/providers/imapx/camel-imapx-status-response.h
b/src/camel/providers/imapx/camel-imapx-status-response.h
index 47ce8cd..51e3f3c 100644
--- a/src/camel/providers/imapx/camel-imapx-status-response.h
+++ b/src/camel/providers/imapx/camel-imapx-status-response.h
@@ -56,6 +56,7 @@ typedef struct _CamelIMAPXStatusResponsePrivate CamelIMAPXStatusResponsePrivate;
* Since: 3.10
**/
struct _CamelIMAPXStatusResponse {
+ /*< private >*/
GObject parent;
CamelIMAPXStatusResponsePrivate *priv;
};
diff --git a/src/libebackend/e-backend.c b/src/libebackend/e-backend.c
index bbe3144..389b9b4 100644
--- a/src/libebackend/e-backend.c
+++ b/src/libebackend/e-backend.c
@@ -1058,6 +1058,8 @@ backend_credentials_required_thread (GTask *task,
* @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: optional #GCancellable object, or %NULL
+ * @callback: (closure user_data) (scope async): a #GAsyncReadyCallback to call when the request is satisfied
+ * @user_data: data to pass to the callback function
*
* Asynchronously calls the e_backend_credentials_required_sync() on the @backend,
* to inform clients that credentials are required.
@@ -1321,7 +1323,7 @@ e_backend_trust_prompt_sync (EBackend *backend,
* @backend: an #EBackend
* @parameters: an #ENamedParameters with values for the trust prompt
* @cancellable: (allow-none): optional #GCancellable object, or %NULL
- * @callback: a #GAsyncReadyCallback to call when the request is satisfied
+ * @callback: (closure user_data) (scope async): a #GAsyncReadyCallback to call when the request is satisfied
* @user_data: data to pass to the callback function
*
* Initiates a user trust prompt with given @parameters.
diff --git a/src/libebackend/e-data-factory.h b/src/libebackend/e-data-factory.h
index 4a8bd0c..630806b 100644
--- a/src/libebackend/e-data-factory.h
+++ b/src/libebackend/e-data-factory.h
@@ -59,6 +59,7 @@ typedef struct _EDataFactoryPrivate EDataFactoryPrivate;
* Since: 3.4
**/
struct _EDataFactory {
+ /*< private >*/
EDBusServer parent;
EDataFactoryPrivate *priv;
};
diff --git a/src/libebackend/e-dbus-server.h b/src/libebackend/e-dbus-server.h
index a1ae8f2..2606610 100644
--- a/src/libebackend/e-dbus-server.h
+++ b/src/libebackend/e-dbus-server.h
@@ -59,6 +59,7 @@ typedef struct _EDBusServerPrivate EDBusServerPrivate;
* Since: 3.4
**/
struct _EDBusServer {
+ /*< private >*/
GObject parent;
EDBusServerPrivate *priv;
};
diff --git a/src/libebackend/e-file-cache.h b/src/libebackend/e-file-cache.h
index 1abc086..c86952f 100644
--- a/src/libebackend/e-file-cache.h
+++ b/src/libebackend/e-file-cache.h
@@ -59,6 +59,7 @@ typedef struct _EFileCachePrivate EFileCachePrivate;
* functions below.
**/
struct _EFileCache {
+ /*< private >*/
GObject parent;
EFileCachePrivate *priv;
};
diff --git a/src/libebackend/e-oauth2-support.h b/src/libebackend/e-oauth2-support.h
index 03ec13e..aebfdce 100644
--- a/src/libebackend/e-oauth2-support.h
+++ b/src/libebackend/e-oauth2-support.h
@@ -49,12 +49,17 @@ typedef struct _EOAuth2SupportInterface EOAuth2SupportInterface;
/**
* EOAuth2SupportInterface:
+ * @get_access_token_sync: synchronous interface method to get the access token
+ * @get_access_token: asynchronous interface method to get the access token
+ * @get_access_token_finish: counterpart of the asynchronous interface method to finishd get of the access
token
*
* Since: 3.8
**/
struct _EOAuth2SupportInterface {
+ /*< private >*/
GTypeInterface parent_interface;
+ /*< public >*/
/* Synchronous I/O Methods */
gboolean (*get_access_token_sync)
(EOAuth2Support *support,
diff --git a/src/libebackend/e-offline-listener.h b/src/libebackend/e-offline-listener.h
index 43617ac..c4e722c 100644
--- a/src/libebackend/e-offline-listener.h
+++ b/src/libebackend/e-offline-listener.h
@@ -79,6 +79,7 @@ typedef enum {
* Since: 2.30
**/
struct _EOfflineListener {
+ /*< private >*/
GObject parent;
EOfflineListenerPrivate *priv;
};
diff --git a/src/libebackend/e-server-side-source-credentials-provider.h
b/src/libebackend/e-server-side-source-credentials-provider.h
index 24dd08c..b354131 100644
--- a/src/libebackend/e-server-side-source-credentials-provider.h
+++ b/src/libebackend/e-server-side-source-credentials-provider.h
@@ -63,6 +63,7 @@ typedef struct _EServerSideSourceCredentialsProviderPrivate EServerSideSourceCre
* Since: 3.16
**/
struct _EServerSideSourceCredentialsProvider {
+ /*< private >*/
ESourceCredentialsProvider parent;
EServerSideSourceCredentialsProviderPrivate *priv;
};
diff --git a/src/libebackend/e-server-side-source.h b/src/libebackend/e-server-side-source.h
index c5fca9d..d44ed59 100644
--- a/src/libebackend/e-server-side-source.h
+++ b/src/libebackend/e-server-side-source.h
@@ -59,6 +59,7 @@ typedef struct _EServerSideSourcePrivate EServerSideSourcePrivate;
* Since: 3.6
**/
struct _EServerSideSource {
+ /*< private >*/
ESource parent;
EServerSideSourcePrivate *priv;
};
diff --git a/src/libebackend/e-source-registry-server.h b/src/libebackend/e-source-registry-server.h
index d86b100..e1dd0a9 100644
--- a/src/libebackend/e-source-registry-server.h
+++ b/src/libebackend/e-source-registry-server.h
@@ -81,6 +81,7 @@ typedef struct _ESourceRegistryServerPrivate ESourceRegistryServerPrivate;
* Since: 3.6
**/
struct _ESourceRegistryServer {
+ /*< private >*/
EDataFactory parent;
ESourceRegistryServerPrivate *priv;
};
diff --git a/src/libebackend/e-subprocess-factory.h b/src/libebackend/e-subprocess-factory.h
index ebcb061..2298b7c 100644
--- a/src/libebackend/e-subprocess-factory.h
+++ b/src/libebackend/e-subprocess-factory.h
@@ -58,6 +58,7 @@ typedef struct _ESubprocessFactoryPrivate ESubprocessFactoryPrivate;
* Since: 3.16
**/
struct _ESubprocessFactory {
+ /*< private >*/
GObject parent;
ESubprocessFactoryPrivate *priv;
};
@@ -89,8 +90,8 @@ GType e_subprocess_factory_get_type
EBackend * e_subprocess_factory_ref_initable_backend
(ESubprocessFactory *subprocess_factory,
const gchar *uid,
- const gchar *type_name,
- const gchar *module_file_name,
+ const gchar *backend_factory_type_name,
+ const gchar *module_filename,
GCancellable *cancellable,
GError **error);
ESourceRegistry *
@@ -100,8 +101,8 @@ gchar * e_subprocess_factory_open_backend
(ESubprocessFactory *subprocess_factory,
GDBusConnection *connection,
const gchar *uid,
- const gchar *type_name,
- const gchar *module_file_name,
+ const gchar *backend_factory_type_name,
+ const gchar *module_filename,
GDBusInterfaceSkeleton *proxy,
GCancellable *cancellable,
GError **error);
diff --git a/src/libebackend/e-user-prompter-server-extension.h
b/src/libebackend/e-user-prompter-server-extension.h
index 5951dbc..e60d34e 100644
--- a/src/libebackend/e-user-prompter-server-extension.h
+++ b/src/libebackend/e-user-prompter-server-extension.h
@@ -57,6 +57,7 @@ struct _EUserPrompterServer;
* Since: 3.8
**/
struct _EUserPrompterServerExtension {
+ /*< private >*/
EExtension parent;
EUserPrompterServerExtensionPrivate *priv;
};
diff --git a/src/libebackend/e-user-prompter-server.h b/src/libebackend/e-user-prompter-server.h
index ab7f37e..9088e8c 100644
--- a/src/libebackend/e-user-prompter-server.h
+++ b/src/libebackend/e-user-prompter-server.h
@@ -65,6 +65,7 @@ typedef struct _EUserPrompterServerPrivate EUserPrompterServerPrivate;
* Since: 3.8
**/
struct _EUserPrompterServer {
+ /*< private >*/
EDBusServer parent;
EUserPrompterServerPrivate *priv;
};
diff --git a/src/libebackend/e-user-prompter.h b/src/libebackend/e-user-prompter.h
index 4826f6f..43d5627 100644
--- a/src/libebackend/e-user-prompter.h
+++ b/src/libebackend/e-user-prompter.h
@@ -54,9 +54,13 @@ typedef struct _EUserPrompterPrivate EUserPrompterPrivate;
/**
* EUserPrompter:
*
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ *
* Since: 3.8
**/
struct _EUserPrompter {
+ /*< private >*/
GObject parent;
EUserPrompterPrivate *priv;
};
diff --git a/src/libedataserver/e-client.c b/src/libedataserver/e-client.c
index 2978aad..6fdfef6 100644
--- a/src/libedataserver/e-client.c
+++ b/src/libedataserver/e-client.c
@@ -2110,7 +2110,8 @@ e_client_retrieve_properties (EClient *client,
/**
* e_client_retrieve_properties_finish:
* @client: an #EClient
- * If an error occurs, the function sets @error and returns %FALSE.
+ * @result: a #GAsyncResult
+ * @error: return location for a #GError, or %NULL
*
* Finishes the operation started with e_client_retrieve_properties().
*
diff --git a/src/libedataserver/e-client.h b/src/libedataserver/e-client.h
index 4267e47..33fe2eb 100644
--- a/src/libedataserver/e-client.h
+++ b/src/libedataserver/e-client.h
@@ -482,6 +482,7 @@ typedef struct _EClientErrorsList EClientErrorsList;
* Deprecated: 3.8: This structure is no longer used.
**/
struct _EClientErrorsList {
+ /*< private >*/
const gchar *name;
gint err_code;
};
diff --git a/src/libedataserver/e-credentials.c b/src/libedataserver/e-credentials.c
index 3237257..1c9df73 100644
--- a/src/libedataserver/e-credentials.c
+++ b/src/libedataserver/e-credentials.c
@@ -48,7 +48,7 @@ key_equal (gconstpointer str1,
/**
* e_credentials_new:
*
- * FIXME: Document me.
+ * Returns: (transfer full): a new empty #ECredentials. Free with e_credentials_free() when done with it.
*
* Since: 3.2
**/
@@ -67,27 +67,28 @@ e_credentials_new (void)
/**
* e_credentials_new_strv:
+ * @strv: an array of key/value-s to prefill
*
- * FIXME: Document me.
+ * Creates a new #ECredentials with prefilled key/value-s from @strv. It expects
+ * the @strv as a NULL-terminated list of strings "key:encoded_value".
+ * The same can be returned from e_credentials_to_strv ().
+ *
+ * Returns: (transfer full): a new #ECredentials. Free with e_credentials_free() when done with it.
*
* Since: 3.2
**/
ECredentials *
-e_credentials_new_strv (const gchar * const *keys)
+e_credentials_new_strv (const gchar * const *strv)
{
ECredentials *credentials;
gint ii;
- /* Expects @keys as NULL terminated list of strings
- * "key:encoded_value". The same can be returned from
- * e_credentials_to_strv (). */
-
- g_return_val_if_fail (keys != NULL, NULL);
+ g_return_val_if_fail (strv != NULL, NULL);
credentials = e_credentials_new ();
- for (ii = 0; keys[ii]; ii++) {
- const gchar *key = keys[ii], *sep;
+ for (ii = 0; strv[ii]; ii++) {
+ const gchar *key = strv[ii], *sep;
sep = strchr (key, ':');
@@ -101,8 +102,13 @@ e_credentials_new_strv (const gchar * const *keys)
/**
* e_credentials_new_args:
+ * @key: the first key name
+ * @...: value, followed by key,value pairs, terminated with %NULL
+ *
+ * Creates a new #ECredentials with prefilled keys. The arguments is
+ * a NULL-terminated list of string pairs <key, value>; value is in a clear form.
*
- * FIXME: Document me.
+ * Returns: (transfer full): a new #ECredentials. Free with e_credentials_free() when done with it.
*
* Since: 3.2
**/
@@ -146,8 +152,10 @@ copy_keys_cb (gpointer key,
/**
* e_credentials_new_clone:
+ * @credentials: an #ECredentials
*
- * FIXME: Document me.
+ * Returns: (transfer full): Creates a clone (copy) of the given @credentials.
+ * Free with e_credentials_free() when done with it.
*
* Since: 3.2
**/
@@ -169,8 +177,10 @@ e_credentials_new_clone (const ECredentials *credentials)
/**
* e_credentials_free:
+ * @credentials: an #ECredentials
*
- * FIXME: Document me.
+ * Frees the @credentials. Any peek-ed values are invalidated
+ * by this call.
*
* Since: 3.2
**/
@@ -206,12 +216,12 @@ add_to_array_cb (gpointer key,
* e_credentials_to_strv:
* @credentials: an #ECredentials
*
- * Returns %NULL-terminated array of strings with keys and encoded values;
+ * Returns NULL-terminated array of strings with keys and encoded values;
* To read them back pass this pointer to e_credentials_new(). As it returns
* newly allocated string then this should be freed with g_strfreev() when no
* longer needed.
*
- * Returns: (transfer full): a %NULL-terminated array of key/value strings
+ * Returns: (transfer full): a NULL-terminated array of key/value strings
*
* Since: 3.2
**/
@@ -323,8 +333,12 @@ e_credentials_set (ECredentials *credentials,
/**
* e_credentials_get:
+ * @credentials: an #ECredentials
+ * @key: a key name
*
- * FIXME: Document me.
+ * Returns: (transfer full) (nullable): A copy of the key's value, or %NULL,
+ * if no such key is stored in the @credentuals. Free returned string with
+ * e_credentials_util_safe_free_string(), when done with it.
*
* Since: 3.2
**/
@@ -454,6 +468,8 @@ e_credentials_equal (const ECredentials *credentials1,
* e_credentials_equal_keys:
* @credentials1: an #ECredentials
* @credentials2: another #ECredentials
+ * @key1: the first key name
+ * @...: other key names, terminated with %NULL
*
* Returns whether two #ECredentials structures have the same keys. Key names
* are NULL-terminated.
@@ -580,8 +596,9 @@ e_credentials_list_keys (const ECredentials *credentials)
/**
* e_credentials_clear:
+ * @credentials: an #ECredentials
*
- * FIXME: Document me.
+ * Clears all the stored keys (and their peek-ed values).
*
* Since: 3.2
**/
@@ -599,8 +616,9 @@ e_credentials_clear (ECredentials *credentials)
/**
* e_credentials_clear_peek:
+ * @credentials: an #ECredentials
*
- * FIXME: Document me.
+ * Clears cache of peek-ed values.
*
* Since: 3.2
**/
@@ -616,8 +634,11 @@ e_credentials_clear_peek (ECredentials *credentials)
/**
* e_credentials_util_safe_free_string:
+ * @str: (nullable): a string to safely free
*
- * FIXME Document me.
+ * Frees a nul-terminated string safely, which means it
+ * overwrites the content first and only then calls g_free()
+ * on it. If @str is %NULL, then does nothing.
*
* Since: 3.2
**/
@@ -651,8 +672,13 @@ static struct _PromptFlags {
/**
* e_credentials_util_prompt_flags_to_string:
+ * @prompt_flags: bit-or of #ECredentialsPromptFlags
*
- * FIXME: Document me.
+ * Converts bit-or of # to a string representation. Use
+ * e_credentials_util_string_to_prompt_flags() to convert
+ * the string back to the numeric representation.
+ *
+ * Returns: (transfer full): text representation of the @prompt_flags
*
* Since: 3.2
**/
@@ -691,8 +717,13 @@ e_credentials_util_prompt_flags_to_string (guint prompt_flags)
/**
* e_credentials_util_string_to_prompt_flags:
+ * @prompt_flags_string: flags encoded as string
+ *
+ * Converts #ECredentialsPromptFlags represented as string back to
+ * the numeric representation. This is a reverse function of
+ * e_credentials_util_prompt_flags_to_string().
*
- * FIXME: Document me.
+ * Returns: decoded bit-or of #ECredentialsPromptFlags
*
* Since: 3.2
**/
diff --git a/src/libedataserver/e-credentials.h b/src/libedataserver/e-credentials.h
index 88702e0..7ead943 100644
--- a/src/libedataserver/e-credentials.h
+++ b/src/libedataserver/e-credentials.h
@@ -45,6 +45,7 @@ typedef struct _ECredentialsPrivate ECredentialsPrivate;
* Since: 3.2
**/
struct _ECredentials {
+ /*< private >*/
ECredentialsPrivate *priv;
};
@@ -132,8 +133,17 @@ struct _ECredentials {
/**
* ECredentialsPromptFlags:
- *
- * FIXME Document me.
+ * @E_CREDENTIALS_PROMPT_FLAG_REMEMBER_NEVER: never remember the credentials
+ * @E_CREDENTIALS_PROMPT_FLAG_REMEMBER_SESSION: remember the credentials only for the current session
+ * @E_CREDENTIALS_PROMPT_FLAG_REMEMBER_FOREVER: remember the credentials forever
+ * @E_CREDENTIALS_PROMPT_FLAG_REMEMBER_MASK: a bit-mask of the 'remember' flags
+ * @E_CREDENTIALS_PROMPT_FLAG_SECRET: whether hide password letters in the UI
+ * @E_CREDENTIALS_PROMPT_FLAG_REPROMPT: whether this is a re-prompt
+ * @E_CREDENTIALS_PROMPT_FLAG_ONLINE: only ask if we're online
+ * @E_CREDENTIALS_PROMPT_FLAG_DISABLE_REMEMBER: disable the 'remember password' checkbox
+ * @E_CREDENTIALS_PROMPT_FLAG_PASSPHRASE: we are asking a passphrase
+ *
+ * Flags for a credentials prompt.
*
* Since: 3.2
**/
diff --git a/src/libedataserver/e-data-server-util.c b/src/libedataserver/e-data-server-util.c
index 94aed30..b68c0d1 100644
--- a/src/libedataserver/e-data-server-util.c
+++ b/src/libedataserver/e-data-server-util.c
@@ -1363,6 +1363,11 @@ e_file_recursive_delete_finish (GFile *file,
/**
* e_binding_bind_property:
+ * @source: (type GObject.Object): the source #GObject
+ * @source_property: the property on @source to bind
+ * @target: (type GObject.Object): the target #GObject
+ * @target_property: the property on @target to bind
+ * @flags: flags to pass to #GBinding
*
* Thread safe variant of g_object_bind_property(). See its documentation
* for more information on arguments and return value.
diff --git a/src/libedataserver/e-debug-log.c b/src/libedataserver/e-debug-log.c
index 4a31397..909b1d3 100644
--- a/src/libedataserver/e-debug-log.c
+++ b/src/libedataserver/e-debug-log.c
@@ -58,6 +58,13 @@ unlock (void)
/**
* e_debug_log:
+ * @is_milestone: the debug information is a milestone
+ * @domain: for which domain the debug information belongs
+ * @format: print format
+ * @...: arguments for the format
+ *
+ * Records debug information for the given @domain, if enabled, or always,
+ * when @is_milestone is set to TRUE.
*
* Since: 2.32
**/
@@ -145,6 +152,13 @@ add_to_milestones (const gchar *str)
/**
* e_debug_logv:
+ * @is_milestone: the debug information is a milestone
+ * @domain: for which domain the debug information belongs
+ * @format: print format
+ * @args: arguments for the format
+ *
+ * Records debug information for the given @domain, if enabled, or always,
+ * when @is_milestone is set to TRUE.
*
* Since: 2.32
**/
@@ -192,6 +206,12 @@ e_debug_logv (gboolean is_milestone,
/**
* e_debug_log_load_configuration:
+ * @filename: a configuration file name
+ * @error: return location for a #GError, or %NULL
+ *
+ * Loads configuration for the logging from the given @filename.
+ *
+ * Returns: whether succeeded
*
* Since: 2.32
**/
@@ -252,6 +272,10 @@ e_debug_log_load_configuration (const gchar *filename,
/**
* e_debug_log_enable_domains:
+ * @domains: (array length=n_domains): an array of domains to enable
+ * @n_domains: legth of the @domains array
+ *
+ * Enables all domains from the @domains array.
*
* Since: 2.32
**/
@@ -288,6 +312,10 @@ e_debug_log_enable_domains (const gchar **domains,
/**
* e_debug_log_disable_domains:
+ * @domains: (array length=n_domains): an array of domains to disable
+ * @n_domains: legth of the @domains array
+ *
+ * Disables all domains from the @domains array.
*
* Since: 2.32
**/
@@ -324,6 +352,10 @@ e_debug_log_disable_domains (const gchar **domains,
/**
* e_debug_log_is_domain_enabled:
+ * @domain: a log domain
+ *
+ * Returns: whether the given log domain is enabled, which means
+ * that any logging to this domain is recorded.
*
* Since: 2.32
**/
@@ -522,6 +554,12 @@ dump_ring_buffer (const gchar *filename,
/**
* e_debug_log_dump:
+ * @filename: a filename to save logged information to
+ * @error: return location for a #GError, or %NULL
+ *
+ * Saves current log information to the given @filename.
+ *
+ * Returns: whether succeeded
*
* Since: 2.32
**/
@@ -587,6 +625,12 @@ e_debug_log_dump (const gchar *filename,
/**
* e_debug_log_dump_to_dated_file:
+ * @error: return location for a #GError, or %NULL
+ *
+ * Saves current log information to a file "e-debug-log-YYYY-MM-DD-HH-mm-ss.txt"
+ * in the user's HOME directory.
+ *
+ * Returns: whether succeeded
*
* Since: 2.32
**/
@@ -624,6 +668,9 @@ e_debug_log_dump_to_dated_file (GError **error)
/**
* e_debug_log_set_max_lines:
+ * @num_lines: number of lines
+ *
+ * Limits how many lines the log can have.
*
* Since: 2.32
**/
diff --git a/src/libedataserver/e-extension.h b/src/libedataserver/e-extension.h
index d75900b..07b0533 100644
--- a/src/libedataserver/e-extension.h
+++ b/src/libedataserver/e-extension.h
@@ -58,6 +58,7 @@ typedef struct _EExtensionPrivate EExtensionPrivate;
* Since: 3.4
**/
struct _EExtension {
+ /*< private >*/
GObject parent;
EExtensionPrivate *priv;
};
diff --git a/src/libedataserver/e-gdbus-templates.c b/src/libedataserver/e-gdbus-templates.c
index 530bc7f..5441fa0 100644
--- a/src/libedataserver/e-gdbus-templates.c
+++ b/src/libedataserver/e-gdbus-templates.c
@@ -1832,6 +1832,8 @@ e_gdbus_proxy_call_sync_string__string (GDBusProxy *proxy,
/**
* e_gdbus_proxy_call_sync_string__strv:
* @proxy:
+ * @in_string:
+ * @out_strv: (out):
* @cancellable: (allow-none):
* @error:
* @start_func: (scope call):
diff --git a/src/libedataserver/e-iterator.c b/src/libedataserver/e-iterator.c
index 7f3633e..00948fe 100644
--- a/src/libedataserver/e-iterator.c
+++ b/src/libedataserver/e-iterator.c
@@ -46,9 +46,6 @@ e_iterator_class_init (EIteratorClass *class)
G_TYPE_NONE, 0);
}
-/**
- * e_iterator_init:
- */
static void
e_iterator_init (EIterator *card)
{
@@ -61,9 +58,10 @@ e_iterator_init (EIterator *card)
/**
* e_iterator_get:
+ * @iterator: an #EIterator
*
- * Returns: (transfer none): the iterator.
- */
+ * Returns: (transfer none): the iterator value
+ **/
gconstpointer
e_iterator_get (EIterator *iterator)
{
@@ -73,6 +71,12 @@ e_iterator_get (EIterator *iterator)
return NULL;
}
+/**
+ * e_iterator_reset:
+ * @iterator: an #EIterator
+ *
+ * Resets the iterator to the beginning.
+ **/
void
e_iterator_reset (EIterator *iterator)
{
@@ -80,6 +84,12 @@ e_iterator_reset (EIterator *iterator)
E_ITERATOR_GET_CLASS (iterator)->reset (iterator);
}
+/**
+ * e_iterator_last:
+ * @iterator: an #EIterator
+ *
+ * Moves the iterator to the last item.
+ **/
void
e_iterator_last (EIterator *iterator)
{
@@ -87,6 +97,14 @@ e_iterator_last (EIterator *iterator)
E_ITERATOR_GET_CLASS (iterator)->last (iterator);
}
+/**
+ * e_iterator_next:
+ * @iterator: an #EIterator
+ *
+ * Moves the iterator to the next item.
+ *
+ * Returns: Whether succeeded
+ **/
gboolean
e_iterator_next (EIterator *iterator)
{
@@ -96,6 +114,14 @@ e_iterator_next (EIterator *iterator)
return FALSE;
}
+/**
+ * e_iterator_prev:
+ * @iterator: an #EIterator
+ *
+ * Moves the iterator to the previous item.
+ *
+ * Returns: Whether succeeded
+ **/
gboolean
e_iterator_prev (EIterator *iterator)
{
@@ -105,6 +131,12 @@ e_iterator_prev (EIterator *iterator)
return FALSE;
}
+/**
+ * e_iterator_delete:
+ * @iterator: an #EIterator
+ *
+ * Deletes the item in the current position of the iterator.
+ **/
void
e_iterator_delete (EIterator *iterator)
{
@@ -112,6 +144,14 @@ e_iterator_delete (EIterator *iterator)
E_ITERATOR_GET_CLASS (iterator)->remove (iterator);
}
+/**
+ * e_iterator_insert:
+ * @iterator: an #EIterator
+ * @object: an object to insert
+ * @before: where to insert the object
+ *
+ * Inserts the @object before or after the current position of the iterator.
+ **/
void
e_iterator_insert (EIterator *iterator,
gconstpointer object,
@@ -121,6 +161,13 @@ e_iterator_insert (EIterator *iterator,
E_ITERATOR_GET_CLASS (iterator)->insert (iterator, object, before);
}
+/**
+ * e_iterator_set:
+ * @iterator: an #EIterator
+ * @object: an object to set
+ *
+ * Sets value of the current position of the iterator to the @object.
+ **/
void
e_iterator_set (EIterator *iterator,
gconstpointer object)
@@ -129,6 +176,12 @@ e_iterator_set (EIterator *iterator,
E_ITERATOR_GET_CLASS (iterator)->set (iterator, object);
}
+/**
+ * e_iterator_is_valid:
+ * @iterator: an #EIterator
+ *
+ * Returns: whether the iterator is valid.
+ **/
gboolean
e_iterator_is_valid (EIterator *iterator)
{
@@ -141,6 +194,12 @@ e_iterator_is_valid (EIterator *iterator)
return FALSE;
}
+/**
+ * e_iterator_invalidate:
+ * @iterator: an #EIterator
+ *
+ * Invalidates the iterator.
+ **/
void
e_iterator_invalidate (EIterator *iterator)
{
diff --git a/src/libedataserver/e-iterator.h b/src/libedataserver/e-iterator.h
index a871e8c..b5452fd 100644
--- a/src/libedataserver/e-iterator.h
+++ b/src/libedataserver/e-iterator.h
@@ -64,6 +64,7 @@ typedef struct _EIteratorClass EIteratorClass;
* functions below.
**/
struct _EIterator {
+ /*< private >*/
GObject parent;
};
diff --git a/src/libedataserver/e-module.h b/src/libedataserver/e-module.h
index d4495eb..5e69dd8 100644
--- a/src/libedataserver/e-module.h
+++ b/src/libedataserver/e-module.h
@@ -59,6 +59,7 @@ typedef struct _EModulePrivate EModulePrivate;
* Since: 3.4
**/
struct _EModule {
+ /*< private >*/
GTypeModule parent;
EModulePrivate *priv;
};
diff --git a/src/libedataserver/e-network-monitor.h b/src/libedataserver/e-network-monitor.h
index 5a658f5..6cbdb53 100644
--- a/src/libedataserver/e-network-monitor.h
+++ b/src/libedataserver/e-network-monitor.h
@@ -68,6 +68,7 @@ typedef struct _ENetworkMonitorPrivate ENetworkMonitorPrivate;
* Since: 3.22
**/
struct _ENetworkMonitor {
+ /*< private >*/
GObject parent;
ENetworkMonitorPrivate *priv;
};
diff --git a/src/libedataserver/e-operation-pool.c b/src/libedataserver/e-operation-pool.c
index 8631a2e..31f13bf 100644
--- a/src/libedataserver/e-operation-pool.c
+++ b/src/libedataserver/e-operation-pool.c
@@ -33,7 +33,8 @@ struct _EOperationPool {
* @thread_func: Function to run for a given thread
* @user_data: The user data to pass to @thread_func
*
- * FIXME: Document me.
+ * Returns: (transfer full): a new #EOperationPool with the given settings.
+ * Free it with e_operation_pool_free(), when no longer needed.
*
* Since: 3.2
**/
@@ -69,8 +70,9 @@ e_operation_pool_new (guint max_threads,
/**
* e_operation_pool_free:
+ * @pool: an #EOperationPool
*
- * FIXME: Document me.
+ * Frees previously created @pool.
*
* Since: 3.2
**/
diff --git a/src/libedataserver/e-proxy.c b/src/libedataserver/e-proxy.c
index 7a1e136..a51c465 100644
--- a/src/libedataserver/e-proxy.c
+++ b/src/libedataserver/e-proxy.c
@@ -982,6 +982,8 @@ e_proxy_init (EProxy *proxy)
/**
* e_proxy_new:
*
+ * Returns: (transfer full): a new instance of an #EProxy
+ *
* Since: 2.24
**/
EProxy *
@@ -992,6 +994,9 @@ e_proxy_new (void)
/**
* e_proxy_setup_proxy:
+ * @proxy: an #EProxy
+ *
+ * Sets up internal structure members and reads the proxy settings.
*
* Since: 2.24
**/
@@ -1011,6 +1016,11 @@ e_proxy_setup_proxy (EProxy *proxy)
/**
* e_proxy_peek_uri_for:
+ * @proxy: an #EProxy
+ * @uri: a URI
+ *
+ * Returns: (transfer none): A proxy URI (as a #SoupURI) which the given @uri
+ * may use, based on its scheme
*
* Since: 2.26
**/
@@ -1042,6 +1052,10 @@ e_proxy_peek_uri_for (EProxy *proxy,
/**
* e_proxy_require_proxy_for_uri:
+ * @proxy: an #EProxy
+ * @uri: a URI
+ *
+ * Returns: Whether the @uri requires proxy to connect to it
*
* Since: 2.24
**/
diff --git a/src/libedataserver/e-proxy.h b/src/libedataserver/e-proxy.h
index 16123e8..0f950bd 100644
--- a/src/libedataserver/e-proxy.h
+++ b/src/libedataserver/e-proxy.h
@@ -65,6 +65,7 @@ typedef struct _EProxyPrivate EProxyPrivate;
* Since: 2.24
**/
struct _EProxy {
+ /*< private >*/
GObject parent;
EProxyPrivate *priv;
};
diff --git a/src/libedataserver/e-secret-store.c b/src/libedataserver/e-secret-store.c
index 0a133dc..d28107a 100644
--- a/src/libedataserver/e-secret-store.c
+++ b/src/libedataserver/e-secret-store.c
@@ -269,6 +269,7 @@ static SecretSchema password_schema = {
* e_secret_store_store_sync:
* @uid: a unique identifier of the secret
* @secret: the secret to store
+ * @label: human readable description of the secret
* @permanently: store permanently or just for the session
* @cancellable: optional #GCancellable object, or %NULL
* @error: return location for a #GError, or %NULL
diff --git a/src/libedataserver/e-sexp.c b/src/libedataserver/e-sexp.c
index 2aeaff5..9230452 100644
--- a/src/libedataserver/e-sexp.c
+++ b/src/libedataserver/e-sexp.c
@@ -1268,6 +1268,9 @@ parse_values (ESExp *sexp,
/**
* e_sexp_parse_value:
+ * @sexp: an #ESExp
+ *
+ * Returns: (nullable) (transfer none): an #ESExpTerm of the next token, or %NULL when there is none.
*
* Since: 2.28
**/
diff --git a/src/libedataserver/e-soup-auth-bearer.h b/src/libedataserver/e-soup-auth-bearer.h
index 8aaffbf..545bf02 100644
--- a/src/libedataserver/e-soup-auth-bearer.h
+++ b/src/libedataserver/e-soup-auth-bearer.h
@@ -58,6 +58,7 @@ typedef struct _ESoupAuthBearerPrivate ESoupAuthBearerPrivate;
* Since: 3.10
**/
struct _ESoupAuthBearer {
+ /*< private >*/
SoupAuth parent;
ESoupAuthBearerPrivate *priv;
};
diff --git a/src/libedataserver/e-source-address-book.h b/src/libedataserver/e-source-address-book.h
index ee5a743..8960470 100644
--- a/src/libedataserver/e-source-address-book.h
+++ b/src/libedataserver/e-source-address-book.h
@@ -68,6 +68,7 @@ typedef struct _ESourceAddressBookPrivate ESourceAddressBookPrivate;
* Since: 3.6
**/
struct _ESourceAddressBook {
+ /*< private >*/
ESourceBackend parent;
ESourceAddressBookPrivate *priv;
};
diff --git a/src/libedataserver/e-source-alarms.h b/src/libedataserver/e-source-alarms.h
index 15c3b6f..4e6c925 100644
--- a/src/libedataserver/e-source-alarms.h
+++ b/src/libedataserver/e-source-alarms.h
@@ -68,6 +68,7 @@ typedef struct _ESourceAlarmsPrivate ESourceAlarmsPrivate;
* Since: 3.6
**/
struct _ESourceAlarms {
+ /*< private >*/
ESourceExtension parent;
ESourceAlarmsPrivate *priv;
};
diff --git a/src/libedataserver/e-source-authentication.h b/src/libedataserver/e-source-authentication.h
index 267f1b0..ee29798 100644
--- a/src/libedataserver/e-source-authentication.h
+++ b/src/libedataserver/e-source-authentication.h
@@ -68,6 +68,7 @@ typedef struct _ESourceAuthenticationPrivate ESourceAuthenticationPrivate;
* Since: 3.6
**/
struct _ESourceAuthentication {
+ /*< private >*/
ESourceExtension parent;
ESourceAuthenticationPrivate *priv;
};
diff --git a/src/libedataserver/e-source-autocomplete.h b/src/libedataserver/e-source-autocomplete.h
index 01c7449..c0e7da9 100644
--- a/src/libedataserver/e-source-autocomplete.h
+++ b/src/libedataserver/e-source-autocomplete.h
@@ -68,6 +68,7 @@ typedef struct _ESourceAutocompletePrivate ESourceAutocompletePrivate;
* Since: 3.6
**/
struct _ESourceAutocomplete {
+ /*< private >*/
ESourceExtension parent;
ESourceAutocompletePrivate *priv;
};
diff --git a/src/libedataserver/e-source-backend.h b/src/libedataserver/e-source-backend.h
index 58e356f..6e3f7e2 100644
--- a/src/libedataserver/e-source-backend.h
+++ b/src/libedataserver/e-source-backend.h
@@ -58,6 +58,7 @@ typedef struct _ESourceBackendPrivate ESourceBackendPrivate;
* Since: 3.6
**/
struct _ESourceBackend {
+ /*< private >*/
ESourceExtension parent;
ESourceBackendPrivate *priv;
};
diff --git a/src/libedataserver/e-source-calendar.h b/src/libedataserver/e-source-calendar.h
index 7fe9005..f2bf395 100644
--- a/src/libedataserver/e-source-calendar.h
+++ b/src/libedataserver/e-source-calendar.h
@@ -137,6 +137,7 @@ typedef struct _ESourceTaskListPrivate ESourceTaskListPrivate;
* Since: 3.6
**/
struct _ESourceCalendar {
+ /*< private >*/
ESourceSelectable parent;
ESourceCalendarPrivate *priv;
};
@@ -154,6 +155,7 @@ struct _ESourceCalendarClass {
* Since: 3.6
**/
struct _ESourceMemoList {
+ /*< private >*/
ESourceSelectable parent;
ESourceMemoListPrivate *priv;
};
@@ -171,6 +173,7 @@ struct _ESourceMemoListClass {
* Since: 3.6
**/
struct _ESourceTaskList {
+ /*< private >*/
ESourceSelectable parent;
ESourceTaskListPrivate *priv;
};
diff --git a/src/libedataserver/e-source-camel.h b/src/libedataserver/e-source-camel.h
index 66bc26b..73c8783 100644
--- a/src/libedataserver/e-source-camel.h
+++ b/src/libedataserver/e-source-camel.h
@@ -59,6 +59,7 @@ typedef struct _ESourceCamelPrivate ESourceCamelPrivate;
* Since: 3.6
**/
struct _ESourceCamel {
+ /*< private >*/
ESourceExtension parent;
ESourceCamelPrivate *priv;
};
diff --git a/src/libedataserver/e-source-collection.h b/src/libedataserver/e-source-collection.h
index f6c7ce6..ca7c331 100644
--- a/src/libedataserver/e-source-collection.h
+++ b/src/libedataserver/e-source-collection.h
@@ -68,6 +68,7 @@ typedef struct _ESourceCollectionPrivate ESourceCollectionPrivate;
* Since: 3.6
**/
struct _ESourceCollection {
+ /*< private >*/
ESourceBackend parent;
ESourceCollectionPrivate *priv;
};
diff --git a/src/libedataserver/e-source-contacts.h b/src/libedataserver/e-source-contacts.h
index ce5e849..a5245ca 100644
--- a/src/libedataserver/e-source-contacts.h
+++ b/src/libedataserver/e-source-contacts.h
@@ -52,6 +52,7 @@ typedef struct _ESourceContactsClass ESourceContactsClass;
typedef struct _ESourceContactsPrivate ESourceContactsPrivate;
struct _ESourceContacts {
+ /*< private >*/
ESourceExtension parent;
ESourceContactsPrivate *priv;
};
diff --git a/src/libedataserver/e-source-credentials-provider-impl-google.h
b/src/libedataserver/e-source-credentials-provider-impl-google.h
index cede621..b5486b4 100644
--- a/src/libedataserver/e-source-credentials-provider-impl-google.h
+++ b/src/libedataserver/e-source-credentials-provider-impl-google.h
@@ -69,6 +69,7 @@ typedef struct _ESourceCredentialsProviderImplGooglePrivate ESourceCredentialsPr
* Since: 3.20
**/
struct _ESourceCredentialsProviderImplGoogle {
+ /*< private >*/
ESourceCredentialsProviderImpl parent;
ESourceCredentialsProviderImplGooglePrivate *priv;
};
diff --git a/src/libedataserver/e-source-credentials-provider-impl-password.h
b/src/libedataserver/e-source-credentials-provider-impl-password.h
index a566591..ee9e91b 100644
--- a/src/libedataserver/e-source-credentials-provider-impl-password.h
+++ b/src/libedataserver/e-source-credentials-provider-impl-password.h
@@ -60,6 +60,7 @@ typedef struct _ESourceCredentialsProviderImplPasswordPrivate ESourceCredentials
* Since: 3.16
**/
struct _ESourceCredentialsProviderImplPassword {
+ /*< private >*/
ESourceCredentialsProviderImpl parent;
ESourceCredentialsProviderImplPasswordPrivate *priv;
};
diff --git a/src/libedataserver/e-source-credentials-provider-impl.h
b/src/libedataserver/e-source-credentials-provider-impl.h
index 5902fa1..4269607 100644
--- a/src/libedataserver/e-source-credentials-provider-impl.h
+++ b/src/libedataserver/e-source-credentials-provider-impl.h
@@ -65,6 +65,7 @@ struct _ESourceCredentialsProvider;
* Since: 3.16
**/
struct _ESourceCredentialsProviderImpl {
+ /*< private >*/
EExtension parent;
ESourceCredentialsProviderImplPrivate *priv;
};
diff --git a/src/libedataserver/e-source-credentials-provider.h
b/src/libedataserver/e-source-credentials-provider.h
index 88b4876..390f1aa 100644
--- a/src/libedataserver/e-source-credentials-provider.h
+++ b/src/libedataserver/e-source-credentials-provider.h
@@ -65,6 +65,7 @@ typedef struct _ESourceCredentialsProviderPrivate ESourceCredentialsProviderPriv
* Since: 3.16
**/
struct _ESourceCredentialsProvider {
+ /*< private >*/
GObject parent;
ESourceCredentialsProviderPrivate *priv;
};
diff --git a/src/libedataserver/e-source-enums.h b/src/libedataserver/e-source-enums.h
index 5563929..f241c9f 100644
--- a/src/libedataserver/e-source-enums.h
+++ b/src/libedataserver/e-source-enums.h
@@ -92,8 +92,13 @@ typedef enum {
/**
* ETrustPromptResponse:
+ * @E_TRUST_PROMPT_RESPONSE_UNKNOWN: Unknown response, usually due to some error
+ * @E_TRUST_PROMPT_RESPONSE_REJECT: Reject permanently
+ * @E_TRUST_PROMPT_RESPONSE_ACCEPT: Accept permanently
+ * @E_TRUST_PROMPT_RESPONSE_ACCEPT_TEMPORARILY: Accept temporarily
+ * @E_TRUST_PROMPT_RESPONSE_REJECT_TEMPORARILY: Reject temporarily
*
- * XXX Document me!
+ * Response codes for the trust prompt.
*
* Since: 3.8
**/
diff --git a/src/libedataserver/e-source-extension.h b/src/libedataserver/e-source-extension.h
index 2c7ad2c..9954da7 100644
--- a/src/libedataserver/e-source-extension.h
+++ b/src/libedataserver/e-source-extension.h
@@ -58,6 +58,7 @@ typedef struct _ESourceExtensionPrivate ESourceExtensionPrivate;
* Since: 3.6
**/
struct _ESourceExtension {
+ /*< private >*/
GObject parent;
ESourceExtensionPrivate *priv;
};
diff --git a/src/libedataserver/e-source-goa.h b/src/libedataserver/e-source-goa.h
index 847445d..9501f5c 100644
--- a/src/libedataserver/e-source-goa.h
+++ b/src/libedataserver/e-source-goa.h
@@ -68,6 +68,7 @@ typedef struct _ESourceGoaPrivate ESourceGoaPrivate;
* Since: 3.6
**/
struct _ESourceGoa {
+ /*< private >*/
ESourceExtension parent;
ESourceGoaPrivate *priv;
};
diff --git a/src/libedataserver/e-source-ldap.h b/src/libedataserver/e-source-ldap.h
index abf1766..bcdd8ed 100644
--- a/src/libedataserver/e-source-ldap.h
+++ b/src/libedataserver/e-source-ldap.h
@@ -53,6 +53,7 @@ typedef struct _ESourceLDAPClass ESourceLDAPClass;
typedef struct _ESourceLDAPPrivate ESourceLDAPPrivate;
struct _ESourceLDAP {
+ /*< private >*/
ESourceExtension parent;
ESourceLDAPPrivate *priv;
};
diff --git a/src/libedataserver/e-source-local.h b/src/libedataserver/e-source-local.h
index 1fc7a18..d35d55d 100644
--- a/src/libedataserver/e-source-local.h
+++ b/src/libedataserver/e-source-local.h
@@ -52,6 +52,7 @@ typedef struct _ESourceLocalClass ESourceLocalClass;
typedef struct _ESourceLocalPrivate ESourceLocalPrivate;
struct _ESourceLocal {
+ /*< private >*/
ESourceExtension parent;
ESourceLocalPrivate *priv;
};
diff --git a/src/libedataserver/e-source-mail-account.h b/src/libedataserver/e-source-mail-account.h
index e89e467..0c1c468 100644
--- a/src/libedataserver/e-source-mail-account.h
+++ b/src/libedataserver/e-source-mail-account.h
@@ -68,6 +68,7 @@ typedef struct _ESourceMailAccountPrivate ESourceMailAccountPrivate;
* Since: 3.6
**/
struct _ESourceMailAccount {
+ /*< private >*/
ESourceBackend parent;
ESourceMailAccountPrivate *priv;
};
diff --git a/src/libedataserver/e-source-mail-composition.h b/src/libedataserver/e-source-mail-composition.h
index 3f97007..2afa234 100644
--- a/src/libedataserver/e-source-mail-composition.h
+++ b/src/libedataserver/e-source-mail-composition.h
@@ -69,6 +69,7 @@ typedef struct _ESourceMailCompositionPrivate ESourceMailCompositionPrivate;
* Since: 3.6
**/
struct _ESourceMailComposition {
+ /*< private >*/
ESourceExtension parent;
ESourceMailCompositionPrivate *priv;
};
diff --git a/src/libedataserver/e-source-mail-identity.h b/src/libedataserver/e-source-mail-identity.h
index a919fc3..e6dc3b4 100644
--- a/src/libedataserver/e-source-mail-identity.h
+++ b/src/libedataserver/e-source-mail-identity.h
@@ -68,6 +68,7 @@ typedef struct _ESourceMailIdentityPrivate ESourceMailIdentityPrivate;
* Since: 3.6
**/
struct _ESourceMailIdentity {
+ /*< private >*/
ESourceExtension parent;
ESourceMailIdentityPrivate *priv;
};
diff --git a/src/libedataserver/e-source-mail-signature.h b/src/libedataserver/e-source-mail-signature.h
index 6707d53..cdcaf1f 100644
--- a/src/libedataserver/e-source-mail-signature.h
+++ b/src/libedataserver/e-source-mail-signature.h
@@ -68,6 +68,7 @@ typedef struct _ESourceMailSignaturePrivate ESourceMailSignaturePrivate;
* Since: 3.6
**/
struct _ESourceMailSignature {
+ /*< private >*/
ESourceExtension parent;
ESourceMailSignaturePrivate *priv;
};
diff --git a/src/libedataserver/e-source-mail-submission.h b/src/libedataserver/e-source-mail-submission.h
index 537c646..3ce33a2 100644
--- a/src/libedataserver/e-source-mail-submission.h
+++ b/src/libedataserver/e-source-mail-submission.h
@@ -68,6 +68,7 @@ typedef struct _ESourceMailSubmissionPrivate ESourceMailSubmissionPrivate;
* Since: 3.6
**/
struct _ESourceMailSubmission {
+ /*< private >*/
ESourceExtension parent;
ESourceMailSubmissionPrivate *priv;
};
diff --git a/src/libedataserver/e-source-mail-transport.h b/src/libedataserver/e-source-mail-transport.h
index 1f667c7..19579b2 100644
--- a/src/libedataserver/e-source-mail-transport.h
+++ b/src/libedataserver/e-source-mail-transport.h
@@ -68,6 +68,7 @@ typedef struct _ESourceMailTransportPrivate ESourceMailTransportPrivate;
* Since: 3.6
**/
struct _ESourceMailTransport {
+ /*< private >*/
ESourceBackend parent;
ESourceMailTransportPrivate *priv;
};
diff --git a/src/libedataserver/e-source-mdn.h b/src/libedataserver/e-source-mdn.h
index 69394b5..729ac51 100644
--- a/src/libedataserver/e-source-mdn.h
+++ b/src/libedataserver/e-source-mdn.h
@@ -69,6 +69,7 @@ typedef struct _ESourceMDNPrivate ESourceMDNPrivate;
* Since: 3.6
**/
struct _ESourceMDN {
+ /*< private >*/
ESourceExtension parent;
ESourceMDNPrivate *priv;
};
diff --git a/src/libedataserver/e-source-offline.h b/src/libedataserver/e-source-offline.h
index 8d0a6b7..78b505f 100644
--- a/src/libedataserver/e-source-offline.h
+++ b/src/libedataserver/e-source-offline.h
@@ -68,6 +68,7 @@ typedef struct _ESourceOfflinePrivate ESourceOfflinePrivate;
* Since: 3.6
**/
struct _ESourceOffline {
+ /*< private >*/
ESourceExtension parent;
ESourceOfflinePrivate *priv;
};
diff --git a/src/libedataserver/e-source-openpgp.h b/src/libedataserver/e-source-openpgp.h
index 306faff..4c8091a 100644
--- a/src/libedataserver/e-source-openpgp.h
+++ b/src/libedataserver/e-source-openpgp.h
@@ -68,6 +68,7 @@ typedef struct _ESourceOpenPGPPrivate ESourceOpenPGPPrivate;
* Since: 3.6
**/
struct _ESourceOpenPGP {
+ /*< private >*/
ESourceExtension parent;
ESourceOpenPGPPrivate *priv;
};
diff --git a/src/libedataserver/e-source-proxy.h b/src/libedataserver/e-source-proxy.h
index fdefef0..3dec952 100644
--- a/src/libedataserver/e-source-proxy.h
+++ b/src/libedataserver/e-source-proxy.h
@@ -69,6 +69,7 @@ typedef struct _ESourceProxyPrivate ESourceProxyPrivate;
* Since: 3.12
**/
struct _ESourceProxy {
+ /*< private >*/
ESourceExtension parent;
ESourceProxyPrivate *priv;
};
diff --git a/src/libedataserver/e-source-refresh.h b/src/libedataserver/e-source-refresh.h
index 60aa8b4..c194b19 100644
--- a/src/libedataserver/e-source-refresh.h
+++ b/src/libedataserver/e-source-refresh.h
@@ -68,6 +68,7 @@ typedef struct _ESourceRefreshPrivate ESourceRefreshPrivate;
* Since: 3.6
**/
struct _ESourceRefresh {
+ /*< private >*/
ESourceExtension parent;
ESourceRefreshPrivate *priv;
};
diff --git a/src/libedataserver/e-source-registry.c b/src/libedataserver/e-source-registry.c
index b7348fc..8211503 100644
--- a/src/libedataserver/e-source-registry.c
+++ b/src/libedataserver/e-source-registry.c
@@ -2613,7 +2613,7 @@ source_registry_prune_nodes (GNode *node,
}
/**
- * e_source_registry_build_display_tree: (skip):
+ * e_source_registry_build_display_tree: (skip)
* @registry: an #ESourceRegistry
* @extension_name: (allow-none): an extension name, or %NULL
*
diff --git a/src/libedataserver/e-source-registry.h b/src/libedataserver/e-source-registry.h
index b3aba33..2392331 100644
--- a/src/libedataserver/e-source-registry.h
+++ b/src/libedataserver/e-source-registry.h
@@ -58,6 +58,7 @@ typedef struct _ESourceRegistryPrivate ESourceRegistryPrivate;
* Since: 3.6
**/
struct _ESourceRegistry {
+ /*< private >*/
GObject parent;
ESourceRegistryPrivate *priv;
};
diff --git a/src/libedataserver/e-source-resource.h b/src/libedataserver/e-source-resource.h
index 98c9011..33c177f 100644
--- a/src/libedataserver/e-source-resource.h
+++ b/src/libedataserver/e-source-resource.h
@@ -68,6 +68,7 @@ typedef struct _ESourceResourcePrivate ESourceResourcePrivate;
* Since: 3.6
**/
struct _ESourceResource {
+ /*< private >*/
ESourceExtension parent;
ESourceResourcePrivate *priv;
};
diff --git a/src/libedataserver/e-source-revision-guards.h b/src/libedataserver/e-source-revision-guards.h
index fb68afd..2fa2802 100644
--- a/src/libedataserver/e-source-revision-guards.h
+++ b/src/libedataserver/e-source-revision-guards.h
@@ -71,6 +71,7 @@ typedef struct _ESourceRevisionGuardsPrivate ESourceRevisionGuardsPrivate;
* Since: 3.8
**/
struct _ESourceRevisionGuards {
+ /*< private >*/
ESourceExtension parent;
ESourceRevisionGuardsPrivate *priv;
};
diff --git a/src/libedataserver/e-source-security.h b/src/libedataserver/e-source-security.h
index 9bd3e1f..d3bc926 100644
--- a/src/libedataserver/e-source-security.h
+++ b/src/libedataserver/e-source-security.h
@@ -68,6 +68,7 @@ typedef struct _ESourceSecurityPrivate ESourceSecurityPrivate;
* Since: 3.6
**/
struct _ESourceSecurity {
+ /*< private >*/
ESourceExtension parent;
ESourceSecurityPrivate *priv;
};
diff --git a/src/libedataserver/e-source-selectable.h b/src/libedataserver/e-source-selectable.h
index e0a8c31..df418bf 100644
--- a/src/libedataserver/e-source-selectable.h
+++ b/src/libedataserver/e-source-selectable.h
@@ -58,6 +58,7 @@ typedef struct _ESourceSelectablePrivate ESourceSelectablePrivate;
* Since: 3.6
**/
struct _ESourceSelectable {
+ /*< private >*/
ESourceBackend parent;
ESourceSelectablePrivate *priv;
};
diff --git a/src/libedataserver/e-source-smime.h b/src/libedataserver/e-source-smime.h
index 8287386..1f7ac7a 100644
--- a/src/libedataserver/e-source-smime.h
+++ b/src/libedataserver/e-source-smime.h
@@ -68,6 +68,7 @@ typedef struct _ESourceSMIMEPrivate ESourceSMIMEPrivate;
* Since: 3.6
**/
struct _ESourceSMIME {
+ /*< private >*/
ESourceExtension parent;
ESourceSMIMEPrivate *priv;
};
diff --git a/src/libedataserver/e-source-uoa.h b/src/libedataserver/e-source-uoa.h
index 3b2ffe0..284bbd8 100644
--- a/src/libedataserver/e-source-uoa.h
+++ b/src/libedataserver/e-source-uoa.h
@@ -68,6 +68,7 @@ typedef struct _ESourceUoaPrivate ESourceUoaPrivate;
* Since: 3.8
**/
struct _ESourceUoa {
+ /*< private >*/
ESourceExtension parent;
ESourceUoaPrivate *priv;
};
diff --git a/src/libedataserver/e-source-weather.h b/src/libedataserver/e-source-weather.h
index ad16b72..231f191 100644
--- a/src/libedataserver/e-source-weather.h
+++ b/src/libedataserver/e-source-weather.h
@@ -53,6 +53,7 @@ typedef struct _ESourceWeatherClass ESourceWeatherClass;
typedef struct _ESourceWeatherPrivate ESourceWeatherPrivate;
struct _ESourceWeather {
+ /*< private >*/
ESourceExtension parent;
ESourceWeatherPrivate *priv;
};
diff --git a/src/libedataserver/e-source-webdav.c b/src/libedataserver/e-source-webdav.c
index 59e2ad5..508cf92 100644
--- a/src/libedataserver/e-source-webdav.c
+++ b/src/libedataserver/e-source-webdav.c
@@ -1332,6 +1332,8 @@ e_source_webdav_update_ssl_trust (ESourceWebdav *extension,
* @host: a host name to store the certificate for
* @cert: the invalid certificate of the connection over which @host is about
* to be sent
+ * @cert_errors: a bit-or of #GTlsCertificateFlags describing the reason
+ * for the @cert to be considered invalid
*
* Verifies SSL/TLS trust for the given @host and @cert, as previously stored in the @extension
* with e_source_webdav_update_ssl_trust().
diff --git a/src/libedataserver/e-source-webdav.h b/src/libedataserver/e-source-webdav.h
index e7532b1..86eacb3 100644
--- a/src/libedataserver/e-source-webdav.h
+++ b/src/libedataserver/e-source-webdav.h
@@ -75,6 +75,7 @@ typedef struct _ESourceWebdavPrivate ESourceWebdavPrivate;
* Since: 3.6
**/
struct _ESourceWebdav {
+ /*< private >*/
ESourceExtension parent;
ESourceWebdavPrivate *priv;
};
diff --git a/src/libedataserver/e-source.c b/src/libedataserver/e-source.c
index 1a9c80b..dd4186f 100644
--- a/src/libedataserver/e-source.c
+++ b/src/libedataserver/e-source.c
@@ -4870,6 +4870,7 @@ e_source_invoke_authenticate_finish (ESource *source,
/**
* e_source_emit_credentials_required:
+ * @source: an #ESource
* @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
diff --git a/src/libedataserver/e-source.h b/src/libedataserver/e-source.h
index 66004fc..2c004fb 100644
--- a/src/libedataserver/e-source.h
+++ b/src/libedataserver/e-source.h
@@ -114,6 +114,7 @@ typedef struct _ESourcePrivate ESourcePrivate;
* Since: 3.6
**/
struct _ESource {
+ /*< private >*/
GObject parent;
ESourcePrivate *priv;
};
diff --git a/tests/test-server-utils/e-test-server-utils.h b/tests/test-server-utils/e-test-server-utils.h
index 41f40b6..c73c8d5 100644
--- a/tests/test-server-utils/e-test-server-utils.h
+++ b/tests/test-server-utils/e-test-server-utils.h
@@ -62,6 +62,7 @@ typedef void (* ETestSourceCustomizeFunc) (ESource *scratch,
* @E_TEST_SERVER_DIRECT_ADDRESS_BOOK: An #EBookCLient in direct read access mode will be created and opened
for the test
* @E_TEST_SERVER_CALENDAR: An #ECalClient will be created and opened for the test
* @E_TEST_SERVER_DEPRECATED_ADDRESS_BOOK: An #EBook will be created and opened for the test
+ * @E_TEST_SERVER_DEPRECATED_CALENDAR: An #ECal will be created and opened for the test
*
* The type of service to test
*/
@@ -76,6 +77,7 @@ typedef enum {
/**
* ETestServerClosure:
+ * @type: An #ETestServiceType, type of the service
* @customize: An #ETestSourceCustomizeFunc to use to parameterize the scratch #ESource, or %NULL
* @calendar_source_type: An #ECalClientSourceType or #ECalSourceType; for %E_TEST_SERVER_CALENDAR
* and %E_TEST_SERVER_DEPRECATED_CALENDAR tests
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
