[evolution-data-server] Bug 785647 - Fix some warnings within the documentation
- From: Milan Crha <mcrha src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [evolution-data-server] Bug 785647 - Fix some warnings within the documentation
- Date: Tue, 1 Aug 2017 05:28:08 +0000 (UTC)
commit 9b4f532a550e7a63bfe89981bb042298282550f0
Author: Corentin Noël <corentin elementary io>
Date: Tue Aug 1 07:28:02 2017 +0200
Bug 785647 - Fix some warnings within the documentation
docs/reference/camel/camel-docs.sgml.in | 4 +++
src/addressbook/libebook-contacts/e-book-query.c | 2 +-
src/addressbook/libebook-contacts/e-book-query.h | 2 +-
src/addressbook/libebook-contacts/e-contact.c | 4 +-
src/addressbook/libebook/e-book-client-cursor.c | 4 +-
src/addressbook/libebook/e-book-client.c | 8 +++---
src/addressbook/libebook/e-book.c | 6 +---
.../libedata-book/e-book-backend-sexp.c | 4 +-
.../libedata-book/e-book-backend-sqlitedb.c | 8 +++---
src/addressbook/libedata-book/e-book-backend.c | 8 +++---
src/addressbook/libedata-book/e-book-cache.c | 6 ++--
.../libedata-book/e-book-meta-backend.c | 4 +-
src/addressbook/libedata-book/e-book-sqlite.c | 2 +-
src/addressbook/libedata-book/e-data-book-cursor.c | 2 +-
src/addressbook/libedata-book/e-data-book-cursor.h | 6 ++--
src/addressbook/libedata-book/e-data-book.c | 4 +-
src/calendar/libecal/e-cal-component.c | 2 +-
src/calendar/libecal/e-cal-util.c | 2 +-
src/calendar/libecal/e-cal.c | 4 +-
src/calendar/libedata-cal/e-cal-backend-sexp.c | 4 +-
src/calendar/libedata-cal/e-cal-backend-store.c | 4 +-
src/calendar/libedata-cal/e-cal-backend.c | 6 ++--
src/calendar/libedata-cal/e-cal-cache.h | 2 +-
src/calendar/libedata-cal/e-cal-meta-backend.c | 2 +-
src/calendar/libedata-cal/e-data-cal-view.c | 2 +-
src/calendar/libedata-cal/e-data-cal.c | 14 +++++-----
src/camel/camel-address.c | 6 ++--
src/camel/camel-data-wrapper.c | 16 +++++-----
src/camel/camel-file-utils.c | 28 ++++++++++----------
src/camel/camel-folder.c | 18 ++++++------
src/camel/camel-internet-address.c | 4 +-
src/camel/camel-mime-filter-charset.c | 2 +-
src/camel/camel-mime-filter-crlf.c | 2 +-
src/camel/camel-mime-filter-yenc.c | 6 ++--
src/camel/camel-mime-message.c | 2 +-
src/camel/camel-mime-parser.c | 17 ++++++-----
src/camel/camel-mime-utils.c | 2 +-
src/camel/camel-multipart-signed.c | 2 +-
src/camel/camel-multipart.c | 2 +-
src/camel/camel-offline-folder.c | 2 +-
src/camel/camel-provider.c | 2 +-
src/camel/camel-sasl.c | 2 +-
src/camel/camel-sexp.c | 2 +-
src/camel/camel-store-summary.c | 8 +----
src/camel/camel-store.c | 4 +-
src/camel/camel-stream-buffer.c | 4 +-
src/camel/camel-stream.c | 12 ++++----
src/camel/camel-url.c | 4 +-
src/camel/camel-vee-data-cache.h | 2 +-
src/camel/camel-vee-folder.c | 4 +-
src/camel/providers/imapx/camel-imapx-mailbox.c | 2 +-
src/camel/providers/imapx/camel-imapx-settings.c | 2 +-
src/camel/providers/imapx/camel-imapx-store.c | 4 +-
src/libebackend/e-backend.c | 6 ++--
src/libebackend/e-data-factory.c | 2 +-
src/libedataserver/e-credentials.c | 2 +-
src/libedataserver/e-data-server-util.c | 2 +-
.../e-source-credentials-provider-impl.c | 2 +-
src/libedataserver/e-source.c | 2 +-
src/libedataserver/e-source.h | 2 +-
src/libedataserver/e-webdav-session.c | 2 +-
tests/test-server-utils/e-test-server-utils.h | 4 +-
62 files changed, 150 insertions(+), 151 deletions(-)
---
diff --git a/docs/reference/camel/camel-docs.sgml.in b/docs/reference/camel/camel-docs.sgml.in
index 0a466a0..efdc590 100644
--- a/docs/reference/camel/camel-docs.sgml.in
+++ b/docs/reference/camel/camel-docs.sgml.in
@@ -294,6 +294,10 @@
<title>Index of deprecated symbols</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
</index>
+ <index id="api-index-3.26" role="3.26">
+ <title>Index of new symbols in 3.26</title>
+ <xi:include href="xml/api-index-3.26.xml"><xi:fallback /></xi:include>
+ </index>
<index id="api-index-3.24" role="3.24">
<title>Index of new symbols in 3.24</title>
<xi:include href="xml/api-index-3.24.xml"><xi:fallback /></xi:include>
diff --git a/src/addressbook/libebook-contacts/e-book-query.c
b/src/addressbook/libebook-contacts/e-book-query.c
index d182f53..7a53ad1 100644
--- a/src/addressbook/libebook-contacts/e-book-query.c
+++ b/src/addressbook/libebook-contacts/e-book-query.c
@@ -355,7 +355,7 @@ e_book_query_field_exists (EContactField field)
* @field: a field name
*
* Creates a new #EBookQuery which tests if the field @field exists. @field
- * should be a vCard field name, such as #FN or #X-MSN.
+ * should be a vCard field name, such as #EVC_FN or #EVC_X_MSN.
* Returns: the new #EBookQuery
**/
EBookQuery *
diff --git a/src/addressbook/libebook-contacts/e-book-query.h
b/src/addressbook/libebook-contacts/e-book-query.h
index f8f03ce..decc9e5 100644
--- a/src/addressbook/libebook-contacts/e-book-query.h
+++ b/src/addressbook/libebook-contacts/e-book-query.h
@@ -55,7 +55,7 @@ typedef struct _EBookQuery EBookQuery;
* @E_BOOK_QUERY_REGEX_NORMAL: A regular expression query against contact data normalized with
e_util_utf8_normalize(),
* the normalized data is lower case with any accents removed.
* @E_BOOK_QUERY_REGEX_RAW: A regular expression query against raw contact data, this is usually slower than
- * a %E_BOOK_QUERY_REGEX_NORMAL as it implies that #EVCards must be parsed in order to get the raw data
+ * a %E_BOOK_QUERY_REGEX_NORMAL as it implies that #EVCard(s) must be parsed in order to get the raw data
* for comparison.
* @E_BOOK_QUERY_LAST: End marker for the #EBookQueryTest enumeration, not a valid query test.
*
diff --git a/src/addressbook/libebook-contacts/e-contact.c b/src/addressbook/libebook-contacts/e-contact.c
index 2a780ac..b24e4e6 100644
--- a/src/addressbook/libebook-contacts/e-contact.c
+++ b/src/addressbook/libebook-contacts/e-contact.c
@@ -1485,7 +1485,7 @@ e_contact_field_is_string (EContactField field_id)
*
* Gets the #EContactField corresponding to the @field_name.
*
- * Returns: An #EContactField corresponding to @field_name, or %0 if it doesn't exist.
+ * Returns: An #EContactField corresponding to @field_name, or 0 if it doesn't exist.
**/
EContactField
e_contact_field_id (const gchar *field_name)
@@ -1506,7 +1506,7 @@ e_contact_field_id (const gchar *field_name)
*
* Gets the #EContactField corresponding to the @vcard_field.
*
- * Returns: An #EContactField corresponding to @vcard_field, or %0 if it doesn't exist.
+ * Returns: An #EContactField corresponding to @vcard_field, or 0 if it doesn't exist.
*
* Since: 2.26
**/
diff --git a/src/addressbook/libebook/e-book-client-cursor.c b/src/addressbook/libebook/e-book-client-cursor.c
index 88582bd..7a37bf5 100644
--- a/src/addressbook/libebook/e-book-client-cursor.c
+++ b/src/addressbook/libebook/e-book-client-cursor.c
@@ -2473,7 +2473,7 @@ e_book_client_cursor_step (EBookClientCursor *cursor,
* e_book_client_cursor_step_finish:
* @cursor: an #EBookClientCursor
* @result: a #GAsyncResult
- * @out_contacts: (element-type EContact) (out) (transfer full) (allow-none): return location for a #GSList
of #EContacts
+ * @out_contacts: (element-type EContact) (out) (transfer full) (allow-none): return location for a #GSList
of #EContact
* @error: (out) (allow-none): return location for a #GError, or %NULL
*
* Completes an asynchronous call initiated by e_book_client_cursor_step(), fetching
@@ -2528,7 +2528,7 @@ e_book_client_cursor_step_finish (EBookClientCursor *cursor,
* @flags: The #EBookCursorStepFlags for this step
* @origin: The #EBookCursorOrigin from whence to step
* @count: a positive or negative amount of contacts to try and fetch
- * @out_contacts: (element-type EContact) (out) (transfer full) (allow-none): return location for a #GSList
of #EContacts
+ * @out_contacts: (element-type EContact) (out) (transfer full) (allow-none): return location for a #GSList
of #EContact
* @cancellable: (allow-none): a #GCancellable to optionally cancel this operation while in progress
* @error: (out) (allow-none): return location for a #GError, or %NULL
*
diff --git a/src/addressbook/libebook/e-book-client.c b/src/addressbook/libebook/e-book-client.c
index 1ac1cc0..4ac3429 100644
--- a/src/addressbook/libebook/e-book-client.c
+++ b/src/addressbook/libebook/e-book-client.c
@@ -3480,12 +3480,12 @@ e_book_client_get_contacts (EBookClient *client,
* @client: an #EBookClient
* @result: a #GAsyncResult
* @out_contacts: (element-type EContact) (out) (transfer full): a #GSList
- * of matched #EContact-s
+ * of matched #EContact(s)
* @error: (out): a #GError to set an error, if any
*
* Finishes previous call of e_book_client_get_contacts().
* If successful, then the @out_contacts is set to newly allocated list of
- * #EContact-s, which should be freed with e_client_util_free_object_slist().
+ * #EContact(s), which should be freed with e_client_util_free_object_slist().
*
* Returns: %TRUE if successful, %FALSE otherwise.
*
@@ -3524,13 +3524,13 @@ e_book_client_get_contacts_finish (EBookClient *client,
* @client: an #EBookClient
* @sexp: an S-expression representing the query
* @out_contacts: (element-type EContact) (out): a #GSList of matched
- * #EContact-s
+ * #EContact(s)
* @cancellable: a #GCancellable; can be %NULL
* @error: (out): a #GError to set an error, if any
*
* Query @client with @sexp, receiving a list of contacts which matched.
* If successful, then the @out_contacts is set to newly allocated #GSList of
- * #EContact-s, which should be freed with e_client_util_free_object_slist().
+ * #EContact(s), which should be freed with e_client_util_free_object_slist().
*
* Note: @sexp can be obtained through #EBookQuery, by converting it
* to a string with e_book_query_to_string().
diff --git a/src/addressbook/libebook/e-book.c b/src/addressbook/libebook/e-book.c
index 087ef47..5b2cb61 100644
--- a/src/addressbook/libebook/e-book.c
+++ b/src/addressbook/libebook/e-book.c
@@ -2079,8 +2079,7 @@ e_book_free_change_list (GList *change_list)
*
* Returns: %TRUE on success, %FALSE otherwise
*
- * Deprecated: 3.2: Use e_client_cancel_all() or e_client_cancel_op() on an
- * #EBookClient object instead.
+ * Deprecated: 3.2: Use e_client_cancel_all() on an #EBookClient object instead.
**/
gboolean
e_book_cancel (EBook *book,
@@ -2105,8 +2104,7 @@ e_book_cancel (EBook *book,
*
* Since: 2.24
*
- * Deprecated: 3.2: Use e_client_cancel_all() or e_client_cancel_op() on an
- * #EBookClient object instead.
+ * Deprecated: 3.2: Use e_client_cancel_all() on an #EBookClient object instead.
**/
gboolean
e_book_cancel_async_op (EBook *book,
diff --git a/src/addressbook/libedata-book/e-book-backend-sexp.c
b/src/addressbook/libedata-book/e-book-backend-sexp.c
index 0f3ab69..d80c0d4 100644
--- a/src/addressbook/libedata-book/e-book-backend-sexp.c
+++ b/src/addressbook/libedata-book/e-book-backend-sexp.c
@@ -22,9 +22,9 @@
/**
* SECTION: e-book-backend-sexp
* @include: libedata-book/libedata-book.h
- * @short_description: A utility for comparing #EContacts or vcards with search expressions.
+ * @short_description: A utility for comparing #EContact objects or vcards with search expressions.
*
- * This API is an all purpose utility for comparing #EContacts with search expressions generated by
#EBookQuery.
+ * This API is an all purpose utility for comparing #EContact objects with search expressions generated by
#EBookQuery.
*/
#include "e-book-backend-sexp.h"
diff --git a/src/addressbook/libedata-book/e-book-backend-sqlitedb.c
b/src/addressbook/libedata-book/e-book-backend-sqlitedb.c
index 23cdb36..d40f39f 100644
--- a/src/addressbook/libedata-book/e-book-backend-sqlitedb.c
+++ b/src/addressbook/libedata-book/e-book-backend-sqlitedb.c
@@ -2426,7 +2426,7 @@ e_book_backend_sqlitedb_new_contact (EBookBackendSqliteDB *ebsdb,
* e_book_backend_sqlitedb_new_contacts
* @ebsdb: An #EBookBackendSqliteDB
* @folderid: folder id
- * @contacts: list of EContacts
+ * @contacts: list of #EContact
* @replace_existing: Whether this contact should replace another contact with the same UID.
* @error: (allow-none): A location to store any error that may have occurred.
*
@@ -2522,7 +2522,7 @@ e_book_backend_sqlitedb_add_contact (EBookBackendSqliteDB *ebsdb,
* e_book_backend_sqlitedb_add_contacts:
* @ebsdb: An #EBookBackendSqliteDB
* @folderid: folder id
- * @contacts: list of EContacts
+ * @contacts: list of #EContact
* @partial_content: contact does not contain full information. Used when
* the backend cache's partial information for auto-completion.
* @error: (allow-none): A location to store any error that may have occurred.
@@ -2778,7 +2778,7 @@ get_vcard_cb (gpointer ref,
* Fetch the #EContact specified by @uid in @folderid of @ebsdb.
*
* <note><para>The @fields_of_interest parameter is a legacy parameter which can
- * be used to specify that #EContacts with only the %E_CONTACT_UID
+ * be used to specify that #EContact(s) with only the %E_CONTACT_UID
* and %E_CONTACT_REV fields. The hash table must use g_str_hash()
* and g_str_equal() and the keys 'uid' and 'rev' must be present.</para></note>
*
@@ -4258,7 +4258,7 @@ book_backend_sqlitedb_search_full (EBookBackendSqliteDB *ebsdb,
* the #ESourceBackendSummarySetup source extension.
*
* <note><para>The @fields_of_interest parameter is a legacy parameter which can
- * be used to specify that #EContacts with only the %E_CONTACT_UID
+ * be used to specify that #EContact(s) with only the %E_CONTACT_UID
* and %E_CONTACT_REV fields. The hash table must use g_str_hash()
* and g_str_equal() and the keys 'uid' and 'rev' must be present.</para></note>
*
diff --git a/src/addressbook/libedata-book/e-book-backend.c b/src/addressbook/libedata-book/e-book-backend.c
index 45aa092..af845d8 100644
--- a/src/addressbook/libedata-book/e-book-backend.c
+++ b/src/addressbook/libedata-book/e-book-backend.c
@@ -3316,7 +3316,7 @@ e_book_backend_configure_direct (EBookBackend *backend,
/**
* e_book_backend_sync:
- * @backend: an #EBookbackend
+ * @backend: an #EBookBackend
*
* Write all pending data to disk. This is only required under special
* circumstances (for example before a live backup) and should not be used in
@@ -3339,7 +3339,7 @@ e_book_backend_sync (EBookBackend *backend)
/**
* e_book_backend_set_locale:
- * @backend: an #EBookbackend
+ * @backend: an #EBookBackend
* @locale: the new locale for the addressbook
* @cancellable: optional #GCancellable object, or %NULL
* @error: return location for a #GError, or %NULL
@@ -3379,7 +3379,7 @@ e_book_backend_set_locale (EBookBackend *backend,
/**
* e_book_backend_dup_locale:
- * @backend: an #EBookbackend
+ * @backend: an #EBookBackend
*
* Fetches a copy of the currently configured locale for the addressbook
*
@@ -3465,7 +3465,7 @@ e_book_backend_notify_remove (EBookBackend *backend,
/**
* e_book_backend_notify_complete:
- * @backend: an #EBookbackend
+ * @backend: an #EBookBackend
*
* Notifies all of @backend's book views that the current set of
* notifications is complete; use this after a series of
diff --git a/src/addressbook/libedata-book/e-book-cache.c b/src/addressbook/libedata-book/e-book-cache.c
index 5eddec2..601c030 100644
--- a/src/addressbook/libedata-book/e-book-cache.c
+++ b/src/addressbook/libedata-book/e-book-cache.c
@@ -22,7 +22,7 @@
* @include: libedata-book/libedata-book.h
* @short_description: An #ECache descendant for addressbooks
*
- * The #EBookCache is an API for storing and looking up #EContacts
+ * The #EBookCache is an API for storing and looking up #EContact(s)
* in an #ECache. It also supports cursors.
*
* The API is thread safe, in the similar way as the #ECache is.
@@ -5309,7 +5309,7 @@ e_book_cache_search_with_callback (EBookCache *book_cache,
* e_book_cache_cursor_new:
* @book_cache: An #EBookCache
* @sexp: search expression; use %NULL or an empty string to get all stored contacts
- * @sort_fields: (array length=n_sort_fields): An array of #EContactField-s as sort keys in order of priority
+ * @sort_fields: (array length=n_sort_fields): An array of #EContactField(s) as sort keys in order of
priority
* @sort_types: (array length=n_sort_fields): An array of #EBookCursorSortTypes, one for each field in
@sort_fields
* @n_sort_fields: The number of fields to sort results by
* @error: return location for a #GError, or %NULL
@@ -5727,7 +5727,7 @@ e_book_cache_cursor_step (EBookCache *book_cache,
* on the currently active alphabet index must be obtained using #ECollator
* APIs.
*
- * Use e_book_cahce_ref_collator() to obtain the active collator for @book_cache.
+ * Use e_book_cache_ref_collator() to obtain the active collator for @book_cache.
*
* Since: 3.26
**/
diff --git a/src/addressbook/libedata-book/e-book-meta-backend.c
b/src/addressbook/libedata-book/e-book-meta-backend.c
index 9a08a9e..20767fc 100644
--- a/src/addressbook/libedata-book/e-book-meta-backend.c
+++ b/src/addressbook/libedata-book/e-book-meta-backend.c
@@ -3638,7 +3638,7 @@ e_book_meta_backend_get_changes_sync (EBookMetaBackend *meta_backend,
* of loading it with e_book_meta_backend_load_contact_sync().
*
* It is mandatory to implement this virtual method by the descendant, unless
- * it implements its own get_changes_sync().
+ * it implements its own #EBookMetaBackendClass.get_changes_sync().
*
* The @out_existing_objects #GSList should be freed with
* g_slist_free_full (objects, e_book_meta_backend_info_free);
@@ -3893,7 +3893,7 @@ e_book_meta_backend_search_sync (EBookMetaBackend *meta_backend,
* found contact UID-s as a #GSList @out_contacts.
* Free the returned @out_uids with g_slist_free_full (uids, g_free);
* when no longer needed.
- * When the @expr is %NULL, all UID-s are returned. To get #EContact-s
+ * When the @expr is %NULL, all UID-s are returned. To get #EContact(s)
* instead, call e_book_meta_backend_search_sync().
*
* It is optional to implement this virtual method by the descendant.
diff --git a/src/addressbook/libedata-book/e-book-sqlite.c b/src/addressbook/libedata-book/e-book-sqlite.c
index ac77827..f4f2fdc 100644
--- a/src/addressbook/libedata-book/e-book-sqlite.c
+++ b/src/addressbook/libedata-book/e-book-sqlite.c
@@ -23,7 +23,7 @@
* @include: libedata-book/libedata-book.h
* @short_description: An SQLite storage facility for addressbooks
*
- * The #EBookSqlite is an API for storing and looking up #EContacts
+ * The #EBookSqlite is an API for storing and looking up #EContact(s)
* in an SQLite database. It also supports a lean index mode via
* the #EbSqlVCardCallback, if you are in a situation where it is
* not convenient to store the vCards directly in the SQLite. It is
diff --git a/src/addressbook/libedata-book/e-data-book-cursor.c
b/src/addressbook/libedata-book/e-data-book-cursor.c
index 7c8fb5b..b1c367a 100644
--- a/src/addressbook/libedata-book/e-data-book-cursor.c
+++ b/src/addressbook/libedata-book/e-data-book-cursor.c
@@ -38,7 +38,7 @@
* <para>
* In order for an addressbook backend to implement cursors, it must
* first be locale aware, persist a current locale setting and implement
- * the #EBookBackendClass.set_locale() and #EBookBackendClass.get_locale()
+ * the #EBookBackendClass.set_locale() and #EBookBackendClass.dup_locale()
* methods.
* </para>
* <para>
diff --git a/src/addressbook/libedata-book/e-data-book-cursor.h
b/src/addressbook/libedata-book/e-data-book-cursor.h
index 785f30e..ba62481 100644
--- a/src/addressbook/libedata-book/e-data-book-cursor.h
+++ b/src/addressbook/libedata-book/e-data-book-cursor.h
@@ -159,10 +159,10 @@ typedef gboolean (*EDataBookCursorSetAlphabetIndexFunc) (EDataBookCursor *cu
*
* A cursor position is defined as an integer which is inclusive of the
* current contact to which it points (if the cursor points to an exact
- * contact). A position of %0 indicates that the cursor is situated in
+ * contact). A position of 0 indicates that the cursor is situated in
* a position that is before and after the entire result set. The cursor
- * position should be %0 at creation time, and should start again from
- * the symbolic %0 position whenever %E_BOOK_CURSOR_ORIGIN_BEGIN is
+ * position should be 0 at creation time, and should start again from
+ * the symbolic 0 position whenever %E_BOOK_CURSOR_ORIGIN_BEGIN is
* specified in the #EDataBookCursorClass.step() method (or whenever
* moving the cursor beyond the end of the result set).
*
diff --git a/src/addressbook/libedata-book/e-data-book.c b/src/addressbook/libedata-book/e-data-book.c
index 130218f..f851a38 100644
--- a/src/addressbook/libedata-book/e-data-book.c
+++ b/src/addressbook/libedata-book/e-data-book.c
@@ -1624,7 +1624,7 @@ e_data_book_respond_get_contact_list_uids (EDataBook *book,
* @book: An #EDataBook
* @opid: An operation ID
* @error: Operation error, if any, automatically freed if passed it
- * @contacts: (allow-none) (element-type EContact): A list of created #EContact-s, or %NULL on error
+ * @contacts: (allow-none) (element-type EContact): A list of created #EContact(s), or %NULL on error
*
* Finishes a call to create a list contacts.
*
@@ -1677,7 +1677,7 @@ e_data_book_respond_create_contacts (EDataBook *book,
* @book: An #EDataBook
* @opid: An operation ID
* @error: Operation error, if any, automatically freed if passed it
- * @contacts: (allow-none) (element-type EContact): A list of modified #EContact-s, or %NULL on error
+ * @contacts: (allow-none) (element-type EContact): A list of modified #EContact(s), or %NULL on error
*
* Finishes a call to modify a list of contacts.
*
diff --git a/src/calendar/libecal/e-cal-component.c b/src/calendar/libecal/e-cal-component.c
index 39e4b31..36a5aec 100644
--- a/src/calendar/libecal/e-cal-component.c
+++ b/src/calendar/libecal/e-cal-component.c
@@ -457,7 +457,7 @@ e_cal_component_new_from_string (const gchar *calobj)
* to e_cal_component_set_icalcomponent() fails, then @icalcomp
* is freed.
*
- * Returns: An #ECalComponet with @icalcomp assigned on success,
+ * Returns: An #ECalComponent with @icalcomp assigned on success,
* NULL if the @icalcomp cannot be assigned to #ECalComponent.
*
* Since: 3.4
diff --git a/src/calendar/libecal/e-cal-util.c b/src/calendar/libecal/e-cal-util.c
index c65cd1c..b257c49 100644
--- a/src/calendar/libecal/e-cal-util.c
+++ b/src/calendar/libecal/e-cal-util.c
@@ -579,7 +579,7 @@ compare_alarm_instance (gconstpointer a,
*
* Returns: (allow-none) (transfer full): a list of all the alarms found for the
* given component in the given time range. The list of alarms should be freed
- * by using e_cal_component_free_alarm_list().
+ * by using e_cal_component_alarms_free().
*/
ECalComponentAlarms *
e_cal_util_generate_alarms_for_comp (ECalComponent *comp,
diff --git a/src/calendar/libecal/e-cal.c b/src/calendar/libecal/e-cal.c
index 26eebbf..742af60 100644
--- a/src/calendar/libecal/e-cal.c
+++ b/src/calendar/libecal/e-cal.c
@@ -788,7 +788,7 @@ e_cal_open_async (ECal *ecal,
*
* Since: 2.30
*
- * Deprecated: 3.2: Use e_cal_client_refresh_sync() instead.
+ * Deprecated: 3.2: Use e_client_refresh_sync() instead.
**/
gboolean
e_cal_refresh (ECal *ecal,
@@ -957,7 +957,7 @@ e_cal_get_local_attachment_store (ECal *ecal)
*
* Returns: TRUE if the call was successful, FALSE if there was an error.
*
- * Deprecated: 3.2: Use e_cal_client_is_readonly() on an #ECalClient object instead.
+ * Deprecated: 3.2: Use e_client_is_readonly() on an #ECalClient object instead.
*/
gboolean
e_cal_is_read_only (ECal *ecal,
diff --git a/src/calendar/libedata-cal/e-cal-backend-sexp.c b/src/calendar/libedata-cal/e-cal-backend-sexp.c
index 466d9d2..28b0fb8 100644
--- a/src/calendar/libedata-cal/e-cal-backend-sexp.c
+++ b/src/calendar/libedata-cal/e-cal-backend-sexp.c
@@ -18,9 +18,9 @@
/**
* SECTION: e-cal-backend-sexp
* @include: libedata-cal/libedata-cal.h
- * @short_description: A utility for comparing #ECalComponents with search expressions.
+ * @short_description: A utility for comparing #ECalComponent(s) with search expressions.
*
- * This API is an all purpose utility for comparing #ECalComponents with search expressions
+ * This API is an all purpose utility for comparing #ECalComponent(s) with search expressions
* and is used by various backends to implement component filtering and searching.
*/
diff --git a/src/calendar/libedata-cal/e-cal-backend-store.c b/src/calendar/libedata-cal/e-cal-backend-store.c
index 422492c..3f13a18 100644
--- a/src/calendar/libedata-cal/e-cal-backend-store.c
+++ b/src/calendar/libedata-cal/e-cal-backend-store.c
@@ -1265,7 +1265,7 @@ e_cal_backend_store_has_component (ECalBackendStore *store,
/**
* e_cal_backend_store_put_component_with_time_range:
* @store: an #ECalBackendStore
- * @comp: the #ECalComonent to add
+ * @comp: the #ECalComponent to add
* @occurence_start: start time of this component
* @occurence_end: end time of this component
*
@@ -1301,7 +1301,7 @@ e_cal_backend_store_put_component_with_time_range (ECalBackendStore *store,
/**
* e_cal_backend_store_put_component:
* @store: an #ECalBackendStore
- * @comp: the #ECalComonent to add
+ * @comp: the #ECalComponent to add
*
* Returns: whether @comp was successfully added
*
diff --git a/src/calendar/libedata-cal/e-cal-backend.c b/src/calendar/libedata-cal/e-cal-backend.c
index 4f1934c..603567a 100644
--- a/src/calendar/libedata-cal/e-cal-backend.c
+++ b/src/calendar/libedata-cal/e-cal-backend.c
@@ -1492,7 +1492,7 @@ e_cal_backend_remove_view (ECalBackend *backend,
* e_cal_backend_list_views:
* @backend: an #ECalBackend
*
- * Returns a list of #ECalBookView instances added with
+ * Returns a list of #EDataCalView instances added with
* e_cal_backend_add_view().
*
* The views returned in the list are referenced for thread-safety.
@@ -1505,7 +1505,7 @@ e_cal_backend_remove_view (ECalBackend *backend,
* g_list_free_full (list, g_object_unref);
* ]|
*
- * Returns: a list of cal views
+ * Returns: (element-type EDataCalView): a list of cal views
*
* Since: 3.8
**/
@@ -1786,7 +1786,7 @@ cal_backend_refresh_thread (GSimpleAsyncResult *simple,
* operation.
*
* Once the refresh is initiated, @callback will be called. You can then
- * call e_cal-backend_refresh_finish() to get the result of the initiation.
+ * call e_cal_backend_refresh_finish() to get the result of the initiation.
*
* Since: 3.10
**/
diff --git a/src/calendar/libedata-cal/e-cal-cache.h b/src/calendar/libedata-cal/e-cal-cache.h
index 50d18c6..571ebfb 100644
--- a/src/calendar/libedata-cal/e-cal-cache.h
+++ b/src/calendar/libedata-cal/e-cal-cache.h
@@ -132,7 +132,7 @@ void e_cal_cache_search_data_free (/* ECalCacheSearchData * */ gpointer
ptr);
* @object: the object itself
* @extra: extra data stored with the object
* @offline_state: objects offline state, one of #EOfflineState
- * @user_data: user data, as used in e_cache_cache_search_with_callback()
+ * @user_data: user data, as used in e_cal_cache_search_with_callback()
*
* A callback called for each object row when using
* e_cal_cache_search_with_callback() function.
diff --git a/src/calendar/libedata-cal/e-cal-meta-backend.c b/src/calendar/libedata-cal/e-cal-meta-backend.c
index 7f938cd..159294a 100644
--- a/src/calendar/libedata-cal/e-cal-meta-backend.c
+++ b/src/calendar/libedata-cal/e-cal-meta-backend.c
@@ -4778,7 +4778,7 @@ e_cal_meta_backend_search_sync (ECalMetaBackend *meta_backend,
* @error: return location for a #GError, or %NULL
*
* Searches @meta_backend with given expression @expr and returns
- * found components as a #GSList of #ECalComponont-s @out_components.
+ * found components as a #GSList of #ECalComponent @out_components.
* Free the returned @out_components with g_slist_free_full (components, g_object_unref);
* when no longer needed.
* When the @expr is %NULL, all objects are returned. To get iCal
diff --git a/src/calendar/libedata-cal/e-data-cal-view.c b/src/calendar/libedata-cal/e-data-cal-view.c
index 56a0c1a..e590b92 100644
--- a/src/calendar/libedata-cal/e-data-cal-view.c
+++ b/src/calendar/libedata-cal/e-data-cal-view.c
@@ -1238,7 +1238,7 @@ e_data_cal_view_notify_components_added_1 (EDataCalView *view,
* Notifies all view listeners of the modification of a list of components.
*
* Like e_data_cal_view_notify_objects_modified() except takes a list of
- * #ECalComponents instead of a ical string representations and uses the
+ * #ECalComponent instead of a ical string representations and uses the
* #EDataCalView's fields-of-interest to filter out unwanted information
* from ical strings sent over the bus.
*
diff --git a/src/calendar/libedata-cal/e-data-cal.c b/src/calendar/libedata-cal/e-data-cal.c
index f53e606..4144db9 100644
--- a/src/calendar/libedata-cal/e-data-cal.c
+++ b/src/calendar/libedata-cal/e-data-cal.c
@@ -447,7 +447,7 @@ e_data_cal_status_to_string (EDataCalCallStatus status)
/**
* e_data_cal_create_error:
- * @status: #EDataCalStatus code
+ * @status: #EDataCalCallStatus code
* @custom_msg: Custom message to use for the error. When NULL,
* then uses a default message based on the @status code.
*
@@ -1935,8 +1935,8 @@ e_data_cal_respond_create_objects (EDataCal *cal,
* @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.
+ * @old_components: The old #ECalComponent(s).
+ * @new_components: The new #ECalComponent(s).
*
* Notifies listeners of the completion of the modify_objects method call.
*
@@ -2011,10 +2011,10 @@ e_data_cal_respond_modify_objects (EDataCal *cal,
* @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.
- * @new_components: The new #ECalComponents. They will not be NULL only
- * when removing instances of recurring appointments.
+ * @ids: (element-type: utf8) IDs of the removed objects.
+ * @old_components: (element-type ECalComponent): The old #ECalComponent(s).
+ * @new_components: (element-type ECalComponent): The new #ECalComponent(s).
+ * They will not be NULL only when removing instances of recurring appointments.
*
* Notifies listeners of the completion of the remove_objects method call.
*
diff --git a/src/camel/camel-address.c b/src/camel/camel-address.c
index 8897cd1..8aec82d 100644
--- a/src/camel/camel-address.c
+++ b/src/camel/camel-address.c
@@ -96,7 +96,7 @@ camel_address_length (CamelAddress *addr)
*
* Construct a new address from a raw address field.
*
- * Returns: the number of addresses parsed or %-1 on fail
+ * Returns: the number of addresses parsed or -1 on fail
**/
gint
camel_address_decode (CamelAddress *addr,
@@ -141,7 +141,7 @@ camel_address_encode (CamelAddress *addr)
* Attempt to convert a previously formatted and/or edited
* address back into internal form.
*
- * Returns: the number of addresses parsed or %-1 on fail
+ * Returns: the number of addresses parsed or -1 on fail
**/
gint
camel_address_unformat (CamelAddress *addr,
@@ -226,7 +226,7 @@ camel_address_copy (CamelAddress *dest,
/**
* camel_address_remove:
* @addr: a #CamelAddress object
- * @index: The address to remove, use %-1 to remove all address.
+ * @index: The address to remove, use -1 to remove all address.
*
* Remove an address by index, or all addresses.
**/
diff --git a/src/camel/camel-data-wrapper.c b/src/camel/camel-data-wrapper.c
index 68c6093..7882875 100644
--- a/src/camel/camel-data-wrapper.c
+++ b/src/camel/camel-data-wrapper.c
@@ -699,7 +699,7 @@ camel_data_wrapper_set_offline (CamelDataWrapper *data_wrapper,
* </para>
* </note>
*
- * Returns: the number of bytes written, or %-1 on error
+ * Returns: the number of bytes written, or -1 on error
*
* Since: 3.0
**/
@@ -810,7 +810,7 @@ camel_data_wrapper_write_to_stream (CamelDataWrapper *data_wrapper,
*
* Finishes the operation started with camel_data_wrapper_write_to_stream().
*
- * Returns: the number of bytes written, or %-1 or error
+ * Returns: the number of bytes written, or -1 or error
*
* Since: 3.0
**/
@@ -846,7 +846,7 @@ camel_data_wrapper_write_to_stream_finish (CamelDataWrapper *data_wrapper,
* </para>
* </note>
*
- * Returns: the number of bytes written, or %-1 on error
+ * Returns: the number of bytes written, or -1 on error
*
* Since: 3.0
**/
@@ -954,7 +954,7 @@ camel_data_wrapper_decode_to_stream (CamelDataWrapper *data_wrapper,
*
* Finishes the operation started with camel_data_wrapper_decode_to_stream().
*
- * Returns: the number of bytes written, or %-1 on error
+ * Returns: the number of bytes written, or -1 on error
*
* Since: 3.0
**/
@@ -1128,7 +1128,7 @@ camel_data_wrapper_construct_from_stream_finish (CamelDataWrapper *data_wrapper,
* </para>
* </note>
*
- * Returns: the number of bytes written, or %-1 on error
+ * Returns: the number of bytes written, or -1 on error
*
* Since: 3.12
**/
@@ -1244,7 +1244,7 @@ camel_data_wrapper_write_to_output_stream (CamelDataWrapper *data_wrapper,
* Finishes the operation started with
* camel_data_wrapper_write_to_output_stream().
*
- * Returns: the number of bytes written, or %-1 on error
+ * Returns: the number of bytes written, or -1 on error
*
* Since: 3.12
**/
@@ -1280,7 +1280,7 @@ camel_data_wrapper_write_to_output_stream_finish (CamelDataWrapper *data_wrapper
* </para>
* </note>
*
- * Returns: the number of bytes written, or %-1 on error
+ * Returns: the number of bytes written, or -1 on error
*
* Since: 3.12
**/
@@ -1390,7 +1390,7 @@ camel_data_wrapper_decode_to_output_stream (CamelDataWrapper *data_wrapper,
* Finishes the operation started with
* camel_data_wrapper_decode_to_output_stream().
*
- * Returns: the number of bytes written, or %-1 on error
+ * Returns: the number of bytes written, or -1 on error
*
* Since: 3.12
**/
diff --git a/src/camel/camel-file-utils.c b/src/camel/camel-file-utils.c
index 93f24ee..e4b052e 100644
--- a/src/camel/camel-file-utils.c
+++ b/src/camel/camel-file-utils.c
@@ -57,7 +57,7 @@
*
* Utility function to save an uint32 to a file.
*
- * Returns: %0 on success, %-1 on error.
+ * Returns: 0 on success, -1 on error.
**/
gint
camel_file_util_encode_uint32 (FILE *out,
@@ -82,7 +82,7 @@ camel_file_util_encode_uint32 (FILE *out,
*
* Retrieve an encoded uint32 from a file.
*
- * Returns: %0 on success, %-1 on error. @*dest will contain the
+ * Returns: 0 on success, -1 on error. @*dest will contain the
* decoded value.
**/
gint
@@ -114,7 +114,7 @@ camel_file_util_decode_uint32 (FILE *in,
* Encode a gint32, performing no compression, but converting
* to network order.
*
- * Returns: %0 on success, %-1 on error.
+ * Returns: 0 on success, -1 on error.
**/
gint
camel_file_util_encode_fixed_int32 (FILE *out,
@@ -135,7 +135,7 @@ camel_file_util_encode_fixed_int32 (FILE *out,
*
* Retrieve a gint32.
*
- * Returns: %0 on success, %-1 on error.
+ * Returns: 0 on success, -1 on error.
**/
gint
camel_file_util_decode_fixed_int32 (FILE *in,
@@ -189,7 +189,7 @@ camel_file_util_decode_##type (FILE *in, type *dest) \
*
* Encode a time_t value to the file.
*
- * Returns: %0 on success, %-1 on error.
+ * Returns: 0 on success, -1 on error.
**/
CFU_ENCODE_T (time_t)
@@ -200,7 +200,7 @@ CFU_ENCODE_T (time_t)
*
* Decode a time_t value.
*
- * Returns: %0 on success, %-1 on error.
+ * Returns: 0 on success, -1 on error.
**/
CFU_DECODE_T (time_t)
@@ -211,7 +211,7 @@ CFU_DECODE_T (time_t)
*
* Encode an off_t type.
*
- * Returns: %0 on success, %-1 on error.
+ * Returns: 0 on success, -1 on error.
**/
CFU_ENCODE_T (off_t)
@@ -222,7 +222,7 @@ CFU_ENCODE_T (off_t)
*
* Decode an off_t type.
*
- * Returns: %0 on success, %-1 on failure.
+ * Returns: 0 on success, -1 on failure.
**/
CFU_DECODE_T (off_t)
@@ -233,7 +233,7 @@ CFU_DECODE_T (off_t)
*
* Encode an gsize type.
*
- * Returns: %0 on success, %-1 on error.
+ * Returns: 0 on success, -1 on error.
**/
CFU_ENCODE_T (gsize)
@@ -244,7 +244,7 @@ CFU_ENCODE_T (gsize)
*
* Decode an gsize type.
*
- * Returns: %0 on success, %-1 on failure.
+ * Returns: 0 on success, -1 on failure.
**/
CFU_DECODE_T (gsize)
@@ -255,7 +255,7 @@ CFU_DECODE_T (gsize)
*
* Encode a normal string and save it in the output file.
*
- * Returns: %0 on success, %-1 on error.
+ * Returns: 0 on success, -1 on error.
**/
gint
camel_file_util_encode_string (FILE *out,
@@ -283,7 +283,7 @@ camel_file_util_encode_string (FILE *out,
*
* Decode a normal string from the input file.
*
- * Returns: %0 on success, %-1 on error.
+ * Returns: 0 on success, -1 on error.
**/
gint
camel_file_util_decode_string (FILE *in,
@@ -325,7 +325,7 @@ camel_file_util_decode_string (FILE *in,
* Unlike @camel_file_util_encode_string, it pads the
* @str with "NULL" bytes, if @len is > strlen(str)
*
- * Returns: %0 on success, %-1 on error.
+ * Returns: 0 on success, -1 on error.
**/
gint
camel_file_util_encode_fixed_string (FILE *out,
@@ -362,7 +362,7 @@ camel_file_util_encode_fixed_string (FILE *out,
*
* Decode a normal string from the input file.
*
- * Returns: %0 on success, %-1 on error.
+ * Returns: 0 on success, -1 on error.
**/
gint
camel_file_util_decode_fixed_string (FILE *in,
diff --git a/src/camel/camel-folder.c b/src/camel/camel-folder.c
index 753bd44..f1c8c02 100644
--- a/src/camel/camel-folder.c
+++ b/src/camel/camel-folder.c
@@ -1703,7 +1703,7 @@ camel_folder_take_folder_summary (CamelFolder *folder,
* camel_folder_get_message_count:
* @folder: a #CamelFolder
*
- * Returns: the number of messages in the folder, or %-1 if unknown
+ * Returns: the number of messages in the folder, or -1 if unknown
**/
gint
camel_folder_get_message_count (CamelFolder *folder)
@@ -1722,9 +1722,9 @@ camel_folder_get_message_count (CamelFolder *folder)
* camel_folder_get_unread_message_count:
* @folder: a #CamelFolder
*
- * DEPRECATED: use camel_object_get() instead.
+ * Deprecated: use camel_folder_summary_get_unread_count() instead.
*
- * Returns: the number of unread messages in the folder, or %-1 if
+ * Returns: the number of unread messages in the folder, or -1 if
* unknown
**/
gint
@@ -1740,7 +1740,7 @@ camel_folder_get_unread_message_count (CamelFolder *folder)
* camel_folder_get_deleted_message_count:
* @folder: a #CamelFolder
*
- * Returns: the number of deleted messages in the folder, or %-1 if
+ * Returns: the number of deleted messages in the folder, or -1 if
* unknown
**/
gint
@@ -1792,7 +1792,7 @@ camel_folder_set_flags (CamelFolder *folder,
*
* Returns: the set of #CamelMessageFlags that can be permanently
* stored on a message between sessions. If it includes
- * #CAMEL_FLAG_USER, then user-defined flags will be remembered.
+ * #CAMEL_MESSAGE_USER, then user-defined flags will be remembered.
**/
guint32
camel_folder_get_permanent_flags (CamelFolder *folder)
@@ -1836,8 +1836,8 @@ camel_folder_get_message_flags (CamelFolder *folder,
* camel_folder_set_message_flags:
* @folder: a #CamelFolder
* @uid: the UID of a message in @folder
- * @mask: a mask of #CamelMessageFlag bit-or values to use
- * @set: the flags to ser, also bit-or of #CamelMessageFlag
+ * @mask: a mask of #CamelMessageFlags bit-or values to use
+ * @set: the flags to ser, also bit-or of #CamelMessageFlags
*
* Sets those flags specified by @mask to the values specified by @set
* on the indicated message. (This may or may not persist after the
@@ -2324,8 +2324,8 @@ camel_folder_search_by_uids (CamelFolder *folder,
* @folder: a #CamelFolder
* @result: (element-type utf8): search results to free
*
- * Free the result of a search as gotten by camel_folder_search() or
- * camel_folder_search_by_uids().
+ * Free the result of a search as gotten by camel_folder_search_by_expression()
+ * or camel_folder_search_by_uids().
**/
void
camel_folder_search_free (CamelFolder *folder,
diff --git a/src/camel/camel-internet-address.c b/src/camel/camel-internet-address.c
index fde7d61..0122364 100644
--- a/src/camel/camel-internet-address.c
+++ b/src/camel/camel-internet-address.c
@@ -369,7 +369,7 @@ camel_internet_address_get (CamelInternetAddress *addr,
*
* Find address by real name.
*
- * Returns: the index of the address matching the name, or %-1 if no
+ * Returns: the index of the address matching the name, or -1 if no
* match was found
**/
gint
@@ -467,7 +467,7 @@ camel_internet_address_ensure_ascii_domains (CamelInternetAddress *addr)
*
* Find an address by address.
*
- * Returns: the index of the address, or %-1 if not found
+ * Returns: the index of the address, or -1 if not found
**/
gint
camel_internet_address_find_address (CamelInternetAddress *addr,
diff --git a/src/camel/camel-mime-filter-charset.c b/src/camel/camel-mime-filter-charset.c
index c3b9d3d..79d05e2 100644
--- a/src/camel/camel-mime-filter-charset.c
+++ b/src/camel/camel-mime-filter-charset.c
@@ -266,7 +266,7 @@ camel_mime_filter_charset_init (CamelMimeFilterCharset *filter)
* @from_charset: charset to convert from
* @to_charset: charset to convert to
*
- * Create a new #CamelMimeFiletrCharset object to convert text from
+ * Create a new #CamelMimeFilterCharset object to convert text from
* @from_charset to @to_charset.
*
* Returns: a new #CamelMimeFilterCharset object
diff --git a/src/camel/camel-mime-filter-crlf.c b/src/camel/camel-mime-filter-crlf.c
index 4d3d20b..8acde98 100644
--- a/src/camel/camel-mime-filter-crlf.c
+++ b/src/camel/camel-mime-filter-crlf.c
@@ -180,7 +180,7 @@ camel_mime_filter_crlf_init (CamelMimeFilterCRLF *filter)
* @direction: encode vs decode
* @mode: whether or not to perform SMTP dot-escaping
*
- * Create a new #CamelMimeFiletrCRLF object.
+ * Create a new #CamelMimeFilterCRLF object.
*
* Returns: a new #CamelMimeFilterCRLF object
**/
diff --git a/src/camel/camel-mime-filter-yenc.c b/src/camel/camel-mime-filter-yenc.c
index 8f75192..4c16508 100644
--- a/src/camel/camel-mime-filter-yenc.c
+++ b/src/camel/camel-mime-filter-yenc.c
@@ -311,9 +311,9 @@ camel_mime_filter_yenc_set_crc (CamelMimeFilterYenc *yenc,
* camel_mime_filter_yenc_get_pcrc:
* @yenc: a #CamelMimeFilterYenc object
*
- * Get the computed part crc or (#guint32) %-1 on fail.
+ * Get the computed part crc or (#guint32) -1 on fail.
*
- * Returns: the computed part crc or (#guint32) %-1 on fail.
+ * Returns: the computed part crc or (#guint32) -1 on fail.
**/
guint32
camel_mime_filter_yenc_get_pcrc (CamelMimeFilterYenc *yenc)
@@ -325,7 +325,7 @@ camel_mime_filter_yenc_get_pcrc (CamelMimeFilterYenc *yenc)
/**
* camel_mime_filter_yenc_get_crc:
- * @yenc: a #CamelMimeFiletrYenc object
+ * @yenc: a #CamelMimeFilterYenc object
*
* Get the computed crc or (#guint32) -1 on fail.
*
diff --git a/src/camel/camel-mime-message.c b/src/camel/camel-mime-message.c
index 4bcd5e8..bca0f93 100644
--- a/src/camel/camel-mime-message.c
+++ b/src/camel/camel-mime-message.c
@@ -1120,7 +1120,7 @@ best_encoding (CamelMimeMessage *msg,
* Re-encode all message parts to conform with the required encoding rules.
*
* If @enctype is #CAMEL_BESTENC_7BIT, then all parts will be re-encoded into
- * one of the 7bit transfer encodings. If @enctype is #CAMEL_BESTENC_8bit, all
+ * one of the 7bit transfer encodings. If @enctype is #CAMEL_BESTENC_8BIT, all
* parts will be re-encoded to either a 7bit encoding or, if the part is 8bit
* text, allowed to stay 8bit. If @enctype is #CAMEL_BESTENC_BINARY, then binary
* parts will be encoded as binary and 8bit textual parts will be encoded as 8bit.
diff --git a/src/camel/camel-mime-parser.c b/src/camel/camel-mime-parser.c
index c2c0c08..34acb08 100644
--- a/src/camel/camel-mime-parser.c
+++ b/src/camel/camel-mime-parser.c
@@ -249,11 +249,12 @@ camel_mime_parser_new (void)
* on the content, and are applied in the order they were added.
*
* Note that filters are only applied to the body content of messages, and once
- * a filter has been set, all content returned by a filter_step() with a state
- * of CAMEL_MIME_PARSER_STATE_BODY will have passed through the filter.
+ * a filter has been set, all content returned by a camel_mime_parser_step()
+ * with a state of CAMEL_MIME_PARSER_STATE_BODY will have passed through the
+ * filter.
*
- * Returns: An id that may be passed to filter_remove() to remove
- * the filter, or -1 if the operation failed.
+ * Returns: An id that may be passed to camel_mime_parser_filter_remove() to
+ * remove the filter, or -1 if the operation failed.
*
* Since: 2.22
**/
@@ -342,7 +343,7 @@ camel_mime_parser_header (CamelMimeParser *m,
*
* Get the list of the raw headers which are defined for the
* current state of the parser. These headers are valid
- * until the next call to parser_step(), or parser_drop_step().
+ * until the next call to camel_mime_parser_step(), or camel_mime_parser_drop_step().
*
* Returns: (transfer full): The headers, or %NULL, if there are no headers
* defined for the current part or state. Free it with camel_name_value_array_free().
@@ -553,7 +554,7 @@ camel_mime_parser_init_with_bytes (CamelMimeParser *parser,
* This may also be preceeded by an optional
* CAMEL_MIME_PARSER_STATE_PRE_FROM state which contains the scanned data
* found before the From line is encountered. See also
- * scan_pre_from().
+ * camel_mime_parser_scan_pre_from().
**/
void
camel_mime_parser_scan_from (CamelMimeParser *parser,
@@ -653,7 +654,7 @@ camel_mime_parser_drop_step (CamelMimeParser *parser)
* @datalength: (inout) (nullable): Pointer to accept a pointer to the data
* length associated with this step (if any).
*
- * Parse the next part of the MIME message. If _unstep()
+ * Parse the next part of the MIME message. If camel_mime_parser_unstep()
* has been called, then continue to return the same state
* for that many calls.
*
@@ -931,7 +932,7 @@ camel_mime_parser_push_state (CamelMimeParser *mp,
* be read from directly (without saving and restoring
* the seek position in between).
*
- * Returns: (transfer none) (nullable): The stream from _init_with_stream(),
+ * Returns: (transfer none) (nullable): The stream from camel_mime_parser_init_with_stream(),
* or NULL if the parser is reading from a file descriptor or is
* uninitialised.
**/
diff --git a/src/camel/camel-mime-utils.c b/src/camel/camel-mime-utils.c
index 54b081a..d6b29fb 100644
--- a/src/camel/camel-mime-utils.c
+++ b/src/camel/camel-mime-utils.c
@@ -4403,7 +4403,7 @@ parse_broken_date (struct _date_token *tokens,
* @tz_offset if non-NULL.
*
* Returns: the time_t representation of the date string specified by
- * @str or (time_t) %0 on error. If @tz_offset is non-NULL, the value
+ * @str or (time_t) 0 on error. If @tz_offset is non-NULL, the value
* of the timezone offset will be stored.
**/
time_t
diff --git a/src/camel/camel-multipart-signed.c b/src/camel/camel-multipart-signed.c
index 737131e..6167e1d 100644
--- a/src/camel/camel-multipart-signed.c
+++ b/src/camel/camel-multipart-signed.c
@@ -774,7 +774,7 @@ camel_multipart_signed_new (void)
/**
* camel_multipart_signed_get_content_stream:
- * @mps: a #CamlMultipartSigned object
+ * @mps: a #CamelMultipartSigned object
* @error: return location for a #GError, or %NULL
*
* Get the raw signed content stream of the multipart/signed MIME part
diff --git a/src/camel/camel-multipart.c b/src/camel/camel-multipart.c
index ea51717..3329ada 100644
--- a/src/camel/camel-multipart.c
+++ b/src/camel/camel-multipart.c
@@ -624,7 +624,7 @@ camel_multipart_set_postface (CamelMultipart *multipart,
*
* Construct a multipart from a parser.
*
- * Returns: %0 on success or %-1 on fail
+ * Returns: 0 on success or -1 on fail
**/
gint
camel_multipart_construct_from_parser (CamelMultipart *multipart,
diff --git a/src/camel/camel-offline-folder.c b/src/camel/camel-offline-folder.c
index a29557f..33d8f57 100644
--- a/src/camel/camel-offline-folder.c
+++ b/src/camel/camel-offline-folder.c
@@ -669,7 +669,7 @@ offline_folder_downsync_thread (GTask *task,
* @expression: search expression describing which set of messages
* to downsync (%NULL for all)
* @io_priority: the I/O priority of the request
- * @cancellable: optional #GCancellable object, or %NULl
+ * @cancellable: optional #GCancellable object, or %NULL
* @callback: a #GAsyncReadyCallback to call when the request is satisfied
* @user_data: data to pass to the callback function
*
diff --git a/src/camel/camel-provider.c b/src/camel/camel-provider.c
index 0a5e854..cd13f46 100644
--- a/src/camel/camel-provider.c
+++ b/src/camel/camel-provider.c
@@ -425,7 +425,7 @@ camel_provider_list (gboolean load)
* The returned #CamelProvider is owned by Camel and should not be
* modified or freed.
*
- * Returns: a #CamelProvider for %protocol, or %NULL
+ * Returns: a #CamelProvider for @protocol, or %NULL
**/
CamelProvider *
camel_provider_get (const gchar *protocol,
diff --git a/src/camel/camel-sasl.c b/src/camel/camel-sasl.c
index c903545..69efc10 100644
--- a/src/camel/camel-sasl.c
+++ b/src/camel/camel-sasl.c
@@ -814,7 +814,7 @@ sasl_challenge_base64_thread (GTask *task,
* response are both base64-encoded.
*
* When the operation is finished, @callback will be called. You can
- * then call camel_store_challenge_base64_finish() to get the result of
+ * then call camel_sasl_challenge_base64_finish() to get the result of
* the operation.
*
* Since: 3.0
diff --git a/src/camel/camel-sexp.c b/src/camel/camel-sexp.c
index 83658f8..a0afff0 100644
--- a/src/camel/camel-sexp.c
+++ b/src/camel/camel-sexp.c
@@ -1891,7 +1891,7 @@ camel_sexp_encode_bool (GString *string,
/**
* camel_sexp_encode_string:
- * @string: Destination #Gstring
+ * @string: Destination #GString
* @v_string: String expression.
*
* Add a c string @v_string to the s-expression stored in
diff --git a/src/camel/camel-store-summary.c b/src/camel/camel-store-summary.c
index 85fda17..5c21950 100644
--- a/src/camel/camel-store-summary.c
+++ b/src/camel/camel-store-summary.c
@@ -435,7 +435,7 @@ camel_store_summary_path (CamelStoreSummary *summary,
*
* Load the summary off disk.
*
- * Returns: %0 on success or %-1 on fail
+ * Returns: 0 on success or -1 on fail
**/
gint
camel_store_summary_load (CamelStoreSummary *summary)
@@ -497,7 +497,7 @@ error:
* Writes the summary to disk. The summary is only written if changes
* have occurred.
*
- * Returns: %0 on succes or %-1 on fail
+ * Returns: 0 on succes or -1 on fail
**/
gint
camel_store_summary_save (CamelStoreSummary *summary)
@@ -583,10 +583,6 @@ camel_store_summary_save (CamelStoreSummary *summary)
* @summary: a #CamelStoreSummary object
* @info: a #CamelStoreInfo
*
- * Adds a new @info record to the summary. If @info->uid is %NULL,
- * then a new uid is automatically re-assigned by calling
- * camel_store_summary_next_uid_string().
- *
* The @info record should have been generated by calling one of the
* info_new_*() functions, as it will be free'd based on the summary
* class. And MUST NOT be allocated directly using malloc.
diff --git a/src/camel/camel-store.c b/src/camel/camel-store.c
index 60b0b51..577b6bb 100644
--- a/src/camel/camel-store.c
+++ b/src/camel/camel-store.c
@@ -1653,7 +1653,7 @@ camel_store_get_folder_finish (CamelStore *store,
* all levels of hierarchy below @top. If not, it will only include
* the immediate subfolders of @top. If @flags includes
* %CAMEL_STORE_FOLDER_INFO_FAST, the unread_message_count fields of
- * some or all of the structures may be set to %-1, if the store cannot
+ * some or all of the structures may be set to -1, if the store cannot
* determine that information quickly. If @flags includes
* %CAMEL_STORE_FOLDER_INFO_NO_VIRTUAL, don't include special virtual
* folders (such as vTrash or vJunk).
@@ -1664,7 +1664,7 @@ camel_store_get_folder_finish (CamelStore *store,
* The CAMEL_STORE_FOLDER_INFO_FAST flag should be considered
* deprecated; most backends will behave the same whether it is
* supplied or not. The only guaranteed way to get updated folder
- * counts is to both open the folder and invoke refresh_info() it.
+ * counts is to both open the folder and invoke camel_folder_refresh_info() it.
*
* Returns: (nullable): a #CamelFolderInfo tree, or %NULL on error
*
diff --git a/src/camel/camel-stream-buffer.c b/src/camel/camel-stream-buffer.c
index c490b52..33f3f27 100644
--- a/src/camel/camel-stream-buffer.c
+++ b/src/camel/camel-stream-buffer.c
@@ -411,8 +411,8 @@ camel_stream_buffer_new (CamelStream *stream,
* If the newline character is encountered, then it will be
* included in the buffer @buf. The buffer will be %NULL terminated.
*
- * Returns: the number of characters read, or %0 for end of file,
- * and %-1 on error.
+ * Returns: the number of characters read, or 0 for end of file,
+ * and -1 on error.
**/
gint
camel_stream_buffer_gets (CamelStreamBuffer *sbf,
diff --git a/src/camel/camel-stream.c b/src/camel/camel-stream.c
index b053106..2243dc7 100644
--- a/src/camel/camel-stream.c
+++ b/src/camel/camel-stream.c
@@ -487,7 +487,7 @@ camel_stream_set_base_stream (CamelStream *stream,
*
* Attempts to read up to @n bytes from @stream into @buffer.
*
- * Returns: the number of bytes actually read, or %-1 on error and set
+ * Returns: the number of bytes actually read, or -1 on error and set
* errno.
**/
gssize
@@ -522,7 +522,7 @@ camel_stream_read (CamelStream *stream,
*
* Attempts to write up to @n bytes of @buffer into @stream.
*
- * Returns: the number of bytes written to the stream, or %-1 on error
+ * Returns: the number of bytes written to the stream, or -1 on error
* along with setting errno.
**/
gssize
@@ -556,7 +556,7 @@ camel_stream_write (CamelStream *stream,
* Flushes any buffered data to the stream's backing store. Only
* meaningful for writable streams.
*
- * Returns: %0 on success or %-1 on fail along with setting @error
+ * Returns: 0 on success or -1 on fail along with setting @error
**/
gint
camel_stream_flush (CamelStream *stream,
@@ -585,7 +585,7 @@ camel_stream_flush (CamelStream *stream,
*
* Closes the stream.
*
- * Returns: %0 on success or %-1 on error.
+ * Returns: 0 on success or -1 on error.
**/
gint
camel_stream_close (CamelStream *stream,
@@ -638,7 +638,7 @@ camel_stream_eos (CamelStream *stream)
*
* Writes the string to the stream.
*
- * Returns: the number of characters written or %-1 on error.
+ * Returns: the number of characters written or -1 on error.
**/
gssize
camel_stream_write_string (CamelStream *stream,
@@ -663,7 +663,7 @@ camel_stream_write_string (CamelStream *stream,
* Write all of a stream (until eos) into another stream, in a
* blocking fashion.
*
- * Returns: %-1 on error, or the number of bytes succesfully
+ * Returns: -1 on error, or the number of bytes succesfully
* copied across streams.
**/
gssize
diff --git a/src/camel/camel-url.c b/src/camel/camel-url.c
index 45fa08f..7f5e21b 100644
--- a/src/camel/camel-url.c
+++ b/src/camel/camel-url.c
@@ -654,7 +654,7 @@ append_url_encoded (GString *str,
* @escape_extra: additional characters beyond " \"%#<>{}|\^[]`"
* to escape (or %NULL)
*
- * This %-encodes the given URL part and returns the escaped version
+ * This %-encodes the given URL part and returns the escaped version
* in allocated memory, which the caller must free when it is done.
*
* Returns: the encoded string
@@ -680,7 +680,7 @@ camel_url_encode (const gchar *part,
* camel_url_decode:
* @part: a URL part
*
- * %-decodes the passed-in URL *in place*. The decoded version is
+ * %-decodes the passed-in URL *in place*. The decoded version is
* never longer than the encoded version, so there does not need to
* be any additional space at the end of the string.
*/
diff --git a/src/camel/camel-vee-data-cache.h b/src/camel/camel-vee-data-cache.h
index 095db37..4938f3b 100644
--- a/src/camel/camel-vee-data-cache.h
+++ b/src/camel/camel-vee-data-cache.h
@@ -98,7 +98,7 @@ typedef struct _CamelVeeDataCachePrivate CamelVeeDataCachePrivate;
/**
* CamelForeachInfoData:
* @mi_data: a #CamelVeeMessageInfoData
- * @subfolder: a #CameFolder which @mi_data references
+ * @subfolder: a #CamelFolder which @mi_data references
* @user_data: custom user data
*
* A callback prototype for camel_vee_data_cache_foreach_message_info_data()
diff --git a/src/camel/camel-vee-folder.c b/src/camel/camel-vee-folder.c
index 47c8ca2..221e476 100644
--- a/src/camel/camel-vee-folder.c
+++ b/src/camel/camel-vee-folder.c
@@ -1595,7 +1595,7 @@ camel_vee_folder_set_folders (CamelVeeFolder *vfolder,
*
* Adds the @mi_data to the @vfolder. The @changes can be
* updated with the made change and later used to notify others
- * with came_folder_changed() on the @vfolder. This can be used
+ * with camel_folder_changed() on the @vfolder. This can be used
* only for the Unmatched folder.
*
* Since: 3.6
@@ -1652,7 +1652,7 @@ camel_vee_folder_add_vuid (CamelVeeFolder *vfolder,
*
* Removes given @mi_data from the @vfolder. The @changes can be
* updated with the made change and later used to notify others
- * with came_folder_changed() on the @vfolder. This can be used
+ * with camel_folder_changed() on the @vfolder. This can be used
* only for the Unmatched folder.
*
* Since: 3.6
diff --git a/src/camel/providers/imapx/camel-imapx-mailbox.c b/src/camel/providers/imapx/camel-imapx-mailbox.c
index 054eecd..d0a8d36 100644
--- a/src/camel/providers/imapx/camel-imapx-mailbox.c
+++ b/src/camel/providers/imapx/camel-imapx-mailbox.c
@@ -854,7 +854,7 @@ camel_imapx_mailbox_set_quota_roots (CamelIMAPXMailbox *mailbox,
* Creates a copy of @mailbox's message map: a #GSequence of 32-bit integers
* which map message sequence numbers (MSNs) to unique identifiers (UIDs).
*
- * Free the returned #GSequence with g_sequeuce_free() when finished with it.
+ * Free the returned #GSequence with g_sequence_free() when finished with it.
*
* Returns: a #GSequence mapping MSNs to UIDs
*
diff --git a/src/camel/providers/imapx/camel-imapx-settings.c
b/src/camel/providers/imapx/camel-imapx-settings.c
index b6665c9..f8535b0 100644
--- a/src/camel/providers/imapx/camel-imapx-settings.c
+++ b/src/camel/providers/imapx/camel-imapx-settings.c
@@ -722,7 +722,7 @@ camel_imapx_settings_class_init (CamelIMAPXSettingsClass *class)
g_param_spec_boolean (
"use-shell-command",
"Use Shell Command",
- "Whether to use a custom shell "
+ "Whether to use a custom shell"
"command to connect to the server",
FALSE,
G_PARAM_READWRITE |
diff --git a/src/camel/providers/imapx/camel-imapx-store.c b/src/camel/providers/imapx/camel-imapx-store.c
index 5880cef..3d475ac 100644
--- a/src/camel/providers/imapx/camel-imapx-store.c
+++ b/src/camel/providers/imapx/camel-imapx-store.c
@@ -3514,13 +3514,13 @@ imapx_store_rename_mailbox_unlocked (CamelIMAPXStore *imapx_store,
* @imapx_store: a #CamelIMAPXStore
* @mailbox_name: a mailbox name
*
- * Looks up a #CamelMailbox by its name. If no match is found, the function
+ * Looks up a #CamelIMAPXMailbox by its name. If no match is found, the function
* returns %NULL.
*
* The returned #CamelIMAPXMailbox is referenced for thread-safety and
* should be unreferenced with g_object_unref() when finished with it.
*
- * Returns: a #CamelIMAPXMailbox, or %NULL
+ * Returns: (nullable): a #CamelIMAPXMailbox, or %NULL
*
* Since: 3.16
**/
diff --git a/src/libebackend/e-backend.c b/src/libebackend/e-backend.c
index e6aa435..3c92f47 100644
--- a/src/libebackend/e-backend.c
+++ b/src/libebackend/e-backend.c
@@ -1000,7 +1000,7 @@ e_backend_ref_main_context (EBackend *backend)
* properly opened. It's a proxy function for e_source_invoke_credentials_required_sync(),
* where can be found more information about actual parameters meaning.
*
- * The provided credentials are received through EBackend::authenticate_sync()
+ * The provided credentials are received through #EBackendClass.authenticate_sync()
* method asynchronously.
*
* If an error occurs, the function sets @error and returns %FALSE.
@@ -1246,7 +1246,7 @@ e_backend_schedule_authenticate (EBackend *backend,
*
* Makes sure that the associated ESource::connection-status is connected. This is
* useful in cases when the backend can connect to the destination without invoking
- * EBackend::authenticate_sync, possibly through e_backend_schedule_authenticate().
+ * #EBackendClass.authenticate_sync(), possibly through e_backend_schedule_authenticate().
*
* Since: 3.18
**/
@@ -1430,7 +1430,7 @@ e_backend_trust_prompt_finish (EBackend *backend,
*
* Provides destination server host name and port to which
* the backend connects. This is used to determine required
- * connection point for e_backend_destination_is_reachable().
+ * connection point for e_backend_is_destination_reachable().
* The @host is a newly allocated string, which will be freed
* with g_free(). When @backend sets both @host and @port, then
* it should return %TRUE, indicating it's a remote backend.
diff --git a/src/libebackend/e-data-factory.c b/src/libebackend/e-data-factory.c
index 6466897..7be9883 100644
--- a/src/libebackend/e-data-factory.c
+++ b/src/libebackend/e-data-factory.c
@@ -1349,7 +1349,7 @@ data_factory_spawn_subprocess_backend_in_thread (gpointer user_data)
/**
* e_data_factory_spawn_subprocess_backend:
* @data_factory: an #EDataFactory
- * @invocation: a #GDBusMethodInvcation
+ * @invocation: a #GDBusMethodInvocation
* @uid: an #ESource UID
* @extension_name: an extension name
* @subprocess_path: a path of an executable responsible for running the subprocess
diff --git a/src/libedataserver/e-credentials.c b/src/libedataserver/e-credentials.c
index 1c9df73..4d8cb69 100644
--- a/src/libedataserver/e-credentials.c
+++ b/src/libedataserver/e-credentials.c
@@ -426,7 +426,7 @@ check_equal_cb (gpointer key,
* @credentials1: an #ECredentials
* @credentials2: another #ECredentials
*
- * Returns whether two #ECredential structures contain the same keys with
+ * Returns whether two #ECredentials structures contain the same keys with
* same values.
*
* Returns: %TRUE if they are equal, %FALSE otherwise
diff --git a/src/libedataserver/e-data-server-util.c b/src/libedataserver/e-data-server-util.c
index 300b630..505ab36 100644
--- a/src/libedataserver/e-data-server-util.c
+++ b/src/libedataserver/e-data-server-util.c
@@ -2182,7 +2182,7 @@ e_named_parameters_new_strv (const gchar * const *strv)
* e_named_parameters_new_string:
* @str: a string to be used as a content of a newly created #ENamedParameters
*
- * Creates a new instance of an #ENamedParamters, with initial content being
+ * Creates a new instance of an #ENamedParameters, with initial content being
* taken from @str. This should be freed with e_named_parameters_free(),
* when no longer needed. Names are compared case insensitively.
*
diff --git a/src/libedataserver/e-source-credentials-provider-impl.c
b/src/libedataserver/e-source-credentials-provider-impl.c
index 69d063f..6c4498b 100644
--- a/src/libedataserver/e-source-credentials-provider-impl.c
+++ b/src/libedataserver/e-source-credentials-provider-impl.c
@@ -213,7 +213,7 @@ e_source_credentials_provider_impl_can_prompt (ESourceCredentialsProviderImpl *p
*
* Asks @provider_impl to lookup for stored credentials for @source.
* The @out_credentials is populated with them. If the result is not
- * %NULL, then it should be freed with e_anmed_parameters_free() when
+ * %NULL, then it should be freed with e_named_parameters_free() when
* no longer needed.
*
* Default implementation returns %FALSE and sets #G_IO_ERROR_NOT_SUPPORTED error.
diff --git a/src/libedataserver/e-source.c b/src/libedataserver/e-source.c
index e2b5806..8b99191 100644
--- a/src/libedataserver/e-source.c
+++ b/src/libedataserver/e-source.c
@@ -4465,7 +4465,7 @@ e_source_delete_password_finish (ESource *source,
* @error: (allow-none): return location for a #GError, or %NULL
*
* Let's the client-side know that credentials are required. The @reason defines which
- * parameters are used. The client passed the credentials with an e_source_authenitcate()
+ * parameters are used. The client passed the credentials with an e_source_authenticate()
* call.
*
* The %E_SOURCE_CREDENTIALS_REASON_REQUIRED is used for the first credentials prompt,
diff --git a/src/libedataserver/e-source.h b/src/libedataserver/e-source.h
index 2c004fb..bfaeff1 100644
--- a/src/libedataserver/e-source.h
+++ b/src/libedataserver/e-source.h
@@ -91,7 +91,7 @@
* to have up-to-date data on the server side, when the client side
* just saved the SSL trust change, which might not be propagated
* into the server (factory) side quickly enough. The key is added into
- * the credentials in invoke_authneticate() automatically, if the
+ * the credentials in invoke_authenticate() automatically, if the
* corresponding ESource contain a WebDAV extension and the key
* is not part of the credentials already.
*
diff --git a/src/libedataserver/e-webdav-session.c b/src/libedataserver/e-webdav-session.c
index 5c02efb..281da4c 100644
--- a/src/libedataserver/e-webdav-session.c
+++ b/src/libedataserver/e-webdav-session.c
@@ -1703,7 +1703,7 @@ e_webdav_session_mkcol_addressbook_sync (EWebDAVSession *webdav,
* @uri: URI of the collection to create
* @display_name: (nullable): a human-readable display name to set, or %NULL
* @description: (nullable): a human-readable description of the calendar, or %NULL
- * @color: (nullable): a color to set, in format "#RRGGBB", or %NULL
+ * @color: (nullable): a color to set, in format "#RRGGBB", or %NULL
* @supports: a bit-or of EWebDAVResourceSupports values
* @cancellable: optional #GCancellable object, or %NULL
* @error: return location for a #GError, or %NULL
diff --git a/tests/test-server-utils/e-test-server-utils.h b/tests/test-server-utils/e-test-server-utils.h
index c73c8d5..41f0e54 100644
--- a/tests/test-server-utils/e-test-server-utils.h
+++ b/tests/test-server-utils/e-test-server-utils.h
@@ -58,8 +58,8 @@ typedef void (* ETestSourceCustomizeFunc) (ESource *scratch,
/**
* ETestServiceType:
* @E_TEST_SERVER_NONE: Only the #ESourceRegistry will be created
- * @E_TEST_SERVER_ADDRESS_BOOK: An #EBookCLient will be created and opened for the test
- * @E_TEST_SERVER_DIRECT_ADDRESS_BOOK: An #EBookCLient in direct read access mode will be created and opened
for the test
+ * @E_TEST_SERVER_ADDRESS_BOOK: An #EBookClient will be created and opened for the test
+ * @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
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
