[evolution-data-server] Fix Gtk-Doc syntax in function block comments.
- From: Matthew Barnes <mbarnes src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [evolution-data-server] Fix Gtk-Doc syntax in function block comments.
- Date: Sun, 14 Mar 2010 17:21:09 +0000 (UTC)
commit 51ac6ef7fe91e7f9b0ed2c7470a0a41307e08034
Author: Matthew Barnes <mbarnes redhat com>
Date: Sun Mar 14 13:16:44 2010 -0400
Fix Gtk-Doc syntax in function block comments.
addressbook/libebook/e-address-western.c | 2 +-
addressbook/libebook/e-book-query.c | 28 +++---
addressbook/libebook/e-book-view.c | 4 +-
addressbook/libebook/e-book.c | 94 +++++++++---------
addressbook/libebook/e-contact.c | 42 ++++----
addressbook/libebook/e-destination.c | 50 +++++-----
addressbook/libebook/e-name-western.c | 2 +-
addressbook/libebook/e-vcard.c | 46 ++++----
addressbook/libedata-book/e-book-backend-cache.c | 18 ++--
.../libedata-book/e-book-backend-db-cache.c | 16 ++--
addressbook/libedata-book/e-book-backend-factory.c | 4 +-
addressbook/libedata-book/e-book-backend-sexp.c | 6 +-
addressbook/libedata-book/e-book-backend-summary.c | 16 ++--
addressbook/libedata-book/e-book-backend-sync.c | 24 ++--
addressbook/libedata-book/e-book-backend.c | 28 +++---
addressbook/libedata-book/e-data-book-view.c | 8 +-
.../backends/google/e-cal-backend-google-utils.c | 2 +-
calendar/libecal/e-cal-check-timezones.c | 2 +-
calendar/libecal/e-cal-component.c | 58 +++++-----
calendar/libecal/e-cal-recur.c | 2 +-
calendar/libecal/e-cal-time-util.c | 44 ++++----
calendar/libecal/e-cal-util.c | 34 +++---
calendar/libecal/e-cal-view.c | 4 +-
calendar/libecal/e-cal.c | 108 ++++++++++----------
calendar/libedata-cal/e-cal-backend-cache.c | 34 +++---
calendar/libedata-cal/e-cal-backend-factory.c | 6 +-
calendar/libedata-cal/e-cal-backend-sexp.c | 18 ++--
calendar/libedata-cal/e-cal-backend-sync.c | 48 +++++-----
calendar/libedata-cal/e-cal-backend-util.c | 20 ++--
calendar/libedata-cal/e-cal-backend.c | 12 +-
calendar/libedata-cal/e-data-cal-view.c | 14 ++--
camel/camel-block-file.c | 16 ++--
camel/camel-cipher-context.c | 12 +-
camel/camel-data-cache.c | 14 ++--
camel/camel-debug.c | 4 +-
camel/camel-digest-store.c | 2 +-
camel/camel-disco-store.c | 6 +-
camel/camel-file-utils.c | 30 +++---
camel/camel-filter-driver.c | 2 +-
camel/camel-folder-search.c | 8 +-
camel/camel-folder-thread.c | 4 +-
camel/camel-html-parser.c | 2 +-
camel/camel-http-stream.c | 2 +-
camel/camel-list-utils.c | 12 +-
camel/camel-lock.c | 8 +-
camel/camel-mime-parser.c | 40 ++++----
camel/camel-mime-utils.c | 2 +-
camel/camel-news-address.c | 2 +-
camel/camel-nntp-address.c | 6 +-
camel/camel-object.c | 14 ++--
camel/camel-operation.c | 8 +-
camel/camel-provider.c | 4 +-
camel/camel-seekable-stream.c | 2 +-
camel/camel-seekable-substream.c | 2 +-
camel/camel-store.c | 2 +-
camel/camel-stream-buffer.c | 2 +-
camel/camel-stream-process.c | 2 +-
camel/camel-string-utils.c | 10 +-
camel/camel-uid-cache.c | 6 +-
camel/camel-utf8.c | 12 +-
camel/camel-vee-folder.c | 4 +-
camel/camel-vee-summary.c | 2 +-
.../providers/groupwise/camel-groupwise-summary.c | 2 +-
camel/providers/groupwise/camel-groupwise-utils.c | 6 +-
camel/providers/imap/camel-imap-command.c | 12 +-
camel/providers/imap/camel-imap-message-cache.c | 10 +-
camel/providers/imap/camel-imap-search.c | 2 +-
camel/providers/imap/camel-imap-store-summary.c | 4 +-
camel/providers/imap/camel-imap-summary.c | 2 +-
camel/providers/imap/camel-imap-utils.c | 18 ++--
camel/providers/imapx/camel-imapx-store-summary.c | 4 +-
camel/providers/imapx/camel-imapx-stream.c | 2 +-
camel/providers/imapx/camel-imapx-summary.c | 2 +-
camel/providers/imapx/camel-imapx-utils.c | 6 +-
camel/providers/imapx/camel-imapx-view-summary.c | 2 +-
camel/providers/local/camel-local-summary.c | 2 +-
camel/providers/local/camel-maildir-summary.c | 2 +-
camel/providers/local/camel-mbox-summary.c | 2 +-
camel/providers/local/camel-mh-summary.c | 2 +-
camel/providers/nntp/camel-nntp-store-summary.c | 4 +-
camel/providers/nntp/camel-nntp-stream.c | 2 +-
camel/providers/pop3/camel-pop3-engine.c | 2 +-
camel/providers/pop3/camel-pop3-stream.c | 2 +-
libebackend/e-file-cache.c | 4 +-
libedataserver/e-account-list.c | 6 +-
libedataserver/e-account.c | 10 +-
libedataserver/e-categories.c | 6 +-
libedataserver/e-memory.c | 24 ++--
libedataserver/e-msgport.c | 6 +-
libedataserver/e-source-group.c | 4 +-
libedataserver/e-source.c | 12 +-
libedataserver/e-uid.c | 2 +-
libedataserverui/e-book-auth-util.c | 2 +-
libedataserverui/e-contact-store.c | 12 +-
libedataserverui/e-destination-store.c | 6 +-
libedataserverui/e-name-selector-dialog.c | 4 +-
libedataserverui/e-name-selector-entry.c | 6 +-
libedataserverui/e-name-selector-model.c | 8 +-
libedataserverui/e-name-selector.c | 10 +-
libedataserverui/e-passwords.c | 4 +-
libedataserverui/e-source-option-menu.c | 4 +-
libedataserverui/e-source-selector-dialog.c | 6 +-
libedataserverui/e-source-selector.c | 12 +-
libedataserverui/e-tree-model-generator.c | 8 +-
servers/groupwise/soup-soap-message.c | 6 +-
servers/groupwise/soup-soap-response.c | 34 +++---
106 files changed, 662 insertions(+), 660 deletions(-)
---
diff --git a/addressbook/libebook/e-address-western.c b/addressbook/libebook/e-address-western.c
index bc7ceac..2c23f2c 100644
--- a/addressbook/libebook/e-address-western.c
+++ b/addressbook/libebook/e-address-western.c
@@ -294,7 +294,7 @@ e_address_western_extract_street (gchar *line, gchar **street, gchar **extended)
* Parses a string representing a mailing address into a
* structure of type #EAddressWestern.
*
- * Return value: A new #EAddressWestern structure, or %NULL if the parsing failed.
+ * Returns: A new #EAddressWestern structure, or %NULL if the parsing failed.
**/
EAddressWestern *
e_address_western_parse (const gchar *in_address)
diff --git a/addressbook/libebook/e-book-query.c b/addressbook/libebook/e-book-query.c
index 0f6e0ae..5823715 100644
--- a/addressbook/libebook/e-book-query.c
+++ b/addressbook/libebook/e-book-query.c
@@ -74,7 +74,7 @@ conjoin (EBookQueryType type, gint nqs, EBookQuery **qs, gboolean unref)
*
* Create a new #EBookQuery which is the logical AND of the queries in #qs.
*
- * Return value: A new #EBookQuery
+ * Returns: A new #EBookQuery
**/
EBookQuery *
e_book_query_and (gint nqs, EBookQuery **qs, gboolean unref)
@@ -90,7 +90,7 @@ e_book_query_and (gint nqs, EBookQuery **qs, gboolean unref)
*
* Creates a new #EBookQuery which is the logical OR of the queries in #qs.
*
- * Return value: A new #EBookQuery
+ * Returns: A new #EBookQuery
**/
EBookQuery *
e_book_query_or (gint nqs, EBookQuery **qs, gboolean unref)
@@ -126,7 +126,7 @@ conjoinv (EBookQueryType type, EBookQuery *q, va_list ap)
*
* Creates a new #EBookQuery which is the logical AND of the queries specified.
*
- * Return value: A new #EBookQuery
+ * Returns: A new #EBookQuery
**/
EBookQuery *
e_book_query_andv (EBookQuery *q, ...)
@@ -144,7 +144,7 @@ e_book_query_andv (EBookQuery *q, ...)
*
* Creates a new #EBookQuery which is the logical OR of the queries specified.
*
- * Return value: A new #EBookQuery
+ * Returns: A new #EBookQuery
**/
EBookQuery *
e_book_query_orv (EBookQuery *q, ...)
@@ -162,7 +162,7 @@ e_book_query_orv (EBookQuery *q, ...)
*
* Creates a new #EBookQuery which is the opposite of #q.
*
- * Return value: the new #EBookQuery
+ * Returns: the new #EBookQuery
**/
EBookQuery *
e_book_query_not (EBookQuery *q, gboolean unref)
@@ -185,7 +185,7 @@ e_book_query_not (EBookQuery *q, gboolean unref)
*
* Creates a new #EBookQuery which tests @field for @value using the test @test.
*
- * Return value: the new #EBookQuery
+ * Returns: the new #EBookQuery
**/
EBookQuery *
e_book_query_field_test (EContactField field,
@@ -210,7 +210,7 @@ e_book_query_field_test (EContactField field,
*
* Creates a new #EBookQuery which tests @field for @value using the test @test.
*
- * Return value: the new #EBookQuery
+ * Returns: the new #EBookQuery
*
* Since: 2.22
**/
@@ -234,7 +234,7 @@ e_book_query_vcard_field_test (const gchar *field,
* @field: a #EContactField
*
* Creates a new #EBookQuery which tests if the field @field exists.
- * Return value: the new #EBookQuery
+ * Returns: the new #EBookQuery
**/
EBookQuery *
e_book_query_field_exists (EContactField field)
@@ -254,7 +254,7 @@ e_book_query_field_exists (EContactField field)
*
* Creates a new #EBookQuery which tests if the field @field exists. @field
* should be a vCard field name, such as #FN or #X-MSN.
- * Return value: the new #EBookQuery
+ * Returns: the new #EBookQuery
**/
EBookQuery *
e_book_query_vcard_field_exists (const gchar *field)
@@ -274,7 +274,7 @@ e_book_query_vcard_field_exists (const gchar *field)
*
* Creates a new #EBookQuery which tests if any field contains @value.
*
- * Return value: the new #EBookQuery
+ * Returns: the new #EBookQuery
**/
EBookQuery *
e_book_query_any_field_contains (const gchar *value)
@@ -339,7 +339,7 @@ e_book_query_unref (EBookQuery *q)
* @q: a #EBookQuery
*
* Increment the reference count on @q.
- * Return value: @q
+ * Returns: @q
**/
EBookQuery *
e_book_query_ref (EBookQuery *q)
@@ -598,7 +598,7 @@ static const struct {
*
* Parse @query_string and return a new #EBookQuery representing it.
*
- * Return value: the new #EBookQuery.
+ * Returns: the new #EBookQuery.
**/
EBookQuery*
e_book_query_from_string (const gchar *query_string)
@@ -654,7 +654,7 @@ e_book_query_from_string (const gchar *query_string)
*
* Return the string representation of @q.
*
- * Return value: The string form of the query. This string should be freed when
+ * Returns: The string form of the query. This string should be freed when
* finished with.
**/
gchar *
@@ -752,7 +752,7 @@ e_book_query_get_type (void)
*
* Creates a copy of @q.
*
- * Return value: A new #EBookQuery identical to @q.
+ * Returns: A new #EBookQuery identical to @q.
**/
EBookQuery*
e_book_query_copy (EBookQuery *q)
diff --git a/addressbook/libebook/e-book-view.c b/addressbook/libebook/e-book-view.c
index e022e00..54093a2 100644
--- a/addressbook/libebook/e-book-view.c
+++ b/addressbook/libebook/e-book-view.c
@@ -141,7 +141,7 @@ complete_cb (DBusGProxy *proxy, guint status, EBookView *book_view)
* is a private function, applications should call #e_book_get_book_view or
* #e_book_async_get_book_view.
*
- * Return value: A new #EBookView.
+ * Returns: A new #EBookView.
**/
EBookView *
_e_book_view_new (EBook *book, DBusGProxy *view_proxy, GStaticRecMutex *view_proxy_lock)
@@ -179,7 +179,7 @@ _e_book_view_new (EBook *book, DBusGProxy *view_proxy, GStaticRecMutex *view_pro
*
* Returns the #EBook that this book view is monitoring.
*
- * Return value: an #EBook.
+ * Returns: an #EBook.
*
* Since: 2.22
**/
diff --git a/addressbook/libebook/e-book.c b/addressbook/libebook/e-book.c
index 9722546..12da804 100644
--- a/addressbook/libebook/e-book.c
+++ b/addressbook/libebook/e-book.c
@@ -328,7 +328,7 @@ auth_required_cb (DBusGProxy *proxy, EBook *book)
*
* Adds @contact to @book.
*
- * Return value: %TRUE if successful, %FALSE otherwise.
+ * Returns: %TRUE if successful, %FALSE otherwise.
**/
gboolean
e_book_add_contact (EBook *book,
@@ -384,7 +384,7 @@ add_contact_reply (DBusGProxy *proxy, gchar *uid, GError *error, gpointer user_d
*
* Adds @contact to @book without blocking.
*
- * Return value: %TRUE if the operation was started, %FALSE otherwise.
+ * Returns: %TRUE if the operation was started, %FALSE otherwise.
**/
gboolean
e_book_async_add_contact (EBook *book,
@@ -422,7 +422,7 @@ e_book_async_add_contact (EBook *book,
* Applies the changes made to @contact to the stored version in
* @book.
*
- * Return value: %TRUE if successful, %FALSE otherwise
+ * Returns: %TRUE if successful, %FALSE otherwise
**/
gboolean
e_book_commit_contact (EBook *book,
@@ -467,7 +467,7 @@ modify_contact_reply (DBusGProxy *proxy, GError *error, gpointer user_data)
* Applies the changes made to @contact to the stored version in
* @book without blocking.
*
- * Return value: %TRUE if the operation was started, %FALSE otherwise.
+ * Returns: %TRUE if the operation was started, %FALSE otherwise.
**/
guint
e_book_async_commit_contact (EBook *book,
@@ -507,7 +507,7 @@ e_book_async_commit_contact (EBook *book,
* to allocated strings, and both the #GList and the strings
* must be freed by the caller.
*
- * Return value: %TRUE if successful, %FALSE otherwise.
+ * Returns: %TRUE if successful, %FALSE otherwise.
**/
gboolean
e_book_get_required_fields (EBook *book,
@@ -563,7 +563,7 @@ get_required_fields_reply(DBusGProxy *proxy, gchar **fields, GError *error, gpoi
* Gets a list of fields that are required to be filled in for
* all contacts in this @book. This function does not block.
*
- * Return value: %TRUE if the operation was started, %FALSE otherwise.
+ * Returns: %TRUE if the operation was started, %FALSE otherwise.
**/
guint
e_book_async_get_required_fields (EBook *book,
@@ -597,7 +597,7 @@ e_book_async_get_required_fields (EBook *book,
* will contain pointers to allocated strings, and both the
* #GList and the strings must be freed by the caller.
*
- * Return value: %TRUE if successful, %FALSE otherwise
+ * Returns: %TRUE if successful, %FALSE otherwise
**/
gboolean
e_book_get_supported_fields (EBook *book,
@@ -653,7 +653,7 @@ get_supported_fields_reply(DBusGProxy *proxy, gchar **fields, GError *error, gpo
* in this @book. Other fields may be discarded. This
* function does not block.
*
- * Return value: %TRUE if successful, %FALSE otherwise.
+ * Returns: %TRUE if successful, %FALSE otherwise.
**/
guint
e_book_async_get_supported_fields (EBook *book,
@@ -687,7 +687,7 @@ e_book_async_get_supported_fields (EBook *book,
* The list will contain pointers to allocated strings, and both the
* #GList and the strings must be freed by the caller.
*
- * Return value: %TRUE if successful, %FALSE otherwise
+ * Returns: %TRUE if successful, %FALSE otherwise
**/
gboolean
e_book_get_supported_auth_methods (EBook *book,
@@ -744,7 +744,7 @@ get_supported_auth_methods_reply(DBusGProxy *proxy, gchar **methods, GError *err
* Queries @book for the list of authentication methods it supports.
* This function does not block.
*
- * Return value: %TRUE if successful, %FALSE otherwise.
+ * Returns: %TRUE if successful, %FALSE otherwise.
**/
guint
e_book_async_get_supported_auth_methods (EBook *book,
@@ -780,7 +780,7 @@ e_book_async_get_supported_auth_methods (EBook *book,
* @auth_method. @auth_method must be one of the authentication
* methods returned using e_book_get_supported_auth_methods.
*
- * Return value: %TRUE if successful, %FALSE otherwise
+ * Returns: %TRUE if successful, %FALSE otherwise
**/
gboolean
e_book_authenticate_user (EBook *book,
@@ -828,7 +828,7 @@ authenticate_user_reply(DBusGProxy *proxy, GError *error, gpointer user_data)
* methods returned using e_book_get_supported_auth_methods.
* This function does not block.
*
- * Return value: %FALSE if successful, %TRUE otherwise.
+ * Returns: %FALSE if successful, %TRUE otherwise.
**/
guint
e_book_async_authenticate_user (EBook *book,
@@ -868,7 +868,7 @@ e_book_async_authenticate_user (EBook *book,
* Fills in @contact with the contents of the vcard in @book
* corresponding to @id.
*
- * Return value: %TRUE if successful, %FALSE otherwise
+ * Returns: %TRUE if successful, %FALSE otherwise
**/
gboolean
e_book_get_contact (EBook *book,
@@ -930,7 +930,7 @@ get_contact_reply(DBusGProxy *proxy, gchar *vcard, GError *error, gpointer user_
*
* Retrieves a contact specified by @id from @book.
*
- * Return value: %FALSE if successful, %TRUE otherwise
+ * Returns: %FALSE if successful, %TRUE otherwise
**/
guint
e_book_async_get_contact (EBook *book,
@@ -964,7 +964,7 @@ e_book_async_get_contact (EBook *book,
*
* Removes the contact with id @id from @book.
*
- * Return value: %TRUE if successful, %FALSE otherwise
+ * Returns: %TRUE if successful, %FALSE otherwise
**/
gboolean
e_book_remove_contact (EBook *book,
@@ -1012,7 +1012,7 @@ remove_contact_reply (DBusGProxy *proxy, GError *error, gpointer user_data)
* have more than one id to remove, as some backends can implement it
* as a batch request.
*
- * Return value: %TRUE if successful, %FALSE otherwise
+ * Returns: %TRUE if successful, %FALSE otherwise
**/
gboolean
e_book_remove_contacts (EBook *book,
@@ -1046,7 +1046,7 @@ e_book_remove_contacts (EBook *book,
*
* Removes @contact from @book.
*
- * Return value: %TRUE if successful, %FALSE otherwise
+ * Returns: %TRUE if successful, %FALSE otherwise
**/
guint
e_book_async_remove_contact (EBook *book,
@@ -1098,7 +1098,7 @@ remove_contact_by_id_reply (DBusGProxy *proxy, GError *error, gpointer user_data
*
* Removes the contact with id @id from @book.
*
- * Return value: %TRUE if successful, %FALSE otherwise
+ * Returns: %TRUE if successful, %FALSE otherwise
**/
guint
e_book_async_remove_contact_by_id (EBook *book,
@@ -1153,7 +1153,7 @@ remove_contacts_reply (DBusGProxy *proxy, GError *error, gpointer user_data)
* have more than one id to remove, as some backends can implement it
* as a batch request.
*
- * Return value: %TRUE if successful, %FALSE otherwise
+ * Returns: %TRUE if successful, %FALSE otherwise
**/
guint
e_book_async_remove_contacts (EBook *book,
@@ -1202,7 +1202,7 @@ e_book_async_remove_contacts (EBook *book,
* specified by @requested_fields and limited at @max_results records. On an
* error, @error is set and %FALSE returned.
*
- * Return value: %TRUE if successful, %FALSE otherwise
+ * Returns: %TRUE if successful, %FALSE otherwise
**/
gboolean
e_book_get_book_view (EBook *book,
@@ -1295,7 +1295,7 @@ get_book_view_reply (DBusGProxy *proxy, gchar *view_path, GError *error, gpointe
* Query @book with @query, creating a #EBookView with the fields
* specified by @requested_fields and limited at @max_results records.
*
- * Return value: %FALSE if successful, %TRUE otherwise
+ * Returns: %FALSE if successful, %TRUE otherwise
**/
guint
e_book_async_get_book_view (EBook *book,
@@ -1336,7 +1336,7 @@ e_book_async_get_book_view (EBook *book,
* Query @book with @query, setting @contacts to the list of contacts which
* matched. On failed, @error will be set and %FALSE returned.
*
- * Return value: %TRUE on success, %FALSE otherwise
+ * Returns: %TRUE on success, %FALSE otherwise
**/
gboolean
e_book_get_contacts (EBook *book,
@@ -1405,7 +1405,7 @@ get_contacts_reply(DBusGProxy *proxy, gchar **vcards, GError *error, gpointer us
*
* Query @book with @query.
*
- * Return value: %FALSE on success, %TRUE otherwise
+ * Returns: %FALSE on success, %TRUE otherwise
**/
guint
e_book_async_get_contacts (EBook *book,
@@ -1473,7 +1473,7 @@ parse_changes_array (GPtrArray *array)
* Get the set of changes since the previous call to #e_book_get_changes for a
* given change ID.
*
- * Return value: TRUE on success, FALSE otherwise
+ * Returns: TRUE on success, FALSE otherwise
*/
gboolean
e_book_get_changes (EBook *book,
@@ -1525,7 +1525,7 @@ get_changes_reply (DBusGProxy *proxy, GPtrArray *changes, GError *error, gpointe
* Get the set of changes since the previous call to #e_book_async_get_changes
* for a given change ID.
*
- * Return value: TRUE on success, FALSE otherwise
+ * Returns: TRUE on success, FALSE otherwise
*/
guint
e_book_async_get_changes (EBook *book,
@@ -1585,7 +1585,7 @@ e_book_free_change_list (GList *change_list)
* blocked e_book function corresponding to current operation will
* return with a status of E_BOOK_STATUS_CANCELLED.
*
- * Return value: %TRUE on success, %FALSE otherwise
+ * Returns: %TRUE on success, %FALSE otherwise
**/
gboolean
e_book_cancel (EBook *book,
@@ -1634,7 +1634,7 @@ e_book_cancel_async_op (EBook *book, GError **error)
*
* Opens the addressbook, making it ready for queries and other operations.
*
- * Return value: %TRUE if the book was successfully opened, %FALSE otherwise.
+ * Returns: %TRUE if the book was successfully opened, %FALSE otherwise.
*/
gboolean
e_book_open (EBook *book,
@@ -1694,7 +1694,7 @@ open_reply(DBusGProxy *proxy, GError *error, gpointer user_data)
* Opens the addressbook, making it ready for queries and other operations.
* This function does not block.
*
- * Return value: %FALSE if successful, %TRUE otherwise.
+ * Returns: %FALSE if successful, %TRUE otherwise.
**/
guint
e_book_async_open (EBook *book,
@@ -1727,7 +1727,7 @@ e_book_async_open (EBook *book,
* Removes the backing data for this #EBook. For example, with the file backend this
* deletes the database file. You cannot get it back!
*
- * Return value: %TRUE on success, %FALSE on failure.
+ * Returns: %TRUE on success, %FALSE on failure.
*/
gboolean
e_book_remove (EBook *book,
@@ -1766,7 +1766,7 @@ remove_reply(DBusGProxy *proxy, GError *error, gpointer user_data)
* Remove the backing data for this #EBook. For example, with the file backend this
* deletes the database file. You cannot get it back!
*
- * Return value: %FALSE if successful, %TRUE otherwise.
+ * Returns: %FALSE if successful, %TRUE otherwise.
**/
guint
e_book_async_remove (EBook *book,
@@ -1796,7 +1796,7 @@ e_book_async_remove (EBook *book,
*
* Get the URI that this book has loaded. This string should not be freed.
*
- * Return value: The URI.
+ * Returns: The URI.
*/
const gchar *
e_book_get_uri (EBook *book)
@@ -1812,7 +1812,7 @@ e_book_get_uri (EBook *book)
*
* Get the #ESource that this book has loaded.
*
- * Return value: The source.
+ * Returns: The source.
*/
ESource *
e_book_get_source (EBook *book)
@@ -1830,7 +1830,7 @@ e_book_get_source (EBook *book)
* Get the list of capabilities which the backend for this address book
* supports. This string should not be freed.
*
- * Return value: The capabilities list
+ * Returns: The capabilities list
*/
const gchar *
e_book_get_static_capabilities (EBook *book,
@@ -1864,7 +1864,7 @@ e_book_get_static_capabilities (EBook *book,
* Check to see if the backend for this address book supports the capability
* @cap.
*
- * Return value: %TRUE if the backend supports @cap, %FALSE otherwise.
+ * Returns: %TRUE if the backend supports @cap, %FALSE otherwise.
*/
gboolean
e_book_check_static_capability (EBook *book,
@@ -1889,7 +1889,7 @@ e_book_check_static_capability (EBook *book,
*
* Check if this book has been opened.
*
- * Return value: %TRUE if this book has been opened, otherwise %FALSE.
+ * Returns: %TRUE if this book has been opened, otherwise %FALSE.
*/
gboolean
e_book_is_opened (EBook *book)
@@ -1905,7 +1905,7 @@ e_book_is_opened (EBook *book)
*
* Check if this book is writable.
*
- * Return value: %TRUE if this book is writable, otherwise %FALSE.
+ * Returns: %TRUE if this book is writable, otherwise %FALSE.
*/
gboolean
e_book_is_writable (EBook *book)
@@ -1921,7 +1921,7 @@ e_book_is_writable (EBook *book)
*
* Check if this book is connected.
*
- * Return value: %TRUE if this book is connected, otherwise %FALSE.
+ * Returns: %TRUE if this book is connected, otherwise %FALSE.
**/
gboolean
e_book_is_online (EBook *book)
@@ -1979,7 +1979,7 @@ make_me_card (void)
* Get the #EContact referring to the user of the address book
* and set it in @contact and @book.
*
- * Return value: %TRUE if successful, otherwise %FALSE.
+ * Returns: %TRUE if successful, otherwise %FALSE.
**/
gboolean
e_book_get_self (EContact **contact, EBook **book, GError **error)
@@ -2046,7 +2046,7 @@ e_book_get_self (EContact **contact, EBook **book, GError **error)
* Specify that @contact residing in @book is the #EContact that
* refers to the user of the address book.
*
- * Return value: %TRUE if successful, %FALSE otherwise.
+ * Returns: %TRUE if successful, %FALSE otherwise.
**/
gboolean
e_book_set_self (EBook *book, EContact *contact, GError **error)
@@ -2069,7 +2069,7 @@ e_book_set_self (EBook *book, EContact *contact, GError **error)
*
* Check if @contact is the user of the address book.
*
- * Return value: %TRUE if @contact is the user, %FALSE otherwise.
+ * Returns: %TRUE if @contact is the user, %FALSE otherwise.
**/
gboolean
e_book_is_self (EContact *contact)
@@ -2101,7 +2101,7 @@ e_book_is_self (EContact *contact)
* sets the #ESource of the #EBook as the "default" addressbook. This is the source
* that will be loaded in the e_book_get_default_addressbook call.
*
- * Return value: %TRUE if the setting was stored in libebook's ESourceList, otherwise %FALSE.
+ * Returns: %TRUE if the setting was stored in libebook's ESourceList, otherwise %FALSE.
*/
gboolean
e_book_set_default_addressbook (EBook *book, GError **error)
@@ -2124,7 +2124,7 @@ e_book_set_default_addressbook (EBook *book, GError **error)
* sets @source as the "default" addressbook. This is the source that
* will be loaded in the e_book_get_default_addressbook call.
*
- * Return value: %TRUE if the setting was stored in libebook's ESourceList, otherwise %FALSE.
+ * Returns: %TRUE if the setting was stored in libebook's ESourceList, otherwise %FALSE.
*/
gboolean
e_book_set_default_source (ESource *source, GError **error)
@@ -2189,7 +2189,7 @@ e_book_set_default_source (ESource *source, GError **error)
* Populate *addressbook_sources with the list of all sources which have been
* added to Evolution.
*
- * Return value: %TRUE if @addressbook_sources was set, otherwise %FALSE.
+ * Returns: %TRUE if @addressbook_sources was set, otherwise %FALSE.
*/
gboolean
e_book_get_addressbooks (ESourceList **addressbook_sources, GError **error)
@@ -2214,7 +2214,7 @@ e_book_get_addressbooks (ESourceList **addressbook_sources, GError **error)
* only two operations that are valid on this book at this point:
* e_book_open(), and e_book_remove().
*
- * Return value: a new but unopened #EBook.
+ * Returns: a new but unopened #EBook.
*/
EBook*
e_book_new (ESource *source, GError **error)
@@ -2337,7 +2337,7 @@ check_uri (ESource *source, gpointer uri)
* Creates a new #EBook corresponding to the given uri. See the
* documentation for e_book_new for further information.
*
- * Return value: a new but unopened #EBook.
+ * Returns: a new but unopened #EBook.
*/
EBook*
e_book_new_from_uri (const gchar *uri, GError **error)
@@ -2401,7 +2401,7 @@ check_system (ESource *source, gpointer data)
* addressbook. See the documentation for e_book_new for further
* information.
*
- * Return value: a new but unopened #EBook.
+ * Returns: a new but unopened #EBook.
*/
EBook*
e_book_new_system_addressbook (GError **error)
@@ -2468,7 +2468,7 @@ check_default (ESource *source, gpointer data)
* addressbook. See the documentation for e_book_new for further
* information.
*
- * Return value: a new but unopened #EBook.
+ * Returns: a new but unopened #EBook.
*/
EBook*
e_book_new_default_addressbook (GError **error)
diff --git a/addressbook/libebook/e-contact.c b/addressbook/libebook/e-contact.c
index 8eee63e..049f792 100644
--- a/addressbook/libebook/e-contact.c
+++ b/addressbook/libebook/e-contact.c
@@ -1195,7 +1195,7 @@ e_contact_get_property (GObject *object,
*
* Creates a new, blank #EContact.
*
- * Return value: A new #EContact.
+ * Returns: A new #EContact.
**/
EContact*
e_contact_new (void)
@@ -1209,7 +1209,7 @@ e_contact_new (void)
*
* Creates a new #EContact based on a vcard.
*
- * Return value: A new #EContact.
+ * Returns: A new #EContact.
**/
EContact*
e_contact_new_from_vcard (const gchar *vcard)
@@ -1267,7 +1267,7 @@ e_contact_new_from_vcard (const gchar *vcard)
*
* Creates a copy of @contact.
*
- * Return value: A new #EContact identical to @contact.
+ * Returns: A new #EContact identical to @contact.
**/
EContact*
e_contact_duplicate (EContact *contact)
@@ -1290,7 +1290,7 @@ e_contact_duplicate (EContact *contact)
*
* Gets the string representation of @field_id.
*
- * Return value: The string representation of @field_id, or %NULL if it doesn't exist.
+ * Returns: The string representation of @field_id, or %NULL if it doesn't exist.
**/
const gchar *
e_contact_field_name (EContactField field_id)
@@ -1307,7 +1307,7 @@ e_contact_field_name (EContactField field_id)
* Gets a human-readable, translated string representation
* of @field_id.
*
- * Return value: The human-readable representation of @field_id, or %NULL if it doesn't exist.
+ * Returns: The human-readable representation of @field_id, or %NULL if it doesn't exist.
**/
const gchar *
e_contact_pretty_name (EContactField field_id)
@@ -1328,7 +1328,7 @@ e_contact_pretty_name (EContactField field_id)
*
* Gets the vcard attribute corresponding to @field_id, as a string.
*
- * Return value: The vcard attribute corresponding to @field_id, or %NULL if it doesn't exist.
+ * Returns: The vcard attribute corresponding to @field_id, or %NULL if it doesn't exist.
**/
const gchar *
e_contact_vcard_attribute (EContactField field_id)
@@ -1344,7 +1344,7 @@ e_contact_vcard_attribute (EContactField field_id)
*
* Gets the #EContactField corresponding to the @field_name.
*
- * Return value: 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)
@@ -1365,7 +1365,7 @@ e_contact_field_id (const gchar *field_name)
*
* Gets the #EContactField corresponding to the @vcard_field.
*
- * Return value: 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
**/
@@ -1394,7 +1394,7 @@ e_contact_field_id_from_vcard (const gchar *vcard_field)
*
* Gets the value of @contact's field specified by @field_id.
*
- * Return value: Depends on the field's type, owned by the caller.
+ * Returns: Depends on the field's type, owned by the caller.
**/
gpointer
e_contact_get (EContact *contact, EContactField field_id)
@@ -1580,7 +1580,7 @@ e_contact_get (EContact *contact, EContactField field_id)
* Gets the value of @contact's field specified by @field_id, caching
* the result so it can be freed later.
*
- * Return value: Depends on the field's type, owned by the #EContact.
+ * Returns: Depends on the field's type, owned by the #EContact.
**/
gconstpointer
e_contact_get_const (EContact *contact, EContactField field_id)
@@ -1633,7 +1633,7 @@ e_contact_set (EContact *contact, EContactField field_id, gconstpointer value)
*
* Gets a list of the vcard attributes for @contact's @field_id.
*
- * Return value: A #GList of pointers to #EVCardAttribute, owned by the caller.
+ * Returns: A #GList of pointers to #EVCardAttribute, owned by the caller.
**/
GList*
e_contact_get_attributes (EContact *contact, EContactField field_id)
@@ -1694,7 +1694,7 @@ e_contact_set_attributes (EContact *contact, EContactField field_id, GList *attr
*
* Creates a new #EContactName struct.
*
- * Return value: A new #EContactName struct.
+ * Returns: A new #EContactName struct.
**/
EContactName*
e_contact_name_new (void)
@@ -1708,7 +1708,7 @@ e_contact_name_new (void)
*
* Generates a string representation of @name.
*
- * Return value: The string representation of @name.
+ * Returns: The string representation of @name.
**/
gchar *
e_contact_name_to_string(const EContactName *name)
@@ -1737,7 +1737,7 @@ e_contact_name_to_string(const EContactName *name)
*
* Creates a new #EContactName based on the parsed @name_str.
*
- * Return value: A new #EContactName struct.
+ * Returns: A new #EContactName struct.
**/
EContactName*
e_contact_name_from_string (const gchar *name_str)
@@ -1766,7 +1766,7 @@ e_contact_name_from_string (const gchar *name_str)
*
* Creates a copy of @n.
*
- * Return value: A new #EContactName identical to @n.
+ * Returns: A new #EContactName identical to @n.
**/
EContactName*
e_contact_name_copy (EContactName *n)
@@ -1834,7 +1834,7 @@ E_CONTACT_DEFINE_BOXED_TYPE (e_contact_name, "EContactName")
*
* Creates a new #EContactDate based on @str.
*
- * Return value: A new #EContactDate struct.
+ * Returns: A new #EContactDate struct.
**/
EContactDate*
e_contact_date_from_string (const gchar *str)
@@ -1872,7 +1872,7 @@ e_contact_date_from_string (const gchar *str)
* Generates a date string in the format YYYY-MM-DD based
* on the values of @dt.
*
- * Return value: A date string, owned by the caller.
+ * Returns: A date string, owned by the caller.
**/
gchar *
e_contact_date_to_string (EContactDate *dt)
@@ -1893,7 +1893,7 @@ e_contact_date_to_string (EContactDate *dt)
*
* Checks if @dt1 and @dt2 are the same date.
*
- * Return value: %TRUE if @dt1 and @dt2 are equal, %FALSE otherwise.
+ * Returns: %TRUE if @dt1 and @dt2 are equal, %FALSE otherwise.
**/
gboolean
e_contact_date_equal (EContactDate *dt1, EContactDate *dt2)
@@ -1912,7 +1912,7 @@ e_contact_date_equal (EContactDate *dt1, EContactDate *dt2)
*
* Creates a copy of @dt.
*
- * Return value: A new #EContactDate struct identical to @dt.
+ * Returns: A new #EContactDate struct identical to @dt.
**/
static EContactDate *
e_contact_date_copy (EContactDate *dt)
@@ -1944,7 +1944,7 @@ E_CONTACT_DEFINE_BOXED_TYPE (e_contact_date, "EContactDate")
*
* Creates a new #EContactDate struct.
*
- * Return value: A new #EContactDate struct.
+ * Returns: A new #EContactDate struct.
**/
EContactDate*
e_contact_date_new (void)
@@ -1986,7 +1986,7 @@ e_contact_photo_free (EContactPhoto *photo)
*
* Creates a copy of @photo.
*
- * Return value: A new #EContactPhoto struct identical to @photo.
+ * Returns: A new #EContactPhoto struct identical to @photo.
**/
static EContactPhoto *
e_contact_photo_copy (EContactPhoto *photo)
diff --git a/addressbook/libebook/e-destination.c b/addressbook/libebook/e-destination.c
index ffe2572..6ed9870 100644
--- a/addressbook/libebook/e-destination.c
+++ b/addressbook/libebook/e-destination.c
@@ -164,7 +164,7 @@ e_destination_init (EDestination *dest)
*
* Creates a new #EDestination with blank values.
*
- * Return value: A newly created #EDestination.
+ * Returns: A newly created #EDestination.
**/
EDestination *
e_destination_new (void)
@@ -178,7 +178,7 @@ e_destination_new (void)
*
* Creates a new #EDestination identical to @dest.
*
- * Return value: A newly created #EDestination, identical to @dest.
+ * Returns: A newly created #EDestination, identical to @dest.
*/
EDestination*
e_destination_copy (const EDestination *dest)
@@ -272,7 +272,7 @@ nonempty (const gchar *s)
*
* Checks if @dest is blank.
*
- * Return value: %TRUE if @dest is empty, %FALSE otherwise.
+ * Returns: %TRUE if @dest is empty, %FALSE otherwise.
*/
gboolean
e_destination_empty (const EDestination *dest)
@@ -301,7 +301,7 @@ e_destination_empty (const EDestination *dest)
*
* Checks if @a and @b are equal.
*
- * Return value: %TRUE if the destinations are equal, %FALSE otherwise.
+ * Returns: %TRUE if the destinations are equal, %FALSE otherwise.
**/
gboolean
e_destination_equal (const EDestination *a, const EDestination *b)
@@ -608,7 +608,7 @@ e_destination_from_contact (const EDestination *dest)
* it was not explicitly specified by the user. This can be used
* to hide it from some UI elements.
*
- * Return value: %TRUE if destination is an auto recipient, %FALSE otherwise.
+ * Returns: %TRUE if destination is an auto recipient, %FALSE otherwise.
**/
gboolean
e_destination_is_auto_recipient (const EDestination *dest)
@@ -643,7 +643,7 @@ e_destination_set_auto_recipient (EDestination *dest, gboolean value)
*
* Gets the contact @dest is pointing to, if any.
*
- * Return value: An #EContact, or %NULL if none was set.
+ * Returns: An #EContact, or %NULL if none was set.
**/
EContact *
e_destination_get_contact (const EDestination *dest)
@@ -659,7 +659,7 @@ e_destination_get_contact (const EDestination *dest)
*
* Gets the unique contact ID @dest is pointing to, if any.
*
- * Return value: A unique contact ID, or %NULL if none was set.
+ * Returns: A unique contact ID, or %NULL if none was set.
*/
const gchar *
e_destination_get_contact_uid (const EDestination *dest)
@@ -676,7 +676,7 @@ e_destination_get_contact_uid (const EDestination *dest)
* Gets the unique source ID @dest is pointing to, if any. The source
* ID specifies which address book @dest's contact came from.
*
- * Return value: A unique source ID, or %NULL if none was set.
+ * Returns: A unique source ID, or %NULL if none was set.
*/
const gchar *
e_destination_get_source_uid (const EDestination *dest)
@@ -693,7 +693,7 @@ e_destination_get_source_uid (const EDestination *dest)
* Gets the index of the e-mail address of the contact that
* @dest is pointing to, if any.
*
- * Return value: The e-mail index, or -1 if none was set.
+ * Returns: The e-mail index, or -1 if none was set.
**/
gint
e_destination_get_email_num (const EDestination *dest)
@@ -713,7 +713,7 @@ e_destination_get_email_num (const EDestination *dest)
* Gets the full name of @dest's addressee, or if the addressee is
* a contact list, the name the list was filed under.
*
- * Return value: The full name of the addressee, or %NULL if none was set.
+ * Returns: The full name of the addressee, or %NULL if none was set.
**/
const gchar *
e_destination_get_name (const EDestination *dest)
@@ -764,7 +764,7 @@ e_destination_get_name (const EDestination *dest)
*
* Check if @dest is to be ignored.
*
- * Return value: #TRUE if this destination should be ignored, else #FALSE.
+ * Returns: #TRUE if this destination should be ignored, else #FALSE.
*/
gboolean
e_destination_is_ignored (const EDestination *dest)
@@ -791,7 +791,7 @@ e_destination_set_ignored (EDestination *dest, gboolean ignored)
*
* Gets the e-mail address of @dest's addressee.
*
- * Return value: An e-mail address, or an empty string if none was set.
+ * Returns: An e-mail address, or an empty string if none was set.
**/
const gchar *
e_destination_get_email (const EDestination *dest)
@@ -845,7 +845,7 @@ e_destination_get_email (const EDestination *dest)
* Gets the formatted name and e-mail address, or in the case of
* lists, the formatted list of e-mail addresses, from @dest.
*
- * Return value: A formatted destination string, or %NULL if the destination was empty.
+ * Returns: A formatted destination string, or %NULL if the destination was empty.
**/
const gchar *
e_destination_get_address (const EDestination *dest)
@@ -940,7 +940,7 @@ e_destination_set_raw (EDestination *dest, const gchar *raw)
* Generates a textual representation of @dest, suitable for referring
* to the destination during user interaction.
*
- * Return value: A textual representation of the destination.
+ * Returns: A textual representation of the destination.
**/
const gchar *
e_destination_get_textrep (const EDestination *dest, gboolean include_email)
@@ -983,7 +983,7 @@ e_destination_get_textrep (const EDestination *dest, gboolean include_email)
*
* Checks if @dest is a list of addresses.
*
- * Return value: %TRUE if destination is a list, %FALSE if it is an individual.
+ * Returns: %TRUE if destination is a list, %FALSE if it is an individual.
**/
gboolean
e_destination_is_evolution_list (const EDestination *dest)
@@ -1000,7 +1000,7 @@ e_destination_is_evolution_list (const EDestination *dest)
* If @dest is a list, checks if the addresses in the list
* should be presented to the user during interaction.
*
- * Return value: %TRUE if addresses should be shown, %FALSE otherwise.
+ * Returns: %TRUE if addresses should be shown, %FALSE otherwise.
**/
gboolean
e_destination_list_show_addresses (const EDestination *dest)
@@ -1020,7 +1020,7 @@ e_destination_list_show_addresses (const EDestination *dest)
* If @dest is a list, gets the list of destinations. The list
* and its elements belong to @dest, and should not be freed.
*
- * Return value: A list of elements of type #EDestination, or %NULL.
+ * Returns: A list of elements of type #EDestination, or %NULL.
**/
const GList *
e_destination_list_get_dests (const EDestination *dest)
@@ -1039,7 +1039,7 @@ e_destination_list_get_dests (const EDestination *dest)
*
* Check if @dest wants to get mail formatted as HTML.
*
- * Return value: %TRUE if destination wants HTML, %FALSE if not.
+ * Returns: %TRUE if destination wants HTML, %FALSE if not.
**/
gboolean
e_destination_get_html_mail_pref (const EDestination *dest)
@@ -1083,7 +1083,7 @@ e_destination_set_html_mail_pref (EDestination *dest, gboolean flag)
* Generates a joint text representation of all the #EDestination
* elements in @destv.
*
- * Return value: The text representation of @destv.
+ * Returns: The text representation of @destv.
**/
gchar *
e_destination_get_textrepv (EDestination **destv)
@@ -1127,7 +1127,7 @@ e_destination_get_textrepv (EDestination **destv)
*
* Generates an XML tree from @dest.
*
- * Return value: Pointer to the root node of the XML tree.
+ * Returns: Pointer to the root node of the XML tree.
**/
static xmlNodePtr
e_destination_xml_encode (const EDestination *dest)
@@ -1210,7 +1210,7 @@ e_destination_xml_encode (const EDestination *dest)
* Initializes @dest based on the information encoded in the
* XML tree under @node.
*
- * Return value: %TRUE if the XML tree was well-formed, %FALSE otherwise.
+ * Returns: %TRUE if the XML tree was well-formed, %FALSE otherwise.
**/
static gboolean
e_destination_xml_decode (EDestination *dest, xmlNodePtr node)
@@ -1387,7 +1387,7 @@ null_terminate_and_remove_extra_whitespace (xmlChar *xml_in, gint size)
*
* Exports a destination to an XML document.
*
- * Return value: An XML string, allocated with g_malloc.
+ * Returns: An XML string, allocated with g_malloc.
**/
gchar *
e_destination_export (const EDestination *dest)
@@ -1422,7 +1422,7 @@ e_destination_export (const EDestination *dest)
*
* Creates an #EDestination from an XML document.
*
- * Return value: An #EDestination, or %NULL if the document was not well-formed.
+ * Returns: An #EDestination, or %NULL if the document was not well-formed.
**/
EDestination *
e_destination_import (const gchar *str)
@@ -1452,7 +1452,7 @@ e_destination_import (const gchar *str)
*
* Exports multiple #EDestination elements to a single XML document.
*
- * Return value: An XML string, allocated with g_malloc.
+ * Returns: An XML string, allocated with g_malloc.
**/
gchar *
e_destination_exportv (EDestination **destv)
@@ -1494,7 +1494,7 @@ e_destination_exportv (EDestination **destv)
* Creates an array of pointers to #EDestination elements
* from an XML document.
*
- * Return value: A %NULL-terminated array of pointers to #EDestination elements.
+ * Returns: A %NULL-terminated array of pointers to #EDestination elements.
**/
EDestination **
e_destination_importv (const gchar *str)
diff --git a/addressbook/libebook/e-name-western.c b/addressbook/libebook/e-name-western.c
index e24155f..2c063a0 100644
--- a/addressbook/libebook/e-name-western.c
+++ b/addressbook/libebook/e-name-western.c
@@ -929,7 +929,7 @@ e_name_western_fixup (ENameWestern *name, ENameWesternIdxs *idxs)
* Parses @full_name and returns an #ENameWestern struct filled with
* the component parts of the name.
*
- * Return value: A new #ENameWestern struct.
+ * Returns: A new #ENameWestern struct.
**/
ENameWestern *
e_name_western_parse (const gchar *full_name)
diff --git a/addressbook/libebook/e-vcard.c b/addressbook/libebook/e-vcard.c
index fedea5e..110ef6c 100644
--- a/addressbook/libebook/e-vcard.c
+++ b/addressbook/libebook/e-vcard.c
@@ -659,7 +659,7 @@ parse (EVCard *evc, const gchar *str)
*
* Escapes a string according to RFC2426, section 5.
*
- * Return value: A newly allocated, escaped string.
+ * Returns: A newly allocated, escaped string.
**/
gchar *
e_vcard_escape_string (const gchar *s)
@@ -704,7 +704,7 @@ e_vcard_escape_string (const gchar *s)
*
* Unescapes a string according to RFC2426, section 5.
*
- * Return value: A newly allocated, unescaped string.
+ * Returns: A newly allocated, unescaped string.
**/
gchar *
e_vcard_unescape_string (const gchar *s)
@@ -757,7 +757,7 @@ e_vcard_construct (EVCard *evc, const gchar *str)
*
* Creates a new, blank #EVCard.
*
- * Return value: A new, blank #EVCard.
+ * Returns: A new, blank #EVCard.
**/
EVCard *
e_vcard_new (void)
@@ -772,7 +772,7 @@ e_vcard_new (void)
* Creates a new #EVCard from the passed-in string
* representation.
*
- * Return value: A new #EVCard.
+ * Returns: A new #EVCard.
**/
EVCard *
e_vcard_new_from_string (const gchar *str)
@@ -943,7 +943,7 @@ e_vcard_to_string_vcard_30 (EVCard *evc)
* Exports @evc to a string representation, specified
* by the @format argument.
*
- * Return value: A newly allocated string representing the vcard.
+ * Returns: A newly allocated string representing the vcard.
**/
gchar *
e_vcard_to_string (EVCard *evc, EVCardFormat format)
@@ -1015,7 +1015,7 @@ e_vcard_dump_structure (EVCard *evc)
* Creates a new #EVCardAttribute with the specified group and
* attribute names.
*
- * Return value: A new #EVCardAttribute.
+ * Returns: A new #EVCardAttribute.
**/
EVCardAttribute*
e_vcard_attribute_new (const gchar *attr_group, const gchar *attr_name)
@@ -1057,7 +1057,7 @@ e_vcard_attribute_free (EVCardAttribute *attr)
*
* Makes a copy of @attr.
*
- * Return value: A new #EVCardAttribute identical to @attr.
+ * Returns: A new #EVCardAttribute identical to @attr.
**/
EVCardAttribute*
e_vcard_attribute_copy (EVCardAttribute *attr)
@@ -1381,7 +1381,7 @@ e_vcard_attribute_remove_params (EVCardAttribute *attr)
*
* Creates a new parameter named @name.
*
- * Return value: A new #EVCardAttributeParam.
+ * Returns: A new #EVCardAttributeParam.
**/
EVCardAttributeParam*
e_vcard_attribute_param_new (const gchar *name)
@@ -1417,7 +1417,7 @@ e_vcard_attribute_param_free (EVCardAttributeParam *param)
*
* Makes a copy of @param.
*
- * Return value: a new #EVCardAttributeParam identical to @param.
+ * Returns: a new #EVCardAttributeParam identical to @param.
**/
EVCardAttributeParam*
e_vcard_attribute_param_copy (EVCardAttributeParam *param)
@@ -1688,7 +1688,7 @@ e_vcard_attribute_remove_param_value (EVCardAttribute *attr, const gchar *param_
* Gets the list of attributes from @evcard. The list and its
* contents are owned by @evcard, and must not be freed.
*
- * Return value: A list of attributes of type #EVCardAttribute.
+ * Returns: A list of attributes of type #EVCardAttribute.
**/
GList*
e_vcard_get_attributes (EVCard *evcard)
@@ -1707,7 +1707,7 @@ e_vcard_get_attributes (EVCard *evcard)
* @evcard and should not be freed. If the attribute does not exist, #NULL is
* returned.
*
- * Return value: An #EVCardAttribute if found, or #NULL.
+ * Returns: An #EVCardAttribute if found, or #NULL.
**/
EVCardAttribute *
e_vcard_get_attribute (EVCard *evc,
@@ -1735,7 +1735,7 @@ e_vcard_get_attribute (EVCard *evc,
*
* Gets the group name of @attr.
*
- * Return value: The attribute's group name.
+ * Returns: The attribute's group name.
**/
const gchar *
e_vcard_attribute_get_group (EVCardAttribute *attr)
@@ -1751,7 +1751,7 @@ e_vcard_attribute_get_group (EVCardAttribute *attr)
*
* Gets the name of @attr.
*
- * Return value: The attribute's name.
+ * Returns: The attribute's name.
**/
const gchar *
e_vcard_attribute_get_name (EVCardAttribute *attr)
@@ -1768,7 +1768,7 @@ e_vcard_attribute_get_name (EVCardAttribute *attr)
* Gets the list of values from @attr. The list and its
* contents are owned by @attr, and must not be freed.
*
- * Return value: A list of string values.
+ * Returns: A list of string values.
**/
GList*
e_vcard_attribute_get_values (EVCardAttribute *attr)
@@ -1786,7 +1786,7 @@ e_vcard_attribute_get_values (EVCardAttribute *attr)
* necessary. The list and its contents are owned by @attr,
* and must not be freed.
*
- * Return value: A list of values of type #GString.
+ * Returns: A list of values of type #GString.
**/
GList*
e_vcard_attribute_get_values_decoded (EVCardAttribute *attr)
@@ -1827,7 +1827,7 @@ e_vcard_attribute_get_values_decoded (EVCardAttribute *attr)
*
* Checks if @attr has a single value.
*
- * Return value: %TRUE if the attribute has exactly one value, %FALSE otherwise.
+ * Returns: %TRUE if the attribute has exactly one value, %FALSE otherwise.
**/
gboolean
e_vcard_attribute_is_single_valued (EVCardAttribute *attr)
@@ -1847,7 +1847,7 @@ e_vcard_attribute_is_single_valued (EVCardAttribute *attr)
*
* Gets the value of a single-valued #EVCardAttribute, @attr.
*
- * Return value: A newly allocated string representing the value.
+ * Returns: A newly allocated string representing the value.
**/
gchar *
e_vcard_attribute_get_value (EVCardAttribute *attr)
@@ -1873,7 +1873,7 @@ e_vcard_attribute_get_value (EVCardAttribute *attr)
*
* Note: this function seems currently to be unused. Could be removed.
*
- * Return value: A newly allocated #GString representing the value.
+ * Returns: A newly allocated #GString representing the value.
**/
GString*
e_vcard_attribute_get_value_decoded (EVCardAttribute *attr)
@@ -1901,7 +1901,7 @@ e_vcard_attribute_get_value_decoded (EVCardAttribute *attr)
*
* Checks if @attr has an #EVCardAttributeParam of the specified type.
*
- * Return value: %TRUE if such a parameter exists, %FALSE otherwise.
+ * Returns: %TRUE if such a parameter exists, %FALSE otherwise.
**/
gboolean
e_vcard_attribute_has_type (EVCardAttribute *attr, const gchar *typestr)
@@ -1938,7 +1938,7 @@ e_vcard_attribute_has_type (EVCardAttribute *attr, const gchar *typestr)
* Gets the list of parameters from @attr. The list and its
* contents are owned by @attr, and must not be freed.
*
- * Return value: A list of elements of type #EVCardAttributeParam.
+ * Returns: A list of elements of type #EVCardAttributeParam.
**/
GList*
e_vcard_attribute_get_params (EVCardAttribute *attr)
@@ -1956,7 +1956,7 @@ e_vcard_attribute_get_params (EVCardAttribute *attr)
* Gets the list of values for the paramater @name from @attr. The list and its
* contents are owned by @attr, and must not be freed.
*
- * Return value: A list of string elements representing the parameter's values.
+ * Returns: A list of string elements representing the parameter's values.
**/
GList *
e_vcard_attribute_get_param (EVCardAttribute *attr, const gchar *name)
@@ -1984,7 +1984,7 @@ e_vcard_attribute_get_param (EVCardAttribute *attr, const gchar *name)
*
* Gets the name of @param.
*
- * Return value: The name of the parameter.
+ * Returns: The name of the parameter.
**/
const gchar *
e_vcard_attribute_param_get_name (EVCardAttributeParam *param)
@@ -2001,7 +2001,7 @@ e_vcard_attribute_param_get_name (EVCardAttributeParam *param)
* Gets the list of values from @param. The list and its
* contents are owned by @param, and must not be freed.
*
- * Return value: A list of string elements representing the parameter's values.
+ * Returns: A list of string elements representing the parameter's values.
**/
GList*
e_vcard_attribute_param_get_values (EVCardAttributeParam *param)
diff --git a/addressbook/libedata-book/e-book-backend-cache.c b/addressbook/libedata-book/e-book-backend-cache.c
index 31a22a8..54df53a 100644
--- a/addressbook/libedata-book/e-book-backend-cache.c
+++ b/addressbook/libedata-book/e-book-backend-cache.c
@@ -198,7 +198,7 @@ e_book_backend_cache_init (EBookBackendCache *cache)
* Creates a new #EBookBackendCache object, which implements a local
* cache of #EContact objects, useful for remote backends.
*
- * Return value: A new #EBookBackendCache.
+ * Returns: A new #EBookBackendCache.
*/
EBookBackendCache *
e_book_backend_cache_new (const gchar *uri)
@@ -219,7 +219,7 @@ e_book_backend_cache_new (const gchar *uri)
* newly created, and must be unreffed by the caller when no longer
* needed.
*
- * Return value: A cached #EContact, or %NULL if @uid is not cached.
+ * Returns: A cached #EContact, or %NULL if @uid is not cached.
**/
EContact *
e_book_backend_cache_get_contact (EBookBackendCache *cache, const gchar *uid)
@@ -246,7 +246,7 @@ e_book_backend_cache_get_contact (EBookBackendCache *cache, const gchar *uid)
*
* Adds @contact to @cache.
*
- * Return value: %TRUE if the contact was cached successfully, %FALSE otherwise.
+ * Returns: %TRUE if the contact was cached successfully, %FALSE otherwise.
**/
gboolean
e_book_backend_cache_add_contact (EBookBackendCache *cache,
@@ -281,7 +281,7 @@ e_book_backend_cache_add_contact (EBookBackendCache *cache,
*
* Removes the contact identified by @uid from @cache.
*
- * Return value: %TRUE if the contact was found and removed, %FALSE otherwise.
+ * Returns: %TRUE if the contact was found and removed, %FALSE otherwise.
**/
gboolean
e_book_backend_cache_remove_contact (EBookBackendCache *cache,
@@ -312,7 +312,7 @@ e_book_backend_cache_remove_contact (EBookBackendCache *cache,
*
* Checks if the contact identified by @uid exists in @cache.
*
- * Return value: %TRUE if the cache contains the contact, %FALSE otherwise.
+ * Returns: %TRUE if the cache contains the contact, %FALSE otherwise.
**/
gboolean
e_book_backend_cache_check_contact (EBookBackendCache *cache, const gchar *uid)
@@ -341,7 +341,7 @@ e_book_backend_cache_check_contact (EBookBackendCache *cache, const gchar *uid)
* When done with the list, the caller must unref the contacts and
* free the list.
*
- * Return value: A #GList of pointers to #EContact.
+ * Returns: A #GList of pointers to #EContact.
**/
GList *
e_book_backend_cache_get_contacts (EBookBackendCache *cache, const gchar *query)
@@ -391,7 +391,7 @@ e_book_backend_cache_get_contacts (EBookBackendCache *cache, const gchar *query)
* in @cache matching @query. When done with the array, the caller must
* free the ID strings and the array.
*
- * Return value: A #GPtrArray of pointers to contact ID strings.
+ * Returns: A #GPtrArray of pointers to contact ID strings.
**/
GPtrArray *
e_book_backend_cache_search (EBookBackendCache *cache, const gchar *query)
@@ -418,7 +418,7 @@ e_book_backend_cache_search (EBookBackendCache *cache, const gchar *query)
*
* Checks if an #EBookBackendCache exists at @uri.
*
- * Return value: %TRUE if cache exists, %FALSE if not.
+ * Returns: %TRUE if cache exists, %FALSE if not.
**/
gboolean
e_book_backend_cache_exists (const gchar *uri)
@@ -456,7 +456,7 @@ e_book_backend_cache_set_populated (EBookBackendCache *cache)
*
* Checks if @cache is populated.
*
- * Return value: %TRUE if @cache is populated, %FALSE otherwise.
+ * Returns: %TRUE if @cache is populated, %FALSE otherwise.
**/
gboolean
e_book_backend_cache_is_populated (EBookBackendCache *cache)
diff --git a/addressbook/libedata-book/e-book-backend-db-cache.c b/addressbook/libedata-book/e-book-backend-db-cache.c
index 922b308..28c2caf 100644
--- a/addressbook/libedata-book/e-book-backend-db-cache.c
+++ b/addressbook/libedata-book/e-book-backend-db-cache.c
@@ -126,7 +126,7 @@ e_book_backend_db_cache_get_filename(DB *db)
* newly created, and must be unreffed by the caller when no longer
* needed.
*
- * Return value: A cached #EContact, or %NULL if @uid is not cached.
+ * Returns: A cached #EContact, or %NULL if @uid is not cached.
**/
EContact *
e_book_backend_db_cache_get_contact (DB *db, const gchar *uid)
@@ -159,7 +159,7 @@ e_book_backend_db_cache_get_contact (DB *db, const gchar *uid)
*
* Adds @contact to @cache.
*
- * Return value: %TRUE if the contact was cached successfully, %FALSE otherwise.
+ * Returns: %TRUE if the contact was cached successfully, %FALSE otherwise.
**/
gboolean
e_book_backend_db_cache_add_contact (DB *db,
@@ -203,7 +203,7 @@ e_book_backend_db_cache_add_contact (DB *db,
*
* Removes the contact identified by @uid from @cache.
*
- * Return value: %TRUE if the contact was found and removed, %FALSE otherwise.
+ * Returns: %TRUE if the contact was found and removed, %FALSE otherwise.
**/
gboolean
e_book_backend_db_cache_remove_contact (DB *db,
@@ -234,7 +234,7 @@ e_book_backend_db_cache_remove_contact (DB *db,
*
* Checks if the contact identified by @uid exists in @cache.
*
- * Return value: %TRUE if the cache contains the contact, %FALSE otherwise.
+ * Returns: %TRUE if the cache contains the contact, %FALSE otherwise.
**/
gboolean
e_book_backend_db_cache_check_contact (DB *db, const gchar *uid)
@@ -266,7 +266,7 @@ e_book_backend_db_cache_check_contact (DB *db, const gchar *uid)
* When done with the list, the caller must unref the contacts and
* free the list.
*
- * Return value: A #GList of pointers to #EContact.
+ * Returns: A #GList of pointers to #EContact.
**/
GList *
e_book_backend_db_cache_get_contacts (DB *db, const gchar *query)
@@ -327,7 +327,7 @@ e_book_backend_db_cache_get_contacts (DB *db, const gchar *query)
* in @cache matching @query. When done with the array, the caller must
* free the ID strings and the array.
*
- * Return value: A #GPtrArray of pointers to contact ID strings.
+ * Returns: A #GPtrArray of pointers to contact ID strings.
**/
GPtrArray *
e_book_backend_db_cache_search (DB *db, const gchar *query)
@@ -354,7 +354,7 @@ e_book_backend_db_cache_search (DB *db, const gchar *query)
*
* Checks if an #EBookBackendCache exists at @uri.
*
- * Return value: %TRUE if cache exists, %FALSE if not.
+ * Returns: %TRUE if cache exists, %FALSE if not.
**/
gboolean
e_book_backend_db_cache_exists (const gchar *uri)
@@ -399,7 +399,7 @@ e_book_backend_db_cache_set_populated (DB *db)
*
* Checks if @cache is populated.
*
- * Return value: %TRUE if @cache is populated, %FALSE otherwise.
+ * Returns: %TRUE if @cache is populated, %FALSE otherwise.
**/
gboolean
e_book_backend_db_cache_is_populated (DB *db)
diff --git a/addressbook/libedata-book/e-book-backend-factory.c b/addressbook/libedata-book/e-book-backend-factory.c
index b1f594f..2a1337d 100644
--- a/addressbook/libedata-book/e-book-backend-factory.c
+++ b/addressbook/libedata-book/e-book-backend-factory.c
@@ -33,7 +33,7 @@ e_book_backend_factory_class_init (EBookBackendFactoryClass *klass)
*
* Gets the protocol that @factory creates backends for.
*
- * Return value: A string representing a protocol.
+ * Returns: A string representing a protocol.
**/
const gchar *
e_book_backend_factory_get_protocol (EBookBackendFactory *factory)
@@ -49,7 +49,7 @@ e_book_backend_factory_get_protocol (EBookBackendFactory *factory)
*
* Creates a new #EBookBackend with @factory's protocol.
*
- * Return value: A new #EBookBackend.
+ * Returns: A new #EBookBackend.
**/
EBookBackend*
e_book_backend_factory_new_backend (EBookBackendFactory *factory)
diff --git a/addressbook/libedata-book/e-book-backend-sexp.c b/addressbook/libedata-book/e-book-backend-sexp.c
index e5e04ac..ab78282 100644
--- a/addressbook/libedata-book/e-book-backend-sexp.c
+++ b/addressbook/libedata-book/e-book-backend-sexp.c
@@ -803,7 +803,7 @@ static struct {
*
* Checks if @contact matches @sexp.
*
- * Return value: %TRUE if the contact matches, %FALSE otherwise.
+ * Returns: %TRUE if the contact matches, %FALSE otherwise.
**/
gboolean
e_book_backend_sexp_match_contact (EBookBackendSExp *sexp, EContact *contact)
@@ -836,7 +836,7 @@ e_book_backend_sexp_match_contact (EBookBackendSExp *sexp, EContact *contact)
*
* Checks if @vcard matches @sexp.
*
- * Return value: %TRUE if the VCard matches, %FALSE otherwise.
+ * Returns: %TRUE if the VCard matches, %FALSE otherwise.
**/
gboolean
e_book_backend_sexp_match_vcard (EBookBackendSExp *sexp, const gchar *vcard)
@@ -861,7 +861,7 @@ e_book_backend_sexp_match_vcard (EBookBackendSExp *sexp, const gchar *vcard)
*
* Creates a new #EBookBackendSExp from @text.
*
- * Return value: A new #EBookBackendSExp.
+ * Returns: A new #EBookBackendSExp.
**/
EBookBackendSExp *
e_book_backend_sexp_new (const gchar *text)
diff --git a/addressbook/libedata-book/e-book-backend-summary.c b/addressbook/libedata-book/e-book-backend-summary.c
index e8b0b0b..c9acc5c 100644
--- a/addressbook/libedata-book/e-book-backend-summary.c
+++ b/addressbook/libedata-book/e-book-backend-summary.c
@@ -156,7 +156,7 @@ clear_items (EBookBackendSummary *summary)
* specifies how much time should elapse, at a minimum, from
* the summary is changed until it is flushed to disk.
*
- * Return value: A new #EBookBackendSummary.
+ * Returns: A new #EBookBackendSummary.
**/
EBookBackendSummary*
e_book_backend_summary_new (const gchar *summary_path, gint flush_timeout_millis)
@@ -498,7 +498,7 @@ e_book_backend_summary_open (EBookBackendSummary *summary)
* the file was located, it was in the correct format, and it was
* not out of date.
*
- * Return value: %TRUE if the load succeeded, %FALSE if it failed.
+ * Returns: %TRUE if the load succeeded, %FALSE if it failed.
**/
gboolean
e_book_backend_summary_load (EBookBackendSummary *summary)
@@ -651,7 +651,7 @@ e_book_backend_summary_save_item (EBookBackendSummary *summary, FILE *fp, EBookB
*
* Attempts to save @summary to disk.
*
- * Return value: %TRUE if the save succeeded, %FALSE otherwise.
+ * Returns: %TRUE if the save succeeded, %FALSE otherwise.
**/
gboolean
e_book_backend_summary_save (EBookBackendSummary *summary)
@@ -826,7 +826,7 @@ e_book_backend_summary_remove_contact (EBookBackendSummary *summary, const gchar
* Checks if a summary of the contact identified by @id
* exists in @summary.
*
- * Return value: %TRUE if the summary exists, %FALSE otherwise.
+ * Returns: %TRUE if the summary exists, %FALSE otherwise.
**/
gboolean
e_book_backend_summary_check_contact (EBookBackendSummary *summary, const gchar *id)
@@ -887,7 +887,7 @@ e_book_backend_summary_touch (EBookBackendSummary *summary)
*
* Checks if @summary is more recent than @t.
*
- * Return value: %TRUE if the summary is up to date, %FALSE otherwise.
+ * Returns: %TRUE if the summary is up to date, %FALSE otherwise.
**/
gboolean
e_book_backend_summary_is_up_to_date (EBookBackendSummary *summary, time_t t)
@@ -950,7 +950,7 @@ static const struct {
* Checks if @query can be satisfied by searching only the fields
* stored by @summary.
*
- * Return value: %TRUE if the query can be satisfied, %FALSE otherwise.
+ * Returns: %TRUE if the query can be satisfied, %FALSE otherwise.
**/
gboolean
e_book_backend_summary_is_summary_query (EBookBackendSummary *summary, const gchar *query)
@@ -1175,7 +1175,7 @@ static const struct {
*
* Searches @summary for contacts matching @query.
*
- * Return value: A #GPtrArray of pointers to contact ID strings.
+ * Returns: A #GPtrArray of pointers to contact ID strings.
**/
GPtrArray*
e_book_backend_summary_search (EBookBackendSummary *summary, const gchar *query)
@@ -1233,7 +1233,7 @@ e_book_backend_summary_search (EBookBackendSummary *summary, const gchar *query)
* Constructs and returns a VCard from the contact summary specified
* by @id.
*
- * Return value: A new VCard, or %NULL if the contact summary didn't exist.
+ * Returns: A new VCard, or %NULL if the contact summary didn't exist.
**/
gchar *
e_book_backend_summary_get_summary_vcard(EBookBackendSummary *summary, const gchar *id)
diff --git a/addressbook/libedata-book/e-book-backend-sync.c b/addressbook/libedata-book/e-book-backend-sync.c
index 63ee65f..524b63c 100644
--- a/addressbook/libedata-book/e-book-backend-sync.c
+++ b/addressbook/libedata-book/e-book-backend-sync.c
@@ -26,7 +26,7 @@ static GObjectClass *parent_class;
*
* Does nothing.
*
- * Return value: %TRUE.
+ * Returns: %TRUE.
**/
gboolean
e_book_backend_sync_construct (EBookBackendSync *backend)
@@ -44,7 +44,7 @@ e_book_backend_sync_construct (EBookBackendSync *backend)
*
* Creates a new contact with the contents of @vcard in @backend.
*
- * Return value: An #EBookBackendSyncStatus indicating the outcome of the operation.
+ * Returns: An #EBookBackendSyncStatus indicating the outcome of the operation.
**/
EBookBackendSyncStatus
e_book_backend_sync_create_contact (EBookBackendSync *backend,
@@ -72,7 +72,7 @@ e_book_backend_sync_create_contact (EBookBackendSync *backend,
* Remove @book's database and storage overhead from the storage
* medium. This will delete all contacts in @book.
*
- * Return value: An #EBookBackendSyncStatus indicating the outcome of the operation.
+ * Returns: An #EBookBackendSyncStatus indicating the outcome of the operation.
**/
EBookBackendSyncStatus
e_book_backend_sync_remove (EBookBackendSync *backend,
@@ -99,7 +99,7 @@ e_book_backend_sync_remove (EBookBackendSync *backend,
* of removed contacts is in the same format as the passed-in list, and must be
* freed by the caller.
*
- * Return value: An #EBookBackendSyncStatus indicating the outcome of the operation.
+ * Returns: An #EBookBackendSyncStatus indicating the outcome of the operation.
**/
EBookBackendSyncStatus
e_book_backend_sync_remove_contacts (EBookBackendSync *backend,
@@ -129,7 +129,7 @@ e_book_backend_sync_remove_contacts (EBookBackendSync *backend,
* Modifies the contact specified by the ID embedded in @vcard, to
* reflect the full contents of @vcard.
*
- * Return value: An #EBookBackendSyncStatus indicating the outcome of the operation.
+ * Returns: An #EBookBackendSyncStatus indicating the outcome of the operation.
**/
EBookBackendSyncStatus
e_book_backend_sync_modify_contact (EBookBackendSync *backend,
@@ -158,7 +158,7 @@ e_book_backend_sync_modify_contact (EBookBackendSync *backend,
*
* Gets a contact from @book.
*
- * Return value: An #EBookBackendSyncStatus indicating the outcome of the operation.
+ * Returns: An #EBookBackendSyncStatus indicating the outcome of the operation.
**/
EBookBackendSyncStatus
e_book_backend_sync_get_contact (EBookBackendSync *backend,
@@ -188,7 +188,7 @@ e_book_backend_sync_get_contact (EBookBackendSync *backend,
* Gets a list of contacts from @book. The list and its elements must be freed
* by the caller.
*
- * Return value: An #EBookBackendSyncStatus indicating the outcome of the operation.
+ * Returns: An #EBookBackendSyncStatus indicating the outcome of the operation.
**/
EBookBackendSyncStatus
e_book_backend_sync_get_contact_list (EBookBackendSync *backend,
@@ -219,7 +219,7 @@ e_book_backend_sync_get_contact_list (EBookBackendSync *backend,
* The returned list will contain items of CORBA type
* #GNOME_Evolution_Addressbook_BookChangeItem.
*
- * Return value: An #EBookBackendSyncStatus indicating the outcome of the operation.
+ * Returns: An #EBookBackendSyncStatus indicating the outcome of the operation.
**/
EBookBackendSyncStatus
e_book_backend_sync_get_changes (EBookBackendSync *backend,
@@ -249,7 +249,7 @@ e_book_backend_sync_get_changes (EBookBackendSync *backend,
*
* Authenticates @user against @book.
*
- * Return value: An #EBookBackendSyncStatus indicating the outcome of the operation.
+ * Returns: An #EBookBackendSyncStatus indicating the outcome of the operation.
**/
EBookBackendSyncStatus
e_book_backend_sync_authenticate_user (EBookBackendSync *backend,
@@ -279,7 +279,7 @@ e_book_backend_sync_authenticate_user (EBookBackendSync *backend,
* fields are represented by strings from #e_contact_field_name. The list
* and its contents must be freed by the caller.
*
- * Return value: An #EBookBackendSyncStatus indicating the outcome of the operation.
+ * Returns: An #EBookBackendSyncStatus indicating the outcome of the operation.
**/
EBookBackendSyncStatus
e_book_backend_sync_get_required_fields (EBookBackendSync *backend,
@@ -307,7 +307,7 @@ e_book_backend_sync_get_required_fields (EBookBackendSync *backend,
* may not be stored. The fields are represented by strings from #e_contact_field_name.
* The list and its contents must be freed by the caller.
*
- * Return value: An #EBookBackendSyncStatus indicating the outcome of the operation.
+ * Returns: An #EBookBackendSyncStatus indicating the outcome of the operation.
**/
EBookBackendSyncStatus
e_book_backend_sync_get_supported_fields (EBookBackendSync *backend,
@@ -335,7 +335,7 @@ e_book_backend_sync_get_supported_fields (EBookBackendSync *backend,
* methods are represented by strings. The list and its contents must
* be freed by the caller.
*
- * Return value: An #EBookBackendSyncStatus indicating the outcome of the operation.
+ * Returns: An #EBookBackendSyncStatus indicating the outcome of the operation.
**/
EBookBackendSyncStatus
e_book_backend_sync_get_supported_auth_methods (EBookBackendSync *backend,
diff --git a/addressbook/libedata-book/e-book-backend.c b/addressbook/libedata-book/e-book-backend.c
index e4ae1e0..345efea 100644
--- a/addressbook/libedata-book/e-book-backend.c
+++ b/addressbook/libedata-book/e-book-backend.c
@@ -43,7 +43,7 @@ static GObjectClass *parent_class;
*
* Does nothing.
*
- * Return value: %TRUE.
+ * Returns: %TRUE.
**/
gboolean
e_book_backend_construct (EBookBackend *backend)
@@ -59,7 +59,7 @@ e_book_backend_construct (EBookBackend *backend)
*
* Loads @source into @backend.
*
- * Return value: A #GNOME_Evolution_Addressbook_CallStatus indicating the outcome.
+ * Returns: A #GNOME_Evolution_Addressbook_CallStatus indicating the outcome.
**/
GNOME_Evolution_Addressbook_CallStatus
e_book_backend_load_source (EBookBackend *backend,
@@ -90,7 +90,7 @@ e_book_backend_load_source (EBookBackend *backend,
*
* Queries the source that an addressbook backend is serving.
*
- * Return value: ESource for the backend.
+ * Returns: ESource for the backend.
**/
ESource *
e_book_backend_get_source (EBookBackend *backend)
@@ -457,7 +457,7 @@ e_book_backend_get_supported_auth_methods (EBookBackend *backend,
*
* Cancel @book's running operation on @backend.
*
- * Return value: A GNOME_Evolution_Addressbook_CallStatus indicating the outcome.
+ * Returns: A GNOME_Evolution_Addressbook_CallStatus indicating the outcome.
**/
GNOME_Evolution_Addressbook_CallStatus
e_book_backend_cancel_operation (EBookBackend *backend,
@@ -483,7 +483,7 @@ last_client_gone (EBookBackend *backend)
*
* Gets the list of #EDataBookView views running on this backend.
*
- * Return value: An #EList of #EDataBookView objects.
+ * Returns: An #EList of #EDataBookView objects.
**/
EList*
e_book_backend_get_book_views (EBookBackend *backend)
@@ -540,7 +540,7 @@ e_book_backend_remove_book_view (EBookBackend *backend,
*
* Adds a client to an addressbook backend.
*
- * Return value: TRUE on success, FALSE on failure to add the client.
+ * Returns: TRUE on success, FALSE on failure to add the client.
*/
gboolean
e_book_backend_add_client (EBookBackend *backend,
@@ -596,7 +596,7 @@ e_book_backend_remove_client (EBookBackend *backend,
*
* Checks if @backend has clients running in other system processes.
*
- * Return value: %TRUE if there are clients in other processes, %FALSE otherwise.
+ * Returns: %TRUE if there are clients in other processes, %FALSE otherwise.
**/
gboolean
e_book_backend_has_out_of_proc_clients (EBookBackend *backend)
@@ -610,7 +610,7 @@ e_book_backend_has_out_of_proc_clients (EBookBackend *backend)
*
* Gets the capabilities offered by this @backend.
*
- * Return value: A string listing the capabilities.
+ * Returns: A string listing the capabilities.
**/
gchar *
e_book_backend_get_static_capabilities (EBookBackend *backend)
@@ -629,7 +629,7 @@ e_book_backend_get_static_capabilities (EBookBackend *backend)
* Checks if @backend's storage has been opened and the backend
* itself is ready for accessing.
*
- * Return value: %TRUE if loaded, %FALSE otherwise.
+ * Returns: %TRUE if loaded, %FALSE otherwise.
**/
gboolean
e_book_backend_is_loaded (EBookBackend *backend)
@@ -661,7 +661,7 @@ e_book_backend_set_is_loaded (EBookBackend *backend, gboolean is_loaded)
*
* Checks if we can write to @backend.
*
- * Return value: %TRUE if writeable, %FALSE if not.
+ * Returns: %TRUE if writeable, %FALSE if not.
**/
gboolean
e_book_backend_is_writable (EBookBackend *backend)
@@ -693,7 +693,7 @@ e_book_backend_set_is_writable (EBookBackend *backend, gboolean is_writable)
*
* Checks if @backend has been removed from its physical storage.
*
- * Return value: %TRUE if @backend has been removed, %FALSE otherwise.
+ * Returns: %TRUE if @backend has been removed, %FALSE otherwise.
**/
gboolean
e_book_backend_is_removed (EBookBackend *backend)
@@ -765,7 +765,7 @@ e_book_backend_sync (EBookBackend *backend)
* Creates a new change item indicating @vcard was added.
* Meant to be used by backend implementations.
*
- * Return value: A new #GNOME_Evolution_Addressbook_BookChangeItem.
+ * Returns: A new #GNOME_Evolution_Addressbook_BookChangeItem.
**/
EDataBookChange *
e_book_backend_change_add_new (const gchar *vcard)
@@ -785,7 +785,7 @@ e_book_backend_change_add_new (const gchar *vcard)
* Creates a new change item indicating @vcard was modified.
* Meant to be used by backend implementations.
*
- * Return value: A new #GNOME_Evolution_Addressbook_BookChangeItem.
+ * Returns: A new #GNOME_Evolution_Addressbook_BookChangeItem.
**/
EDataBookChange *
e_book_backend_change_modify_new (const gchar *vcard)
@@ -805,7 +805,7 @@ e_book_backend_change_modify_new (const gchar *vcard)
* Creates a new change item indicating @vcard was deleted.
* Meant to be used by backend implementations.
*
- * Return value: A new #GNOME_Evolution_Addressbook_BookChangeItem.
+ * Returns: A new #GNOME_Evolution_Addressbook_BookChangeItem.
**/
EDataBookChange *
e_book_backend_change_delete_new (const gchar *vcard)
diff --git a/addressbook/libedata-book/e-data-book-view.c b/addressbook/libedata-book/e-data-book-view.c
index b6f5d38..252e3ec 100644
--- a/addressbook/libedata-book/e-data-book-view.c
+++ b/addressbook/libedata-book/e-data-book-view.c
@@ -635,7 +635,7 @@ e_data_book_view_set_thresholds (EDataBookView *book_view,
* Gets the text representation of the s-expression used
* for matching contacts to @book_view.
*
- * Return value: The textual s-expression used.
+ * Returns: The textual s-expression used.
**/
const gchar *
e_data_book_view_get_card_query (EDataBookView *book_view)
@@ -652,7 +652,7 @@ e_data_book_view_get_card_query (EDataBookView *book_view)
* Gets the s-expression used for matching contacts to
* @book_view.
*
- * Return value: The #EBookBackendSExp used.
+ * Returns: The #EBookBackendSExp used.
**/
EBookBackendSExp*
e_data_book_view_get_card_sexp (EDataBookView *book_view)
@@ -669,7 +669,7 @@ e_data_book_view_get_card_sexp (EDataBookView *book_view)
* Gets the maximum number of results returned by
* @book_view's query.
*
- * Return value: The maximum number of results returned.
+ * Returns: The maximum number of results returned.
**/
gint
e_data_book_view_get_max_results (EDataBookView *book_view)
@@ -685,7 +685,7 @@ e_data_book_view_get_max_results (EDataBookView *book_view)
*
* Gets the backend that @book_view is querying.
*
- * Return value: The associated #EBookBackend.
+ * Returns: The associated #EBookBackend.
**/
EBookBackend*
e_data_book_view_get_backend (EDataBookView *book_view)
diff --git a/calendar/backends/google/e-cal-backend-google-utils.c b/calendar/backends/google/e-cal-backend-google-utils.c
index bcc3fea..1d475e3 100644
--- a/calendar/backends/google/e-cal-backend-google-utils.c
+++ b/calendar/backends/google/e-cal-backend-google-utils.c
@@ -161,7 +161,7 @@ e_cal_backend_google_utils_create_cache (ECalBackendGoogle *cbgo)
* @handle:
* Call this to Update changes, made to the calendar.
*
- * Return value: TRUE if update is successful FALSE otherwise .
+ * Returns: TRUE if update is successful FALSE otherwise .
**/
gpointer
e_cal_backend_google_utils_update (gpointer handle)
diff --git a/calendar/libecal/e-cal-check-timezones.c b/calendar/libecal/e-cal-check-timezones.c
index 9c55db4..175a8ce 100644
--- a/calendar/libecal/e-cal-check-timezones.c
+++ b/calendar/libecal/e-cal-check-timezones.c
@@ -246,7 +246,7 @@ static void addsystemtz(gpointer key,
* the TZID. All items referencing the renamed TZID are adapted
* accordingly.
*
- * Return value: TRUE if successful, FALSE otherwise.
+ * Returns: TRUE if successful, FALSE otherwise.
*
* Since: 2.24
*/
diff --git a/calendar/libecal/e-cal-component.c b/calendar/libecal/e-cal-component.c
index 3230b0e..f3f64cd 100644
--- a/calendar/libecal/e-cal-component.c
+++ b/calendar/libecal/e-cal-component.c
@@ -379,7 +379,7 @@ e_cal_component_finalize (GObject *object)
*
* Generates a unique identifier suitable for calendar components.
*
- * Return value: A unique identifier string. Every time this function is called
+ * Returns: A unique identifier string. Every time this function is called
* a different string is returned.
**/
gchar *
@@ -424,7 +424,7 @@ e_cal_component_gen_uid (void)
* existing #icalcomponent structure by using e_cal_component_set_icalcomponent() or with a
* new empty component type by using e_cal_component_set_new_vtype().
*
- * Return value: A newly-created calendar component object.
+ * Returns: A newly-created calendar component object.
**/
ECalComponent *
e_cal_component_new (void)
@@ -438,7 +438,7 @@ e_cal_component_new (void)
*
* Creates a new calendar component object from the given iCalendar string.
*
- * Return value: A calendar component representing the given iCalendar string on
+ * Returns: A calendar component representing the given iCalendar string on
* success, NULL if there was an error.
**/
ECalComponent *
@@ -471,7 +471,7 @@ e_cal_component_new_from_string (const gchar *calobj)
* Creates a new calendar component object by copying the information from
* another one.
*
- * Return value: A newly-created calendar component with the same values as the
+ * Returns: A newly-created calendar component with the same values as the
* original one.
**/
ECalComponent *
@@ -1047,7 +1047,7 @@ e_cal_component_set_new_vtype (ECalComponent *comp, ECalComponentVType type)
*
* Supported component types are VEVENT, VTODO, VJOURNAL, VFREEBUSY, and VTIMEZONE.
*
- * Return value: TRUE on success, FALSE if @icalcomp is an unsupported component
+ * Returns: TRUE on success, FALSE if @icalcomp is an unsupported component
* type.
**/
gboolean
@@ -1095,7 +1095,7 @@ e_cal_component_set_icalcomponent (ECalComponent *comp, icalcomponent *icalcomp)
* Queries the #icalcomponent structure that a calendar component object is
* wrapping.
*
- * Return value: An #icalcomponent structure, or NULL if the @comp has no
+ * Returns: An #icalcomponent structure, or NULL if the @comp has no
* #icalcomponent set to it.
**/
icalcomponent *
@@ -1163,7 +1163,7 @@ e_cal_component_strip_errors (ECalComponent *comp)
*
* Queries the type of a calendar component object.
*
- * Return value: The type of the component, as defined by RFC 2445.
+ * Returns: The type of the component, as defined by RFC 2445.
**/
ECalComponentVType
e_cal_component_get_vtype (ECalComponent *comp)
@@ -1209,7 +1209,7 @@ e_cal_component_get_vtype (ECalComponent *comp)
* call e_cal_component_commit_sequence() before this function to ensure that the
* component's sequence number is consistent with the state of the object.
*
- * Return value: String representation of the calendar component according to
+ * Returns: String representation of the calendar component according to
* RFC 2445.
**/
gchar *
@@ -1388,7 +1388,7 @@ e_cal_component_abort_sequence (ECalComponent *comp)
* Get the ID of the component as a #ECalComponentId. The return value should
* be freed with e_cal_component_free_id() when you have finished with it.
*
- * Return value: the id of the component
+ * Returns: the id of the component
*/
ECalComponentId *
e_cal_component_get_id (ECalComponent *comp)
@@ -1597,7 +1597,7 @@ e_cal_component_set_attachment_list (ECalComponent *comp, GSList *attachment_lis
*
* Queries the component to see if it has attachments.
*
- * Return value: TRUE if there are attachments, FALSE otherwise.
+ * Returns: TRUE if there are attachments, FALSE otherwise.
*/
gboolean
e_cal_component_has_attachments (ECalComponent *comp)
@@ -1621,7 +1621,7 @@ e_cal_component_has_attachments (ECalComponent *comp)
*
* Get the number of attachments to this calendar component object.
*
- * Return value: the number of attachments.
+ * Returns: the number of attachments.
*/
gint
e_cal_component_get_num_attachments (ECalComponent *comp)
@@ -2904,7 +2904,7 @@ e_cal_component_set_exdate_list (ECalComponent *comp, GSList *exdate_list)
* Queries whether a calendar component object has any exception dates defined
* for it.
*
- * Return value: TRUE if the component has exception dates, FALSE otherwise.
+ * Returns: TRUE if the component has exception dates, FALSE otherwise.
**/
gboolean
e_cal_component_has_exdates (ECalComponent *comp)
@@ -3065,7 +3065,7 @@ e_cal_component_set_exrule_list (ECalComponent *comp, GSList *recur_list)
* Queries whether a calendar component object has any exception rules defined
* for it.
*
- * Return value: TRUE if the component has exception rules, FALSE otherwise.
+ * Returns: TRUE if the component has exception rules, FALSE otherwise.
**/
gboolean
e_cal_component_has_exrules (ECalComponent *comp)
@@ -3088,7 +3088,7 @@ e_cal_component_has_exrules (ECalComponent *comp)
* Queries whether a calendar component object has any exception dates
* or exception rules.
*
- * Return value: TRUE if the component has exceptions, FALSE otherwise.
+ * Returns: TRUE if the component has exceptions, FALSE otherwise.
**/
gboolean
e_cal_component_has_exceptions (ECalComponent *comp)
@@ -3348,7 +3348,7 @@ e_cal_component_set_organizer (ECalComponent *comp, ECalComponentOrganizer *orga
*
* Check whether a calendar component object has an organizer or not.
*
- * Return value: TRUE if there is an organizer, FALSE otherwise.
+ * Returns: TRUE if there is an organizer, FALSE otherwise.
**/
gboolean
e_cal_component_has_organizer (ECalComponent *comp)
@@ -3582,7 +3582,7 @@ e_cal_component_get_recurid (ECalComponent *comp, ECalComponentRange *recur_id)
*
* Gets the recurrence ID property as a string.
*
- * Return value: the recurrence ID as a string.
+ * Returns: the recurrence ID as a string.
*/
gchar *
e_cal_component_get_recurid_as_string (ECalComponent *comp)
@@ -3685,7 +3685,7 @@ e_cal_component_set_rdate_list (ECalComponent *comp, GSList *period_list)
* Queries whether a calendar component object has any recurrence dates defined
* for it.
*
- * Return value: TRUE if the component has recurrence dates, FALSE otherwise.
+ * Returns: TRUE if the component has recurrence dates, FALSE otherwise.
**/
gboolean
e_cal_component_has_rdates (ECalComponent *comp)
@@ -3778,7 +3778,7 @@ e_cal_component_set_rrule_list (ECalComponent *comp, GSList *recur_list)
* Queries whether a calendar component object has any recurrence rules defined
* for it.
*
- * Return value: TRUE if the component has recurrence rules, FALSE otherwise.
+ * Returns: TRUE if the component has recurrence rules, FALSE otherwise.
**/
gboolean
e_cal_component_has_rrules (ECalComponent *comp)
@@ -3801,7 +3801,7 @@ e_cal_component_has_rrules (ECalComponent *comp)
* Queries whether a calendar component object has any recurrence dates or
* recurrence rules.
*
- * Return value: TRUE if the component has recurrences, FALSE otherwise.
+ * Returns: TRUE if the component has recurrences, FALSE otherwise.
**/
gboolean
e_cal_component_has_recurrences (ECalComponent *comp)
@@ -3829,7 +3829,7 @@ count_by_xxx (short *field, gint max_elements)
* Checks whether the given calendar component object has simple recurrence
* rules or more complicated ones.
*
- * Return value: TRUE if it has a simple recurrence rule, FALSE otherwise.
+ * Returns: TRUE if it has a simple recurrence rule, FALSE otherwise.
*/
gboolean
e_cal_component_has_simple_recurrence (ECalComponent *comp)
@@ -3996,7 +3996,7 @@ e_cal_component_has_simple_recurrence (ECalComponent *comp)
* Checks whether a calendar component object is an instance of a recurring
* event.
*
- * Return value: TRUE if it is an instance, FALSE if not.
+ * Returns: TRUE if it is an instance, FALSE if not.
*/
gboolean
e_cal_component_is_instance (ECalComponent *comp)
@@ -4640,7 +4640,7 @@ e_cal_component_set_attendee_list (ECalComponent *comp, GSList *attendee_list)
*
* Queries a calendar component object for the existence of attendees.
*
- * Return value: TRUE if there are attendees, FALSE if not.
+ * Returns: TRUE if there are attendees, FALSE if not.
*/
gboolean
e_cal_component_has_attendees (ECalComponent *comp)
@@ -5001,7 +5001,7 @@ e_cal_component_free_attendee_list (GSList *attendee_list)
*
* Checks whether the component has any alarms.
*
- * Return value: TRUE if the component has any alarms.
+ * Returns: TRUE if the component has any alarms.
**/
gboolean
e_cal_component_has_alarms (ECalComponent *comp)
@@ -5207,7 +5207,7 @@ make_alarm (icalcomponent *subcomp)
* Builds a list of the unique identifiers of the alarm subcomponents inside a
* calendar component.
*
- * Return value: List of unique identifiers for alarms. This should be freed
+ * Returns: List of unique identifiers for alarms. This should be freed
* using cal_obj_uid_list_free().
**/
GList *
@@ -5258,7 +5258,7 @@ e_cal_component_get_alarm_uids (ECalComponent *comp)
*
* Queries a particular alarm subcomponent of a calendar component.
*
- * Return value: The alarm subcomponent that corresponds to the specified @auid,
+ * Returns: The alarm subcomponent that corresponds to the specified @auid,
* or #NULL if no alarm exists with that UID. This should be freed using
* e_cal_component_alarm_free().
**/
@@ -5318,7 +5318,7 @@ e_cal_component_alarms_free (ECalComponentAlarms *alarms)
*
* Create a new alarm object.
*
- * Return value: a new alarm component
+ * Returns: a new alarm component
**/
ECalComponentAlarm *
e_cal_component_alarm_new (void)
@@ -5354,7 +5354,7 @@ e_cal_component_alarm_new (void)
*
* Creates a new alarm subcomponent by copying the information from another one.
*
- * Return value: A newly-created alarm subcomponent with the same values as the
+ * Returns: A newly-created alarm subcomponent with the same values as the
* original one. Should be freed with e_cal_component_alarm_free().
**/
ECalComponentAlarm *
@@ -5410,7 +5410,7 @@ e_cal_component_alarm_free (ECalComponentAlarm *alarm)
*
* Queries the unique identifier of an alarm subcomponent.
*
- * Return value: UID of the alarm.
+ * Returns: UID of the alarm.
**/
const gchar *
e_cal_component_alarm_get_uid (ECalComponentAlarm *alarm)
@@ -5901,7 +5901,7 @@ e_cal_component_alarm_set_attendee_list (ECalComponentAlarm *alarm, GSList *atte
*
* Queries an alarm to see if it has attendees associated with it.
*
- * Return value: TRUE if there are attendees in the alarm, FALSE if not.
+ * Returns: TRUE if there are attendees in the alarm, FALSE if not.
*/
gboolean
e_cal_component_alarm_has_attendees (ECalComponentAlarm *alarm)
diff --git a/calendar/libecal/e-cal-recur.c b/calendar/libecal/e-cal-recur.c
index 794aa3d..16f02bf 100644
--- a/calendar/libecal/e-cal-recur.c
+++ b/calendar/libecal/e-cal-recur.c
@@ -920,7 +920,7 @@ array_to_list (short *array, gint max_elements)
* Converts an #icalproperty to a #ECalRecurrence. This should be
* freed using the e_cal_recur_free() function.
*
- * Return value: #ECalRecurrence structure.
+ * Returns: #ECalRecurrence structure.
**/
static ECalRecurrence *
e_cal_recur_from_icalproperty (icalproperty *prop, gboolean exception,
diff --git a/calendar/libecal/e-cal-time-util.c b/calendar/libecal/e-cal-time-util.c
index f74abfd..5be06f3 100644
--- a/calendar/libecal/e-cal-time-util.c
+++ b/calendar/libecal/e-cal-time-util.c
@@ -55,7 +55,7 @@ static const gint days_in_month[12] = {
* to make it valid time, any further calls to time_add_day() will also return
* this hour, which may not be what you want.
*
- * Return value: a time_t value containing @time plus the days added.
+ * Returns: a time_t value containing @time plus the days added.
*/
time_t
time_add_day (time_t time, gint days)
@@ -76,7 +76,7 @@ time_add_day (time_t time, gint days)
*
* Adds the given number of weeks to a time value.
*
- * Return value: a time_t value containing @time plus the weeks added.
+ * Returns: a time_t value containing @time plus the weeks added.
*/
time_t
time_add_week (time_t time, gint weeks)
@@ -90,7 +90,7 @@ time_add_week (time_t time, gint weeks)
*
* Returns the start of the day, according to the local time.
*
- * Return value: the time corresponding to the beginning of the day.
+ * Returns: the time corresponding to the beginning of the day.
*/
time_t
time_day_begin (time_t t)
@@ -110,7 +110,7 @@ time_day_begin (time_t t)
*
* Returns the end of the day, according to the local time.
*
- * Return value: the time corresponding to the end of the day.
+ * Returns: the time corresponding to the end of the day.
*/
time_t
time_day_end (time_t t)
@@ -145,7 +145,7 @@ time_day_end (time_t t)
* functions easier. New code should use icaltimetype values and
* icaltime_adjust() to add or subtract days, hours, minutes & seconds.
*
- * Return value: a time_t value containing @time plus the days added.
+ * Returns: a time_t value containing @time plus the days added.
*/
time_t
time_add_day_with_zone (time_t time, gint days, icaltimezone *zone)
@@ -174,7 +174,7 @@ time_add_day_with_zone (time_t time, gint days, icaltimezone *zone)
* functions easier. New code should use icaltimetype values and
* icaltime_adjust() to add or subtract days, hours, minutes & seconds.
*
- * Return value: a time_t value containing @time plus the weeks added.
+ * Returns: a time_t value containing @time plus the weeks added.
*/
time_t
time_add_week_with_zone (time_t time, gint weeks, icaltimezone *zone)
@@ -199,7 +199,7 @@ time_add_week_with_zone (time_t time, gint weeks, icaltimezone *zone)
* functions easier. New code should use icaltimetype values and
* icaltime_adjust() to add or subtract days, hours, minutes & seconds.
*
- * Return value: a time_t value containing @time plus the months added.
+ * Returns: a time_t value containing @time plus the months added.
*/
time_t
time_add_month_with_zone (time_t time, gint months, icaltimezone *zone)
@@ -243,7 +243,7 @@ time_add_month_with_zone (time_t time, gint months, icaltimezone *zone)
* functions easier. New code should use icaltimetype values and
* icaltime_adjust() to add or subtract days, hours, minutes & seconds.
*
- * Return value: the beginning of the year.
+ * Returns: the beginning of the year.
*/
time_t
time_year_begin_with_zone (time_t time, icaltimezone *zone)
@@ -275,7 +275,7 @@ time_year_begin_with_zone (time_t time, icaltimezone *zone)
* functions easier. New code should use icaltimetype values and
* icaltime_adjust() to add or subtract days, hours, minutes & seconds.
*
- * Return value: the beginning of the month.
+ * Returns: the beginning of the month.
*/
time_t
time_month_begin_with_zone (time_t time, icaltimezone *zone)
@@ -308,7 +308,7 @@ time_month_begin_with_zone (time_t time, icaltimezone *zone)
* functions easier. New code should use icaltimetype values and
* icaltime_adjust() to add or subtract days, hours, minutes & seconds.
*
- * Return value: the beginning of the week.
+ * Returns: the beginning of the week.
*/
time_t
time_week_begin_with_zone (time_t time, gint week_start_day, icaltimezone *zone)
@@ -349,7 +349,7 @@ time_week_begin_with_zone (time_t time, gint week_start_day, icaltimezone *zone)
* functions easier. New code should use icaltimetype values and
* icaltime_adjust() to add or subtract days, hours, minutes & seconds.
*
- * Return value: the beginning of the day.
+ * Returns: the beginning of the day.
*/
time_t
time_day_begin_with_zone (time_t time, icaltimezone *zone)
@@ -379,7 +379,7 @@ time_day_begin_with_zone (time_t time, icaltimezone *zone)
* functions easier. New code should use icaltimetype values and
* icaltime_adjust() to add or subtract days, hours, minutes & seconds.
*
- * Return value: the end of the day.
+ * Returns: the end of the day.
*/
time_t
time_day_end_with_zone (time_t time, icaltimezone *zone)
@@ -438,7 +438,7 @@ time_to_gdate_with_zone (GDate *date, time_t time, icaltimezone *zone)
* Returns the number of days in the month. Year is the normal year, e.g. 2001.
* Month is 0 (Jan) to 11 (Dec).
*
- * Return value: number of days in the given month/year.
+ * Returns: number of days in the given month/year.
*/
gint
time_days_in_month (gint year, gint month)
@@ -464,7 +464,7 @@ time_days_in_month (gint year, gint month)
* Returns the 1-based day number within the year of the specified date.
* Year is the normal year, e.g. 2001. Month is 0 to 11.
*
- * Return value: the day of the year.
+ * Returns: the day of the year.
*/
gint
time_day_of_year (gint day, gint month, gint year)
@@ -491,7 +491,7 @@ time_day_of_year (gint day, gint month, gint year)
* For the days that were removed on the Gregorian reformation, it returns
* Thursday. Year is the normal year, e.g. 2001. Month is 0 to 11.
*
- * Return value: the day of the week for the given date.
+ * Returns: the day of the week for the given date.
*/
gint
time_day_of_week (gint day, gint month, gint year)
@@ -517,7 +517,7 @@ time_day_of_week (gint day, gint month, gint year)
* Returns whether the specified year is a leap year. Year is the normal year,
* e.g. 2001.
*
- * Return value: TRUE if the year is leap, FALSE if not.
+ * Returns: TRUE if the year is leap, FALSE if not.
*/
gboolean
time_is_leap_year (gint year)
@@ -535,7 +535,7 @@ time_is_leap_year (gint year)
* Returns the number of leap years since year 1 up to (but not including) the
* specified year. Year is the normal year, e.g. 2001.
*
- * Return value: number of leap years.
+ * Returns: number of leap years.
*/
gint
time_leap_years_up_to (gint year)
@@ -554,7 +554,7 @@ time_leap_years_up_to (gint year)
*
* Creates an ISO 8601 UTC representation from a time value.
*
- * Return value: String with the ISO 8601 representation of the UTC time.
+ * Returns: String with the ISO 8601 representation of the UTC time.
**/
gchar *
isodate_from_time_t (time_t t)
@@ -576,7 +576,7 @@ isodate_from_time_t (time_t t)
*
* Converts an ISO 8601 UTC time string into a time_t value.
*
- * Return value: Time_t corresponding to the specified ISO string.
+ * Returns: Time_t corresponding to the specified ISO string.
* Note that we only allow UTC times at present.
**/
time_t
@@ -634,7 +634,7 @@ time_from_isodate (const gchar *str)
*
* Convers an icaltimetype structure into a GLibc's struct tm.
*
- * Return value: The converted time as a struct tm. All fields will be
+ * Returns: The converted time as a struct tm. All fields will be
* set properly except for tm.tm_yday.
*
* Since: 2.22
@@ -670,7 +670,7 @@ icaltimetype_to_tm (struct icaltimetype *itt)
* Converts a time value from one timezone to another, and returns a struct tm
* representation of the time.
*
- * Return value: The converted time as a struct tm. All fields will be
+ * Returns: The converted time as a struct tm. All fields will be
* set properly except for tm.tm_yday.
*
* Since: 2.22
@@ -703,7 +703,7 @@ icaltimetype_to_tm_with_zone (struct icaltimetype *itt,
*
* Converts a struct tm into an icaltimetype.
*
- * Return value: The converted time as an icaltimetype.
+ * Returns: The converted time as an icaltimetype.
*
* Since: 2.22
*/
diff --git a/calendar/libecal/e-cal-util.c b/calendar/libecal/e-cal-util.c
index d645e1a..0fbc5fc 100644
--- a/calendar/libecal/e-cal-util.c
+++ b/calendar/libecal/e-cal-util.c
@@ -83,7 +83,7 @@ cal_obj_uid_list_free (GList *list)
*
* Creates a new VCALENDAR component.
*
- * Return value: the newly created top level component.
+ * Returns: the newly created top level component.
*/
icalcomponent *
e_cal_util_new_top_level (void)
@@ -116,7 +116,7 @@ e_cal_util_new_top_level (void)
*
* Creates a new #icalcomponent of the specified kind.
*
- * Return value: the newly created component.
+ * Returns: the newly created component.
*/
icalcomponent *
e_cal_util_new_component (icalcomponent_kind kind)
@@ -165,7 +165,7 @@ read_line (const gchar *string)
* string, something that Mozilla used to do and which libical does not
* support.
*
- * Return value: a newly created #icalcomponent or NULL if the string isn't a
+ * Returns: a newly created #icalcomponent or NULL if the string isn't a
* valid iCalendar string.
*/
icalcomponent *
@@ -228,7 +228,7 @@ get_line_fn (gchar *buf, gsize size, gpointer file)
* Parses the given file, and, if it contains a valid iCalendar object,
* parse it and return a new #icalcomponent.
*
- * Return value: a newly created #icalcomponent or NULL if the file doesn't
+ * Returns: a newly created #icalcomponent or NULL if the file doesn't
* contain a valid iCalendar object.
*/
icalcomponent *
@@ -565,7 +565,7 @@ compare_alarm_instance (gconstpointer a, gconstpointer b)
* structure, or NULL if no alarm instances occurred in the specified time
* range.
*
- * Return value: a list of all the alarms found for the given component on
+ * Returns: a list of all the alarms found for the given component on
* the given time tange. The list of alarms should be freed by using the
* #e_cal_component_free_alarm_list function.
*/
@@ -634,7 +634,7 @@ e_cal_util_generate_alarms_for_comp (ECalComponent *comp,
* Iterates through all the components in the @comps list and generates alarm
* instances for them; putting them in the @comp_alarms list.
*
- * Return value: the number of elements it added to the list.
+ * Returns: the number of elements it added to the list.
*/
gint
e_cal_util_generate_alarms_for_list (GList *comps,
@@ -674,7 +674,7 @@ e_cal_util_generate_alarms_for_list (GList *comps,
* Converts an iCalendar PRIORITY value to a translated string. Any unknown
* priority value (i.e. not 0-9) will be returned as "" (undefined).
*
- * Return value: a string representing the PRIORITY value. This value is a
+ * Returns: a string representing the PRIORITY value. This value is a
* constant, so it should never be freed.
*/
const gchar *
@@ -702,7 +702,7 @@ e_cal_util_priority_to_string (gint priority)
*
* Converts a translated priority string to an iCalendar priority value.
*
- * Return value: the priority (0-9) or -1 if the priority string is not valid.
+ * Returns: the priority (0-9) or -1 if the priority string is not valid.
*/
gint
e_cal_util_priority_from_string (const gchar *string)
@@ -789,7 +789,7 @@ e_cal_util_add_timezones_from_component (icalcomponent *vcal_comp,
*
* Checks whether an #icalcomponent is an instance of a recurring appointment or not.
*
- * Return value: TRUE if it is an instance, FALSE if not.
+ * Returns: TRUE if it is an instance, FALSE if not.
*/
gboolean
e_cal_util_component_is_instance (icalcomponent *icalcomp)
@@ -808,7 +808,7 @@ e_cal_util_component_is_instance (icalcomponent *icalcomp)
*
* Checks whether an #icalcomponent has any alarm.
*
- * Return value: TRUE if it has alarms, FALSE otherwise.
+ * Returns: TRUE if it has alarms, FALSE otherwise.
*/
gboolean
e_cal_util_component_has_alarms (icalcomponent *icalcomp)
@@ -827,7 +827,7 @@ e_cal_util_component_has_alarms (icalcomponent *icalcomp)
*
* Checks whether an #icalcomponent has an organizer or not.
*
- * Return value: TRUE if there is an organizer, FALSE if not.
+ * Returns: TRUE if there is an organizer, FALSE if not.
*/
gboolean
e_cal_util_component_has_organizer (icalcomponent *icalcomp)
@@ -846,7 +846,7 @@ e_cal_util_component_has_organizer (icalcomponent *icalcomp)
*
* Checks if an #icalcomponent has any attendees.
*
- * Return value: TRUE if there are attendees, FALSE if not.
+ * Returns: TRUE if there are attendees, FALSE if not.
*/
gboolean
e_cal_util_component_has_attendee (icalcomponent *icalcomp)
@@ -866,7 +866,7 @@ e_cal_util_component_has_attendee (icalcomponent *icalcomp)
*
* Checks if an #icalcomponent has recurrence dates or rules.
*
- * Return value: TRUE if there are recurrence dates/rules, FALSE if not.
+ * Returns: TRUE if there are recurrence dates/rules, FALSE if not.
*/
gboolean
e_cal_util_component_has_recurrences (icalcomponent *icalcomp)
@@ -882,7 +882,7 @@ e_cal_util_component_has_recurrences (icalcomponent *icalcomp)
*
* Checks if an #icalcomponent has recurrence dates.
*
- * Return value: TRUE if there are recurrence dates, FALSE if not.
+ * Returns: TRUE if there are recurrence dates, FALSE if not.
*/
gboolean
e_cal_util_component_has_rdates (icalcomponent *icalcomp)
@@ -901,7 +901,7 @@ e_cal_util_component_has_rdates (icalcomponent *icalcomp)
*
* Checks if an #icalcomponent has recurrence rules.
*
- * Return value: TRUE if there are recurrence rules, FALSE if not.
+ * Returns: TRUE if there are recurrence rules, FALSE if not.
*/
gboolean
e_cal_util_component_has_rrules (icalcomponent *icalcomp)
@@ -921,7 +921,7 @@ e_cal_util_component_has_rrules (icalcomponent *icalcomp)
*
* Compare the dates of two #icalcomponent's to check if they match.
*
- * Return value: TRUE if the dates of both components match, FALSE otherwise.
+ * Returns: TRUE if the dates of both components match, FALSE otherwise.
*/
gboolean
e_cal_util_event_dates_match (icalcomponent *icalcomp1, icalcomponent *icalcomp2)
@@ -993,7 +993,7 @@ check_instance (icalcomponent *comp, struct icaltime_span *span, gpointer data)
* This checks that @rid indicates a valid recurrence of @icalcomp, and
* if so, generates a copy of @comp containing a RECURRENCE-ID of @rid.
*
- * Return value: the instance, or %NULL.
+ * Returns: the instance, or %NULL.
**/
icalcomponent *
e_cal_util_construct_instance (icalcomponent *icalcomp,
diff --git a/calendar/libecal/e-cal-view.c b/calendar/libecal/e-cal-view.c
index 123839a..d5fe206 100644
--- a/calendar/libecal/e-cal-view.c
+++ b/calendar/libecal/e-cal-view.c
@@ -364,7 +364,7 @@ e_cal_view_class_init (ECalViewClass *klass)
* Creates a new view object by issuing the view creation request to the
* calendar server.
*
- * Return value: A newly-created view object, or NULL if the request failed.
+ * Returns: A newly-created view object, or NULL if the request failed.
**/
ECalView *
_e_cal_view_new (ECal *client, DBusGProxy *view_proxy, GStaticRecMutex *connection_lock)
@@ -386,7 +386,7 @@ _e_cal_view_new (ECal *client, DBusGProxy *view_proxy, GStaticRecMutex *connecti
*
* Get the #ECal associated with this view.
*
- * Return value: the associated client.
+ * Returns: the associated client.
*
* Since: 2.22
*/
diff --git a/calendar/libecal/e-cal.c b/calendar/libecal/e-cal.c
index e17cee9..34b04eb 100644
--- a/calendar/libecal/e-cal.c
+++ b/calendar/libecal/e-cal.c
@@ -271,7 +271,7 @@ unwrap_gerror(GError **error)
*
* Registers the #ECalSourceTypeEnum type with glib.
*
- * Return value: the ID of the #ECalSourceTypeEnum type.
+ * Returns: the ID of the #ECalSourceTypeEnum type.
*/
GType
e_cal_source_type_enum_get_type (void)
@@ -300,7 +300,7 @@ e_cal_source_type_enum_get_type (void)
*
* Registers the #ECalSetModeStatusEnum type with glib.
*
- * Return value: the ID of the #ECalSetModeStatusEnum type.
+ * Returns: the ID of the #ECalSetModeStatusEnum type.
*/
GType
e_cal_set_mode_status_enum_get_type (void)
@@ -328,7 +328,7 @@ e_cal_set_mode_status_enum_get_type (void)
*
* Registers the #CalModeEnum type with glib.
*
- * Return value: the ID of the #CalModeEnum type.
+ * Returns: the ID of the #CalModeEnum type.
*/
GType
cal_mode_enum_get_type (void)
@@ -811,7 +811,7 @@ set_local_attachment_store (ECal *ecal)
* Creates a new calendar client. This does not open the calendar itself,
* for that, #e_cal_open or #e_cal_open_async needs to be called.
*
- * Return value: A newly-created calendar client, or NULL if the client could
+ * Returns: A newly-created calendar client, or NULL if the client could
* not be constructed because it could not contact the calendar server.
**/
ECal *
@@ -938,7 +938,7 @@ check_uri (ESource *source, gpointer uri)
* Creates a new calendar client. This does not open the calendar itself,
* for that, #e_cal_open or #e_cal_open_async needs to be called.
*
- * Return value: A newly-created calendar client, or NULL if the client could
+ * Returns: A newly-created calendar client, or NULL if the client could
* not be constructed because it could not contact the calendar server.
**/
ECal *
@@ -965,7 +965,7 @@ e_cal_new_from_uri (const gchar *uri, ECalSourceType type)
* all Evolution installations. This does not open the calendar itself,
* for that, #e_cal_open or #e_cal_open_async needs to be called.
*
- * Return value: A newly-created calendar client, or NULL if the client could
+ * Returns: A newly-created calendar client, or NULL if the client could
* not be constructed.
*/
ECal *
@@ -993,7 +993,7 @@ e_cal_new_system_calendar (void)
* all Evolution installations. This does not open the tasks list itself,
* for that, #e_cal_open or #e_cal_open_async needs to be called.
*
- * Return value: A newly-created calendar client, or NULL if the client could
+ * Returns: A newly-created calendar client, or NULL if the client could
* not be constructed.
*/
ECal *
@@ -1021,7 +1021,7 @@ e_cal_new_system_tasks (void)
* in all Evolution installations. This does not open the memos itself, for
* that, #e_cal_open or #e_cal_open_async needs to be called.
*
- * Return value: A newly-created calendar client, or NULL if the client could
+ * Returns: A newly-created calendar client, or NULL if the client could
* not be constructed.
*/
ECal *
@@ -1256,7 +1256,7 @@ open_calendar (ECal *ecal, gboolean only_if_exists, GError **error, ECalendarSta
* client will emit the "cal_opened" signal when the response from the server is
* received.
*
- * Return value: TRUE on success, FALSE on failure to issue the open request.
+ * Returns: TRUE on success, FALSE on failure to issue the open request.
**/
gboolean
e_cal_open (ECal *ecal, gboolean only_if_exists, GError **error)
@@ -1351,7 +1351,7 @@ e_cal_open_async (ECal *ecal, gboolean only_if_exists)
*
* Invokes refresh on a calendar. See @e_cal_get_refresh_supported.
*
- * Return value: TRUE if calendar supports refresh and it was invoked, FALSE otherwise.
+ * Returns: TRUE if calendar supports refresh and it was invoked, FALSE otherwise.
*
* Since: 2.30
**/
@@ -1381,7 +1381,7 @@ e_cal_refresh (ECal *ecal, GError **error)
*
* Removes a calendar.
*
- * Return value: TRUE if the calendar was removed, FALSE if there was an error.
+ * Returns: TRUE if the calendar was removed, FALSE if there was an error.
*/
gboolean
e_cal_remove (ECal *ecal, GError **error)
@@ -1424,7 +1424,7 @@ build_uri_list (GNOME_Evolution_Calendar_StringSeq *seq)
*
* Retrieves a list of all calendar clients for the given mode.
*
- * Return value: list of uris.
+ * Returns: list of uris.
*/
GList *
e_cal_uri_list (ECal *ecal, CalMode mode)
@@ -1474,7 +1474,7 @@ e_cal_uri_list (ECal *ecal, CalMode mode)
*
* Gets the type of the calendar client.
*
- * Return value: an #ECalSourceType value corresponding to the type
+ * Returns: an #ECalSourceType value corresponding to the type
* of the calendar client.
*/
ECalSourceType
@@ -1496,7 +1496,7 @@ e_cal_get_source_type (ECal *ecal)
*
* Queries the state of loading of a calendar client.
*
- * Return value: A #ECalLoadState value indicating whether the client has
+ * Returns: A #ECalLoadState value indicating whether the client has
* not been loaded with #e_cal_open yet, whether it is being
* loaded, or whether it is already loaded.
**/
@@ -1518,7 +1518,7 @@ e_cal_get_load_state (ECal *ecal)
*
* Queries the source that is open in a calendar client.
*
- * Return value: The source of the calendar that is already loaded or is being
+ * Returns: The source of the calendar that is already loaded or is being
* loaded, or NULL if the ecal has not started a load request yet.
**/
ESource *
@@ -1539,7 +1539,7 @@ e_cal_get_source (ECal *ecal)
*
* Queries the URI that is open in a calendar client.
*
- * Return value: The URI of the calendar that is already loaded or is being
+ * Returns: The URI of the calendar that is already loaded or is being
* loaded, or NULL if the client has not started a load request yet.
**/
const gchar *
@@ -1564,7 +1564,7 @@ e_cal_get_uri (ECal *ecal)
* unless it specifically uses the attachments for open/sending
* operations.
*
- * Return value: The URL where the attachments are serialized in the
+ * Returns: The URL where the attachments are serialized in the
* local filesystem.
**/
const gchar *
@@ -1589,7 +1589,7 @@ e_cal_get_local_attachment_store (ECal *ecal)
* on the calendar or not. Whether the backend is read only or not
* is specified, on exit, in the @read_only argument.
*
- * Return value: TRUE if the call was successful, FALSE if there was an error.
+ * Returns: TRUE if the call was successful, FALSE if there was an error.
*/
gboolean
e_cal_is_read_only (ECal *ecal, gboolean *read_only, GError **error)
@@ -1613,7 +1613,7 @@ e_cal_is_read_only (ECal *ecal, gboolean *read_only, GError **error)
*
* Queries the calendar address associated with a calendar client.
*
- * Return value: TRUE if the operation was successful, FALSE if there
+ * Returns: TRUE if the operation was successful, FALSE if there
* was an error.
**/
gboolean
@@ -1654,7 +1654,7 @@ e_cal_get_cal_address (ECal *ecal, gchar **cal_address, GError **error)
*
* Queries the address to be used for alarms in a calendar client.
*
- * Return value: TRUE if the operation was successful, FALSE if there was
+ * Returns: TRUE if the operation was successful, FALSE if there was
* an error while contacting the backend.
*/
gboolean
@@ -1690,7 +1690,7 @@ e_cal_get_alarm_email_address (ECal *ecal, gchar **alarm_address, GError **error
*
* Queries the LDAP attribute for a calendar client.
*
- * Return value: TRUE if the call was successful, FALSE if there was an
+ * Returns: TRUE if the call was successful, FALSE if there was an
* error contacting the backend.
*/
gboolean
@@ -1764,7 +1764,7 @@ check_capability (ECal *ecal, const gchar *cap)
*
* Checks if a calendar supports only one alarm per component.
*
- * Return value: TRUE if the calendar allows only one alarm, FALSE otherwise.
+ * Returns: TRUE if the calendar allows only one alarm, FALSE otherwise.
*/
gboolean
e_cal_get_one_alarm_only (ECal *ecal)
@@ -1781,7 +1781,7 @@ e_cal_get_one_alarm_only (ECal *ecal)
*
* Checks if a calendar forces organizers of meetings to be also attendees.
*
- * Return value: TRUE if the calendar forces organizers to attend meetings,
+ * Returns: TRUE if the calendar forces organizers to attend meetings,
* FALSE otherwise.
*/
gboolean
@@ -1799,7 +1799,7 @@ e_cal_get_organizer_must_attend (ECal *ecal)
*
* Checks if the calendar has a master object for recurrences.
*
- * Return value: TRUE if the calendar has a master object for recurrences,
+ * Returns: TRUE if the calendar has a master object for recurrences,
* FALSE otherwise.
*/
gboolean
@@ -1818,7 +1818,7 @@ e_cal_get_recurrences_no_master (ECal *ecal)
*
* Queries the calendar for static capabilities.
*
- * Return value: TRUE if the capability is supported, FALSE otherwise.
+ * Returns: TRUE if the capability is supported, FALSE otherwise.
*/
gboolean
e_cal_get_static_capability (ECal *ecal, const gchar *cap)
@@ -1835,7 +1835,7 @@ e_cal_get_static_capability (ECal *ecal, const gchar *cap)
*
* Checks whether the calendar saves schedules.
*
- * Return value: TRUE if it saves schedules, FALSE otherwise.
+ * Returns: TRUE if it saves schedules, FALSE otherwise.
*/
gboolean
e_cal_get_save_schedules (ECal *ecal)
@@ -1853,7 +1853,7 @@ e_cal_get_save_schedules (ECal *ecal)
* Checks whether a calendar requires organizer to accept their attendance to
* meetings.
*
- * Return value: TRUE if the calendar requires organizers to accept, FALSE
+ * Returns: TRUE if the calendar requires organizers to accept, FALSE
* otherwise.
*/
gboolean
@@ -1871,7 +1871,7 @@ e_cal_get_organizer_must_accept (ECal *ecal)
*
* Checks whether a calendar supports explicit refreshing (see @e_cal_refresh).
*
- * Return value: TRUE if the calendar supports refreshing, FALSE otherwise.
+ * Returns: TRUE if the calendar supports refreshing, FALSE otherwise.
*
* Since: 2.30
*/
@@ -1891,7 +1891,7 @@ e_cal_get_refresh_supported (ECal *ecal)
*
* Switches online/offline mode on the calendar.
*
- * Return value: TRUE if the switch was successful, FALSE if there was an error.
+ * Returns: TRUE if the switch was successful, FALSE if there was an error.
*/
gboolean
e_cal_set_mode (ECal *ecal, CalMode mode)
@@ -1939,7 +1939,7 @@ struct _ECalGetTimezonesData {
* Retrives an #icalcomponent from the backend that contains the default
* values for properties needed.
*
- * Return value: TRUE if the call was successful, FALSE otherwise.
+ * Returns: TRUE if the call was successful, FALSE otherwise.
*/
gboolean
e_cal_get_default_object (ECal *ecal, icalcomponent **icalcomp, GError **error)
@@ -1992,7 +1992,7 @@ e_cal_get_default_object (ECal *ecal, icalcomponent **icalcomp, GError **error)
* Queries a calendar for a calendar component object based on its unique
* identifier and gets the attachments for the component.
*
- * Return value: TRUE if the call was successful, FALSE otherwise.
+ * Returns: TRUE if the call was successful, FALSE otherwise.
**/
gboolean
e_cal_get_attachments_for_comp (ECal *ecal, const gchar *uid, const gchar *rid, GSList **list, GError **error)
@@ -2043,7 +2043,7 @@ e_cal_get_attachments_for_comp (ECal *ecal, const gchar *uid, const gchar *rid,
* Queries a calendar for a calendar component object based on its unique
* identifier.
*
- * Return value: TRUE if the call was successful, FALSE otherwise.
+ * Returns: TRUE if the call was successful, FALSE otherwise.
**/
gboolean
e_cal_get_object (ECal *ecal, const gchar *uid, const gchar *rid, icalcomponent **icalcomp, GError **error)
@@ -2125,7 +2125,7 @@ e_cal_get_object (ECal *ecal, const gchar *uid, const gchar *rid, icalcomponent
* ID. This will return any recurring event and all its detached recurrences.
* For non-recurring events, it will just return the object with that ID.
*
- * Return value: TRUE if the call was successful, FALSE otherwise.
+ * Returns: TRUE if the call was successful, FALSE otherwise.
**/
gboolean
e_cal_get_objects_for_uid (ECal *ecal, const gchar *uid, GList **objects, GError **error)
@@ -2213,7 +2213,7 @@ e_cal_get_objects_for_uid (ECal *ecal, const gchar *uid, GList **objects, GError
*
* Resolves TZIDs for the recurrence generator.
*
- * Return value: The timezone identified by the @tzid argument, or %NULL if
+ * Returns: The timezone identified by the @tzid argument, or %NULL if
* it could not be found.
*/
icaltimezone*
@@ -2244,7 +2244,7 @@ e_cal_resolve_tzid_cb (const gchar *tzid, gpointer data)
* is identified by the @change_id argument, which is used by the backend to
* compute the changes done.
*
- * Return value: TRUE if the call was successful, FALSE otherwise.
+ * Returns: TRUE if the call was successful, FALSE otherwise.
*/
gboolean
e_cal_get_changes (ECal *ecal, const gchar *change_id, GList **changes, GError **error)
@@ -2354,7 +2354,7 @@ e_cal_free_change_list (GList *list)
* argument, which is a list of #icalcomponent. When done, this list
* should be freed by using the #e_cal_free_object_list function.
*
- * Return value: TRUE if the operation was successful, FALSE otherwise.
+ * Returns: TRUE if the operation was successful, FALSE otherwise.
**/
gboolean
e_cal_get_object_list (ECal *ecal, const gchar *query, GList **objects, GError **error)
@@ -2405,7 +2405,7 @@ e_cal_get_object_list (ECal *ecal, const gchar *query, GList **objects, GError *
* by the @query argument. The objects will be returned in the @objects
* argument, which is a list of #ECalComponent.
*
- * Return value: TRUE if the operation was successful, FALSE otherwise.
+ * Returns: TRUE if the operation was successful, FALSE otherwise.
*/
gboolean
e_cal_get_object_list_as_comp (ECal *ecal, const gchar *query, GList **objects, GError **error)
@@ -3093,7 +3093,7 @@ build_component_alarms_list (ECal *ecal, GList *object_list, time_t start, time_
* Queries a calendar for the alarms that trigger in the specified range of
* time.
*
- * Return value: A list of #ECalComponentAlarms structures. This should be freed
+ * Returns: A list of #ECalComponentAlarms structures. This should be freed
* using the #e_cal_free_alarms() function, or by freeing each element
* separately with #e_cal_component_alarms_free() and then freeing the list with
* #g_slist_free().
@@ -3183,7 +3183,7 @@ e_cal_free_alarms (GSList *comp_alarms)
* Queries a calendar for the alarms of a particular object that trigger in the
* specified range of time.
*
- * Return value: TRUE on success, FALSE if the object was not found.
+ * Returns: TRUE on success, FALSE if the object was not found.
**/
gboolean
e_cal_get_alarms_for_object (ECal *ecal, const ECalComponentId *id,
@@ -3238,7 +3238,7 @@ e_cal_get_alarms_for_object (ECal *ecal, const ECalComponentId *id,
* update internal information about the alarm be discarded, or, like
* the file backend does, ignore the operation.
*
- * Return value: TRUE if the operation was successful, FALSE otherwise.
+ * Returns: TRUE if the operation was successful, FALSE otherwise.
*/
gboolean
e_cal_discard_alarm (ECal *ecal, ECalComponent *comp, const gchar *auid, GError **error)
@@ -3427,7 +3427,7 @@ e_cal_get_component_as_string_internal (ECal *ecal,
* Gets a calendar component as an iCalendar string, with a toplevel
* VCALENDAR component and all VTIMEZONEs needed for the component.
*
- * Return value: the component as a complete iCalendar string, or NULL on
+ * Returns: the component as a complete iCalendar string, or NULL on
* failure. The string should be freed after use.
**/
gchar *
@@ -3447,7 +3447,7 @@ e_cal_get_component_as_string (ECal *ecal, icalcomponent *icalcomp)
* argument. Some backends would assign a specific UID to the newly created object,
* in those cases that UID would be returned in the @uid argument.
*
- * Return value: TRUE if the operation was successful, FALSE otherwise.
+ * Returns: TRUE if the operation was successful, FALSE otherwise.
*/
gboolean
e_cal_create_object (ECal *ecal, icalcomponent *icalcomp, gchar **uid, GError **error)
@@ -3505,7 +3505,7 @@ e_cal_create_object (ECal *ecal, icalcomponent *icalcomp, gchar **uid, GError **
* or a specific set of instances (CALOBJ_MOD_THISNADPRIOR and
* CALOBJ_MOD_THISANDFUTURE).
*
- * Return value: TRUE if the operation was successful, FALSE otherwise.
+ * Returns: TRUE if the operation was successful, FALSE otherwise.
*/
gboolean
e_cal_modify_object (ECal *ecal, icalcomponent *icalcomp, CalObjModType mod, GError **error)
@@ -3554,7 +3554,7 @@ e_cal_modify_object (ECal *ecal, icalcomponent *icalcomp, CalObjModType mod, GEr
* signal, while it will get a "obj_removed" signal when all instances
* are removed.
*
- * Return value: TRUE if the operation was successful, FALSE otherwise.
+ * Returns: TRUE if the operation was successful, FALSE otherwise.
*/
gboolean
e_cal_remove_object_with_mod (ECal *ecal, const gchar *uid,
@@ -3592,7 +3592,7 @@ e_cal_remove_object_with_mod (ECal *ecal, const gchar *uid,
* component, all clients will be notified and they will emit the "obj_removed"
* signal.
*
- * Return value: %TRUE if successful, %FALSE otherwise.
+ * Returns: %TRUE if successful, %FALSE otherwise.
**/
gboolean
e_cal_remove_object (ECal *ecal, const gchar *uid, GError **error)
@@ -3613,7 +3613,7 @@ e_cal_remove_object (ECal *ecal, const gchar *uid, GError **error)
* @icalcomp argument. This is used for iTIP confirmation/cancellation
* messages for scheduled meetings.
*
- * Return value: %TRUE if successful, %FALSE otherwise.
+ * Returns: %TRUE if successful, %FALSE otherwise.
*/
gboolean
e_cal_receive_objects (ECal *ecal, icalcomponent *icalcomp, GError **error)
@@ -3652,7 +3652,7 @@ e_cal_receive_objects (ECal *ecal, icalcomponent *icalcomp, GError **error)
* Requests a calendar backend to send meeting information to the specified list
* of users.
*
- * Return value: TRUE if the operation was successful, FALSE otherwise.
+ * Returns: TRUE if the operation was successful, FALSE otherwise.
*/
gboolean
e_cal_send_objects (ECal *ecal, icalcomponent *icalcomp, GList **users, icalcomponent **modified_icalcomp, GError **error)
@@ -3708,7 +3708,7 @@ e_cal_send_objects (ECal *ecal, icalcomponent *icalcomp, GList **users, icalcomp
*
* Retrieves a timezone object from the calendar backend.
*
- * Return value: TRUE if the operation was successful, FALSE otherwise.
+ * Returns: TRUE if the operation was successful, FALSE otherwise.
*/
gboolean
e_cal_get_timezone (ECal *ecal, const gchar *tzid, icaltimezone **zone, GError **error)
@@ -3876,7 +3876,7 @@ e_cal_add_timezone (ECal *ecal, icaltimezone *izone, GError **error)
*
* Creates a live query object from a loaded calendar.
*
- * Return value: A query object that will emit notification signals as calendar
+ * Returns: A query object that will emit notification signals as calendar
* components are added and removed from the query in the server.
**/
gboolean
@@ -3934,7 +3934,7 @@ e_cal_get_query (ECal *ecal, const gchar *sexp, ECalView **query, GError **error
* Sets the default timezone on the calendar. This should be called before opening
* the calendar.
*
- * Return value: TRUE if the operation was successful, FALSE otherwise.
+ * Returns: TRUE if the operation was successful, FALSE otherwise.
*/
gboolean
e_cal_set_default_timezone (ECal *ecal, icaltimezone *zone, GError **error)
@@ -4056,7 +4056,7 @@ check_default (ESource *source, gpointer data)
*
* Opens the default calendar.
*
- * Return value: TRUE if it opened correctly, FALSE otherwise.
+ * Returns: TRUE if it opened correctly, FALSE otherwise.
*/
gboolean
e_cal_open_default (ECal **ecal, ECalSourceType type, ECalAuthFunc func, gpointer data, GError **error)
@@ -4119,7 +4119,7 @@ e_cal_open_default (ECal **ecal, ECalSourceType type, ECalAuthFunc func, gpointe
*
* Sets a calendar as the default one.
*
- * Return value: TRUE if the operation was successful, FALSE otherwise.
+ * Returns: TRUE if the operation was successful, FALSE otherwise.
*/
gboolean
e_cal_set_default (ECal *ecal, GError **error)
@@ -4184,7 +4184,7 @@ set_default_source (ESourceList *sources, ESource *source, GError **error)
*
* Sets the default source for the specified @type.
*
- * Return value: TRUE if the operation was successful, FALSE otherwise.
+ * Returns: TRUE if the operation was successful, FALSE otherwise.
*/
gboolean
e_cal_set_default_source (ESource *source, ECalSourceType type, GError **error)
@@ -4219,7 +4219,7 @@ get_sources (ESourceList **sources, const gchar *key, GError **error)
*
* Gets the list of sources defined in the configuration for the given @type.
*
- * Return value: TRUE if the operation was successful, FALSE otherwise.
+ * Returns: TRUE if the operation was successful, FALSE otherwise.
*/
gboolean
e_cal_get_sources (ESourceList **sources, ECalSourceType type, GError **error)
diff --git a/calendar/libedata-cal/e-cal-backend-cache.c b/calendar/libedata-cal/e-cal-backend-cache.c
index ee63ac0..f84e9d4 100644
--- a/calendar/libedata-cal/e-cal-backend-cache.c
+++ b/calendar/libedata-cal/e-cal-backend-cache.c
@@ -255,7 +255,7 @@ e_cal_backend_cache_init (ECalBackendCache *cache)
* Creates a new #ECalBackendCache object, which implements a cache of
* calendar/tasks objects, very useful for remote backends.
*
- * Return value: The newly created object.
+ * Returns: The newly created object.
*/
ECalBackendCache *
e_cal_backend_cache_new (const gchar *uri, ECalSourceType source_type)
@@ -294,7 +294,7 @@ get_key (const gchar *uid, const gchar *rid)
*
* Gets a component from the %ECalBackendCache object.
*
- * Return value: The %ECalComponent representing the component found,
+ * Returns: The %ECalComponent representing the component found,
* or %NULL if it was not found in the cache.
*/
ECalComponent *
@@ -338,7 +338,7 @@ e_cal_backend_cache_get_component (ECalBackendCache *cache, const gchar *uid, co
* the component if it does not exist or replace it if there was a
* previous version of it.
*
- * Return value: TRUE if the operation was successful, FALSE otherwise.
+ * Returns: TRUE if the operation was successful, FALSE otherwise.
*/
gboolean
e_cal_backend_cache_put_component (ECalBackendCache *cache,
@@ -381,7 +381,7 @@ e_cal_backend_cache_put_component (ECalBackendCache *cache,
*
* Removes a component from the cache.
*
- * Return value: TRUE if the component was removed, FALSE otherwise.
+ * Returns: TRUE if the component was removed, FALSE otherwise.
*/
gboolean
e_cal_backend_cache_remove_component (ECalBackendCache *cache,
@@ -415,7 +415,7 @@ e_cal_backend_cache_remove_component (ECalBackendCache *cache,
*
* Retrieves a list of all the components stored in the cache.
*
- * Return value: A list of all the components. Each item in the list is
+ * Returns: A list of all the components. Each item in the list is
* an #ECalComponent, which should be freed when no longer needed.
*/
GList *
@@ -465,7 +465,7 @@ e_cal_backend_cache_get_components (ECalBackendCache *cache)
*
* Retrieves a ical components from the cache.
*
- * Return value: The list of calendar components if found, or NULL otherwise.
+ * Returns: The list of calendar components if found, or NULL otherwise.
*/
GSList *
e_cal_backend_cache_get_components_by_uid (ECalBackendCache *cache, const gchar *uid)
@@ -514,7 +514,7 @@ e_cal_backend_cache_get_components_by_uid (ECalBackendCache *cache, const gchar
*
* Retrieves a timezone component from the cache.
*
- * Return value: The timezone if found, or NULL otherwise.
+ * Returns: The timezone if found, or NULL otherwise.
*/
const icaltimezone *
e_cal_backend_cache_get_timezone (ECalBackendCache *cache, const gchar *tzid)
@@ -562,7 +562,7 @@ e_cal_backend_cache_get_timezone (ECalBackendCache *cache, const gchar *tzid)
* Puts the given timezone in the cache, adding it, if it did not exist, or
* replacing it, if there was an older version.
*
- * Return value: TRUE if the timezone was put on the cache, FALSE otherwise.
+ * Returns: TRUE if the timezone was put on the cache, FALSE otherwise.
*/
gboolean
e_cal_backend_cache_put_timezone (ECalBackendCache *cache, const icaltimezone *zone)
@@ -613,7 +613,7 @@ e_cal_backend_cache_put_timezone (ECalBackendCache *cache, const icaltimezone *z
*
* Sets the default timezone on the cache.
*
- * Return value: TRUE if the operation was successful, FALSE otherwise.
+ * Returns: TRUE if the operation was successful, FALSE otherwise.
*/
gboolean
e_cal_backend_cache_put_default_timezone (ECalBackendCache *cache, icaltimezone *default_zone)
@@ -656,7 +656,7 @@ e_cal_backend_cache_put_default_timezone (ECalBackendCache *cache, icaltimezone
*
* Retrieves the default timezone from the cache.
*
- * Return value: The default timezone, or NULL if no default timezone
+ * Returns: The default timezone, or NULL if no default timezone
* has been set on the cache.
*/
icaltimezone *
@@ -697,7 +697,7 @@ e_cal_backend_cache_get_default_timezone (ECalBackendCache *cache)
*
* Removes a timezone component from the cache.
*
- * Return value: TRUE if the timezone was removed, FALSE otherwise.
+ * Returns: TRUE if the timezone was removed, FALSE otherwise.
*/
gboolean
e_cal_backend_cache_remove_timezone (ECalBackendCache *cache, const gchar *tzid)
@@ -720,7 +720,7 @@ e_cal_backend_cache_remove_timezone (ECalBackendCache *cache, const gchar *tzid)
*
* Gets the list of unique keys in the cache file.
*
- * Return value: A list of all the keys. The items in the list are pointers
+ * Returns: A list of all the keys. The items in the list are pointers
* to internal data, so should not be freed, only the list should.
*/
GSList *
@@ -751,7 +751,7 @@ e_cal_backend_cache_set_marker (ECalBackendCache *cache)
* Gets the marker of the cache. If this field is present, it means the
* cache has been populated.
*
- * Return value: The value of the marker or NULL if the cache is still empty.
+ * Returns: The value of the marker or NULL if the cache is still empty.
*/
const gchar *
e_cal_backend_cache_get_marker (ECalBackendCache *cache)
@@ -767,7 +767,7 @@ e_cal_backend_cache_get_marker (ECalBackendCache *cache)
* @cache: An #ECalBackendCache object.
* @utc_str: UTC string.
*
- * Return value: TRUE if the operation was successful, FALSE otherwise.
+ * Returns: TRUE if the operation was successful, FALSE otherwise.
*/
gboolean
e_cal_backend_cache_put_server_utc_time (ECalBackendCache *cache, const gchar *utc_str)
@@ -786,7 +786,7 @@ e_cal_backend_cache_put_server_utc_time (ECalBackendCache *cache, const gchar *u
* e_cal_backend_cache_get_server_utc_time:
* @cache: An #ECalBackendCache object.
*
- * Return value: The server's UTC string.
+ * Returns: The server's UTC string.
*/
const gchar *
e_cal_backend_cache_get_server_utc_time (ECalBackendCache *cache)
@@ -811,7 +811,7 @@ get_keys_key (const gchar *key)
* @keyp: The Key parameter to identify uniquely.
* @valuep: The value for the keyp parameter.
*
- * Return value: TRUE if the operation was successful, FALSE otherwise.
+ * Returns: TRUE if the operation was successful, FALSE otherwise.
*/
gboolean
e_cal_backend_cache_put_key_value (ECalBackendCache *cache, const gchar *key, const gchar *value)
@@ -840,7 +840,7 @@ e_cal_backend_cache_put_key_value (ECalBackendCache *cache, const gchar *key, co
* e_cal_backend_cache_get_key_value:
* @cache: An #ECalBackendCache object.
*
- * Return value: The value.
+ * Returns: The value.
*/
const gchar *
e_cal_backend_cache_get_key_value (ECalBackendCache *cache, const gchar *key)
diff --git a/calendar/libedata-cal/e-cal-backend-factory.c b/calendar/libedata-cal/e-cal-backend-factory.c
index 44118fb..b34b139 100644
--- a/calendar/libedata-cal/e-cal-backend-factory.c
+++ b/calendar/libedata-cal/e-cal-backend-factory.c
@@ -33,7 +33,7 @@ e_cal_backend_factory_class_init (ECalBackendFactoryClass *klass)
*
* Gets the component type of the factory.
*
- * Return value: The kind of factory.
+ * Returns: The kind of factory.
*/
icalcomponent_kind
e_cal_backend_factory_get_kind (ECalBackendFactory *factory)
@@ -49,7 +49,7 @@ e_cal_backend_factory_get_kind (ECalBackendFactory *factory)
*
* Gets the protocol used by the factory.
*
- * Return value: The protocol.
+ * Returns: The protocol.
*/
const gchar *
e_cal_backend_factory_get_protocol (ECalBackendFactory *factory)
@@ -66,7 +66,7 @@ e_cal_backend_factory_get_protocol (ECalBackendFactory *factory)
*
* Creates a new backend for the given @source.
*
- * Return value: The newly created backend, or NULL if there was an error.
+ * Returns: The newly created backend, or NULL if there was an error.
*/
ECalBackend*
e_cal_backend_factory_new_backend (ECalBackendFactory *factory, ESource *source)
diff --git a/calendar/libedata-cal/e-cal-backend-sexp.c b/calendar/libedata-cal/e-cal-backend-sexp.c
index 6941a24..36f68ae 100644
--- a/calendar/libedata-cal/e-cal-backend-sexp.c
+++ b/calendar/libedata-cal/e-cal-backend-sexp.c
@@ -58,7 +58,7 @@ static ESExpResult *func_is_completed (ESExp *esexp, gint argc, ESExpResult **ar
*
* Processes the (time-now) sexp expression.
*
- * Return value: The result of the function.
+ * Returns: The result of the function.
*/
ESExpResult *
e_cal_backend_sexp_func_time_now (ESExp *esexp, gint argc, ESExpResult **argv, gpointer data)
@@ -89,7 +89,7 @@ e_cal_backend_sexp_func_time_now (ESExp *esexp, gint argc, ESExpResult **argv, g
*
* Constructs a time_t value for the specified date.
*
- * Return value: The result of the function.
+ * Returns: The result of the function.
*/
ESExpResult *
e_cal_backend_sexp_func_make_time (ESExp *esexp, gint argc, ESExpResult **argv, gpointer data)
@@ -149,7 +149,7 @@ e_cal_backend_sexp_func_make_time (ESExp *esexp, gint argc, ESExpResult **argv,
* FIXME: TIMEZONES - need to use a timezone or daylight saving changes will
* make the result incorrect.
*
- * Return value: The result of the function.
+ * Returns: The result of the function.
*/
ESExpResult *
e_cal_backend_sexp_func_time_add_day (ESExp *esexp, gint argc, ESExpResult **argv, gpointer data)
@@ -200,7 +200,7 @@ e_cal_backend_sexp_func_time_add_day (ESExp *esexp, gint argc, ESExpResult **arg
*
* FIXME: TIMEZONES - this uses the current Unix timezone.
*
- * Return value: The result of the function.
+ * Returns: The result of the function.
*/
ESExpResult *
e_cal_backend_sexp_func_time_day_begin (ESExp *esexp, gint argc, ESExpResult **argv, gpointer data)
@@ -242,7 +242,7 @@ e_cal_backend_sexp_func_time_day_begin (ESExp *esexp, gint argc, ESExpResult **a
*
* FIXME: TIMEZONES - this uses the current Unix timezone.
*
- * Return value: The result of the function.
+ * Returns: The result of the function.
*/
ESExpResult *
e_cal_backend_sexp_func_time_day_end (ESExp *esexp, gint argc, ESExpResult **argv, gpointer data)
@@ -1280,7 +1280,7 @@ static struct {
*
* Matches the given ECalComponent against the expression.
*
- * Return value: TRUE if the component matched the expression, FALSE if not.
+ * Returns: TRUE if the component matched the expression, FALSE if not.
*/
gboolean
e_cal_backend_sexp_match_comp (ECalBackendSExp *sexp, ECalComponent *comp, ECalBackend *backend)
@@ -1320,7 +1320,7 @@ e_cal_backend_sexp_match_comp (ECalBackendSExp *sexp, ECalComponent *comp, ECalB
*
* Match an iCalendar expression against the expression.
*
- * Return value: TRUE if the object matches the expression, FALSE if not.
+ * Returns: TRUE if the object matches the expression, FALSE if not.
*/
gboolean
e_cal_backend_sexp_match_object (ECalBackendSExp *sexp, const gchar *object, ECalBackend *backend)
@@ -1351,7 +1351,7 @@ e_cal_backend_sexp_match_object (ECalBackendSExp *sexp, const gchar *object, ECa
*
* Creates a new #EXCalBackendSExp object.
*
- * Return value: The newly created ECalBackendSExp object.
+ * Returns: The newly created ECalBackendSExp object.
*/
ECalBackendSExp *
e_cal_backend_sexp_new (const gchar *text)
@@ -1390,7 +1390,7 @@ e_cal_backend_sexp_new (const gchar *text)
*
* Retrieve the text expression for the given ECalBackendSExp object.
*
- * Return value: The text expression.
+ * Returns: The text expression.
*/
const gchar *
e_cal_backend_sexp_text (ECalBackendSExp *sexp)
diff --git a/calendar/libedata-cal/e-cal-backend-sync.c b/calendar/libedata-cal/e-cal-backend-sync.c
index 8896331..2bc6741 100644
--- a/calendar/libedata-cal/e-cal-backend-sync.c
+++ b/calendar/libedata-cal/e-cal-backend-sync.c
@@ -58,7 +58,7 @@ e_cal_backend_sync_set_lock (ECalBackendSync *backend, gboolean lock)
*
* Calls the is_read_only method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_is_read_only (ECalBackendSync *backend, EDataCal *cal, gboolean *read_only)
@@ -81,7 +81,7 @@ e_cal_backend_sync_is_read_only (ECalBackendSync *backend, EDataCal *cal, gbool
*
* Calls the get_cal_address method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_get_cal_address (ECalBackendSync *backend, EDataCal *cal, gchar **address)
@@ -104,7 +104,7 @@ e_cal_backend_sync_get_cal_address (ECalBackendSync *backend, EDataCal *cal, gc
*
* Calls the get_alarm_email_address method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_get_alarm_email_address (ECalBackendSync *backend, EDataCal *cal, gchar **address)
@@ -127,7 +127,7 @@ e_cal_backend_sync_get_alarm_email_address (ECalBackendSync *backend, EDataCal
*
* Calls the get_ldap_attribute method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_get_ldap_attribute (ECalBackendSync *backend, EDataCal *cal, gchar **attribute)
@@ -150,7 +150,7 @@ e_cal_backend_sync_get_ldap_attribute (ECalBackendSync *backend, EDataCal *cal,
*
* Calls the get_capabilities method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_get_static_capabilities (ECalBackendSync *backend, EDataCal *cal, gchar **capabilities)
@@ -176,7 +176,7 @@ e_cal_backend_sync_get_static_capabilities (ECalBackendSync *backend, EDataCal
*
* Calls the open method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_open (ECalBackendSync *backend, EDataCal *cal, gboolean only_if_exists,
@@ -198,7 +198,7 @@ e_cal_backend_sync_open (ECalBackendSync *backend, EDataCal *cal, gboolean only
*
* Calls the remove method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_remove (ECalBackendSync *backend, EDataCal *cal)
@@ -219,7 +219,7 @@ e_cal_backend_sync_remove (ECalBackendSync *backend, EDataCal *cal)
*
* Calls the refresh method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*
* Since: 2.30
*/
@@ -246,7 +246,7 @@ e_cal_backend_sync_refresh (ECalBackendSync *backend, EDataCal *cal)
*
* Calls the create_object method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_create_object (ECalBackendSync *backend, EDataCal *cal, gchar **calobj, gchar **uid)
@@ -275,7 +275,7 @@ e_cal_backend_sync_create_object (ECalBackendSync *backend, EDataCal *cal, gchar
*
* Calls the modify_object method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_modify_object (ECalBackendSync *backend, EDataCal *cal, const gchar *calobj,
@@ -308,7 +308,7 @@ e_cal_backend_sync_modify_object (ECalBackendSync *backend, EDataCal *cal, const
*
* Calls the remove_object method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_remove_object (ECalBackendSync *backend, EDataCal *cal, const gchar *uid, const gchar *rid,
@@ -334,7 +334,7 @@ e_cal_backend_sync_remove_object (ECalBackendSync *backend, EDataCal *cal, const
*
* Calls the discard_alarm method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_discard_alarm (ECalBackendSync *backend, EDataCal *cal, const gchar *uid, const gchar *auid)
@@ -358,7 +358,7 @@ e_cal_backend_sync_discard_alarm (ECalBackendSync *backend, EDataCal *cal, const
*
* Calls the receive_objects method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_receive_objects (ECalBackendSync *backend, EDataCal *cal, const gchar *calobj)
@@ -384,7 +384,7 @@ e_cal_backend_sync_receive_objects (ECalBackendSync *backend, EDataCal *cal, con
*
* Calls the send_objects method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_send_objects (ECalBackendSync *backend, EDataCal *cal, const gchar *calobj, GList **users,
@@ -409,7 +409,7 @@ e_cal_backend_sync_send_objects (ECalBackendSync *backend, EDataCal *cal, const
*
* Calls the get_default_object method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_get_default_object (ECalBackendSync *backend, EDataCal *cal, gchar **object)
@@ -435,7 +435,7 @@ e_cal_backend_sync_get_default_object (ECalBackendSync *backend, EDataCal *cal,
*
* Calls the get_object method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_get_object (ECalBackendSync *backend, EDataCal *cal, const gchar *uid, const gchar *rid, gchar **object)
@@ -459,7 +459,7 @@ e_cal_backend_sync_get_object (ECalBackendSync *backend, EDataCal *cal, const gc
*
* Calls the get_object_list method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_get_object_list (ECalBackendSync *backend, EDataCal *cal, const gchar *sexp, GList **objects)
@@ -484,7 +484,7 @@ e_cal_backend_sync_get_object_list (ECalBackendSync *backend, EDataCal *cal, con
*
* Calls the get_attachment_list method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_get_attachment_list (ECalBackendSync *backend, EDataCal *cal, const gchar *uid, const gchar *rid, GSList **attachments)
@@ -514,7 +514,7 @@ e_cal_backend_sync_get_attachment_list (ECalBackendSync *backend, EDataCal *cal,
* internal_get_timezone and can skip implementation of
* get_timezone_sync completely.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_get_timezone (ECalBackendSync *backend, EDataCal *cal, const gchar *tzid, gchar **object)
@@ -563,7 +563,7 @@ e_cal_backend_sync_get_timezone (ECalBackendSync *backend, EDataCal *cal, const
*
* Calls the add_timezone method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_add_timezone (ECalBackendSync *backend, EDataCal *cal, const gchar *tzobj)
@@ -585,7 +585,7 @@ e_cal_backend_sync_add_timezone (ECalBackendSync *backend, EDataCal *cal, const
*
* Calls the set_default_timezone method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_set_default_zone (ECalBackendSync *backend, EDataCal *cal, const gchar *tz)
@@ -629,7 +629,7 @@ e_cal_backend_sync_set_default_zone (ECalBackendSync *backend, EDataCal *cal, co
*
* Calls the set_default_timezone method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_set_default_timezone (ECalBackendSync *backend, EDataCal *cal, const gchar *tzid)
@@ -654,7 +654,7 @@ e_cal_backend_sync_set_default_timezone (ECalBackendSync *backend, EDataCal *cal
*
* Calls the get_changes method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_get_changes (ECalBackendSync *backend, EDataCal *cal, const gchar *change_id,
@@ -680,7 +680,7 @@ e_cal_backend_sync_get_changes (ECalBackendSync *backend, EDataCal *cal, const g
*
* Calls the get_free_busy method on the given backend.
*
- * Return value: Status code.
+ * Returns: Status code.
*/
ECalBackendSyncStatus
e_cal_backend_sync_get_free_busy (ECalBackendSync *backend, EDataCal *cal, GList *users,
diff --git a/calendar/libedata-cal/e-cal-backend-util.c b/calendar/libedata-cal/e-cal-backend-util.c
index 7e06c5f..5774355 100644
--- a/calendar/libedata-cal/e-cal-backend-util.c
+++ b/calendar/libedata-cal/e-cal-backend-util.c
@@ -37,7 +37,7 @@ static EAccountList *accounts;
*
* Retrieve the default mail account as stored in Evolution configuration.
*
- * Return value: TRUE if there is a default account, FALSE otherwise.
+ * Returns: TRUE if there is a default account, FALSE otherwise.
*/
gboolean
e_cal_backend_mail_account_get_default (gchar **address, gchar **name)
@@ -68,7 +68,7 @@ e_cal_backend_mail_account_get_default (gchar **address, gchar **name)
*
* Checks that a mail account is valid, and returns its name.
*
- * Return value: TRUE if the account is valid, FALSE if not.
+ * Returns: TRUE if the account is valid, FALSE if not.
*/
gboolean
e_cal_backend_mail_account_is_valid (gchar *user, gchar **name)
@@ -155,10 +155,11 @@ e_cal_backend_status_to_string (GNOME_Evolution_Calendar_CallStatus status)
/**
* is_attendee_declined:
- * @param icalcomp Component where to check the attendee list.
- * @param email Attendee's email to look for.
- * @return Whether the required attendee declined or not.
- * It's not necessary to have this attendee in the list.
+ * @icalcomp: Component where to check the attendee list.
+ * @email: Attendee's email to look for.
+ *
+ * Returns: Whether the required attendee declined or not.
+ * It's not necessary to have this attendee in the list.
**/
static gboolean
is_attendee_declined (icalcomponent *icalcomp, const gchar *email)
@@ -202,9 +203,10 @@ is_attendee_declined (icalcomponent *icalcomp, const gchar *email)
/**
* e_cal_backend_user_declined:
- * @param icalcomp Component where to check.
- * @return Whether icalcomp contains attendee with a mail same as any of configured
- * enabled mail account and whether this user declined.
+ * @icalcomp: Component where to check.
+ *
+ * Returns: Whether icalcomp contains attendee with a mail same as any of
+ * configured enabled mail account and whether this user declined.
*
* Since: 2.26
**/
diff --git a/calendar/libedata-cal/e-cal-backend.c b/calendar/libedata-cal/e-cal-backend.c
index afdb557..f5fb71b 100644
--- a/calendar/libedata-cal/e-cal-backend.c
+++ b/calendar/libedata-cal/e-cal-backend.c
@@ -324,7 +324,7 @@ e_cal_backend_finalize (GObject *object)
*
* Gets the #ESource associated with the given backend.
*
- * Return value: The #ESource for the backend.
+ * Returns: The #ESource for the backend.
*/
ESource *
e_cal_backend_get_source (ECalBackend *backend)
@@ -346,7 +346,7 @@ e_cal_backend_get_source (ECalBackend *backend)
* Queries the URI of a calendar backend, which must already have an open
* calendar.
*
- * Return value: The URI where the calendar is stored.
+ * Returns: The URI where the calendar is stored.
**/
const gchar *
e_cal_backend_get_uri (ECalBackend *backend)
@@ -367,7 +367,7 @@ e_cal_backend_get_uri (ECalBackend *backend)
*
* Gets the kind of components the given backend stores.
*
- * Return value: The kind of components for this backend.
+ * Returns: The kind of components for this backend.
*/
icalcomponent_kind
e_cal_backend_get_kind (ECalBackend *backend)
@@ -484,7 +484,7 @@ e_cal_backend_add_query (ECalBackend *backend, EDataCalView *query)
*
* Gets the list of live queries being run on the given backend.
*
- * Return value: The list of live queries.
+ * Returns: The list of live queries.
*/
EList *
e_cal_backend_get_queries (ECalBackend *backend)
@@ -679,7 +679,7 @@ e_cal_backend_remove (ECalBackend *backend, EDataCal *cal, EServerMethodContext
*
* Queries whether a calendar backend has been loaded yet.
*
- * Return value: TRUE if the backend has been loaded with data, FALSE
+ * Returns: TRUE if the backend has been loaded with data, FALSE
* otherwise.
*/
gboolean
@@ -737,7 +737,7 @@ e_cal_backend_start_query (ECalBackend *backend, EDataCalView *query)
*
* Queries whether a calendar backend is connected remotely.
*
- * Return value: The current mode the calendar is in
+ * Returns: The current mode the calendar is in
**/
CalMode
e_cal_backend_get_mode (ECalBackend *backend)
diff --git a/calendar/libedata-cal/e-data-cal-view.c b/calendar/libedata-cal/e-data-cal-view.c
index f76f559..6a0c113 100644
--- a/calendar/libedata-cal/e-data-cal-view.c
+++ b/calendar/libedata-cal/e-data-cal-view.c
@@ -444,7 +444,7 @@ e_data_cal_view_finalize (GObject *object)
*
* Get the expression used for the given query.
*
- * Return value: the query expression used to search.
+ * Returns: the query expression used to search.
*/
const gchar *
e_data_cal_view_get_text (EDataCalView *query)
@@ -460,7 +460,7 @@ e_data_cal_view_get_text (EDataCalView *query)
*
* Get the #ECalBackendSExp object used for the given query.
*
- * Return value: The expression object used to search.
+ * Returns: The expression object used to search.
*/
ECalBackendSExp *
e_data_cal_view_get_object_sexp (EDataCalView *query)
@@ -478,7 +478,7 @@ e_data_cal_view_get_object_sexp (EDataCalView *query)
* Compares the given @object to the regular expression used for the
* given query.
*
- * Return value: TRUE if the object matches the expression, FALSE if not.
+ * Returns: TRUE if the object matches the expression, FALSE if not.
*/
gboolean
e_data_cal_view_object_matches (EDataCalView *query, const gchar *object)
@@ -500,7 +500,7 @@ e_data_cal_view_object_matches (EDataCalView *query, const gchar *object)
*
* Gets the list of objects already matched for the given query.
*
- * Return value: A list of matched objects.
+ * Returns: A list of matched objects.
*/
GList *
e_data_cal_view_get_matched_objects (EDataCalView *query)
@@ -516,7 +516,7 @@ e_data_cal_view_get_matched_objects (EDataCalView *query)
*
* Checks whether the given query has already been started.
*
- * Return value: TRUE if the query has already been started, FALSE otherwise.
+ * Returns: TRUE if the query has already been started, FALSE otherwise.
*/
gboolean
e_data_cal_view_is_started (EDataCalView *view)
@@ -535,7 +535,7 @@ e_data_cal_view_is_started (EDataCalView *view)
* changes will be sent. In fact, even after done, notifications will still be sent
* if there are changes in the objects matching the query search expression.
*
- * Return value: TRUE if the query is done, FALSE if still in progress.
+ * Returns: TRUE if the query is done, FALSE if still in progress.
*/
gboolean
e_data_cal_view_is_done (EDataCalView *query)
@@ -556,7 +556,7 @@ e_data_cal_view_is_done (EDataCalView *query)
* Gets the status code obtained when the initial matching of objects was done
* for the given query.
*
- * Return value: The query status.
+ * Returns: The query status.
*/
EDataCalCallStatus
e_data_cal_view_get_done_status (EDataCalView *query)
diff --git a/camel/camel-block-file.c b/camel/camel-block-file.c
index 673ff80..c64d1e4 100644
--- a/camel/camel-block-file.c
+++ b/camel/camel-block-file.c
@@ -360,7 +360,7 @@ camel_cache_remove(c, key);
*
* @block_size is currently ignored and is set to CAMEL_BLOCK_SIZE.
*
- * Return value: The new block file, or NULL if it could not be created.
+ * Returns: The new block file, or NULL if it could not be created.
**/
CamelBlockFile *camel_block_file_new(const gchar *path, gint flags, const gchar version[8], gsize block_size)
{
@@ -466,7 +466,7 @@ camel_block_file_delete(CamelBlockFile *bs)
* Allocate a new block, return a pointer to it. Old blocks
* may be flushed to disk during this call.
*
- * Return value: The block, or NULL if an error occured.
+ * Returns: The block, or NULL if an error occured.
**/
CamelBlock *camel_block_file_new_block(CamelBlockFile *bs)
{
@@ -531,7 +531,7 @@ gint camel_block_file_free_block(CamelBlockFile *bs, camel_block_t id)
*
* Retreive a block @id.
*
- * Return value: The block, or NULL if blockid is invalid or a file error
+ * Returns: The block, or NULL if blockid is invalid or a file error
* occured.
**/
CamelBlock *camel_block_file_get_block(CamelBlockFile *bs, camel_block_t id)
@@ -747,7 +747,7 @@ sync_nolock(CamelBlockFile *bs)
* Flush a block to disk immediately. The block will only
* be flushed to disk if it is marked as dirty (touched).
*
- * Return value: -1 on io error.
+ * Returns: -1 on io error.
**/
gint camel_block_file_sync_block(CamelBlockFile *bs, CamelBlock *bl)
{
@@ -770,7 +770,7 @@ gint camel_block_file_sync_block(CamelBlockFile *bs, CamelBlock *bl)
*
* Sync all dirty blocks to disk, including the root block.
*
- * Return value: -1 on io error.
+ * Returns: -1 on io error.
**/
gint camel_block_file_sync(CamelBlockFile *bs)
{
@@ -974,7 +974,7 @@ key_file_unuse(CamelKeyFile *bs)
*
* Create a new key file. A linked list of record blocks.
*
- * Return value: A new key file, or NULL if the file could not
+ * Returns: A new key file, or NULL if the file could not
* be opened/created/initialised.
**/
CamelKeyFile *
@@ -1083,7 +1083,7 @@ camel_key_file_delete(CamelKeyFile *kf)
*
* Write a new list of records to the key file.
*
- * Return value: -1 on io error. The key file will remain unchanged.
+ * Returns: -1 on io error. The key file will remain unchanged.
**/
gint
camel_key_file_write(CamelKeyFile *kf, camel_block_t *parent, gsize len, camel_key_t *records)
@@ -1138,7 +1138,7 @@ camel_key_file_write(CamelKeyFile *kf, camel_block_t *parent, gsize len, camel_k
* Read the next block of data from the key file. Returns the number of
* records.
*
- * Return value: -1 on io error.
+ * Returns: -1 on io error.
**/
gint
camel_key_file_read(CamelKeyFile *kf, camel_block_t *start, gsize *len, camel_key_t **records)
diff --git a/camel/camel-cipher-context.c b/camel/camel-cipher-context.c
index fc4e233..5c75487 100644
--- a/camel/camel-cipher-context.c
+++ b/camel/camel-cipher-context.c
@@ -60,7 +60,7 @@ static CamelObjectClass *parent_class = NULL;
* This creates a new CamelCipherContext object which is used to sign,
* verify, encrypt and decrypt streams.
*
- * Return value: the new CamelCipherContext
+ * Returns: the new CamelCipherContext
**/
CamelCipherContext *
camel_cipher_context_new (CamelSession *session)
@@ -115,7 +115,7 @@ cipher_sign (CamelCipherContext *ctx, const gchar *userid, CamelCipherHash hash,
* Converts the (unsigned) part @ipart into a new self-contained mime part @opart.
* This may be a multipart/signed part, or a simple part for enveloped types.
*
- * Return value: 0 for success or -1 for failure.
+ * Returns: 0 for success or -1 for failure.
**/
gint
camel_cipher_sign (CamelCipherContext *context, const gchar *userid, CamelCipherHash hash,
@@ -157,7 +157,7 @@ cipher_verify (CamelCipherContext *context, struct _CamelMimePart *sigpart, Came
* @sigstream is assumed to be the signature stream and is used to
* verify the integirity of the @istream.
*
- * Return value: a CamelCipherValidity structure containing information
+ * Returns: a CamelCipherValidity structure containing information
* about the integrity of the input stream or %NULL on failure to
* execute at all.
**/
@@ -202,7 +202,7 @@ cipher_encrypt (CamelCipherContext *context, const gchar *userid, GPtrArray *rec
* Encrypts (and optionally signs) the cleartext input stream and
* writes the resulting ciphertext to the output stream.
*
- * Return value: 0 for success or -1 for failure.
+ * Returns: 0 for success or -1 for failure.
**/
gint
camel_cipher_encrypt (CamelCipherContext *context, const gchar *userid, GPtrArray *recipients,
@@ -242,7 +242,7 @@ cipher_decrypt(CamelCipherContext *context, struct _CamelMimePart *ipart, struct
*
* Decrypts @ipart into @opart.
*
- * Return value: A validity/encryption status.
+ * Returns: A validity/encryption status.
**/
CamelCipherValidity *
camel_cipher_decrypt(CamelCipherContext *context, struct _CamelMimePart *ipart, struct _CamelMimePart *opart, CamelException *ex)
@@ -674,7 +674,7 @@ cc_prepare_sign(CamelMimePart *part)
*
* The transfer encoding paramaters for the part may be changed by this function.
*
- * Return value: -1 on error;
+ * Returns: -1 on error;
**/
gint
camel_cipher_canonical_to_stream(CamelMimePart *part, guint32 flags, CamelStream *ostream)
diff --git a/camel/camel-data-cache.c b/camel/camel-data-cache.c
index 799d2d6..802b69d 100644
--- a/camel/camel-data-cache.c
+++ b/camel/camel-data-cache.c
@@ -122,7 +122,7 @@ camel_data_cache_get_type(void)
*
* Create a new data cache.
*
- * Return value: A new cache object, or NULL if the base path cannot
+ * Returns: A new cache object, or NULL if the base path cannot
* be written to.
**/
CamelDataCache *
@@ -282,7 +282,7 @@ data_cache_path(CamelDataCache *cdc, gint create, const gchar *path, const gchar
* Potentially, expiry processing will be performed while this call
* is executing.
*
- * Return value: A CamelStream (file) opened in read-write mode.
+ * Returns: A CamelStream (file) opened in read-write mode.
* The caller must unref this when finished.
**/
CamelStream *
@@ -327,7 +327,7 @@ camel_data_cache_add(CamelDataCache *cdc, const gchar *path, const gchar *key, C
* multiple callers, so ensure the stream is in a valid state
* through external locking.
*
- * Return value: A cache item, or NULL if the cache item does not exist.
+ * Returns: A cache item, or NULL if the cache item does not exist.
**/
CamelStream *
camel_data_cache_get(CamelDataCache *cdc, const gchar *path, const gchar *key, CamelException *ex)
@@ -358,7 +358,7 @@ camel_data_cache_get(CamelDataCache *cdc, const gchar *path, const gchar *key, C
*
* Lookup the filename for an item in the cache
*
- * Return value: The filename for a cache item
+ * Returns: The filename for a cache item
*
* Since: 2.26
**/
@@ -381,7 +381,7 @@ camel_data_cache_get_filename (CamelDataCache *cdc, const gchar *path, const gch
*
* Remove/expire a cache item.
*
- * Return value:
+ * Returns:
**/
gint
camel_data_cache_remove(CamelDataCache *cdc, const gchar *path, const gchar *key, CamelException *ex)
@@ -424,7 +424,7 @@ camel_data_cache_remove(CamelDataCache *cdc, const gchar *path, const gchar *key
*
* CURRENTLY UNIMPLEMENTED
*
- * Return value: -1 on error.
+ * Returns: -1 on error.
**/
gint camel_data_cache_rename(CamelDataCache *cache,
const gchar *old, const gchar *new, CamelException *ex)
@@ -443,7 +443,7 @@ gint camel_data_cache_rename(CamelDataCache *cache,
*
* CURRENTLY_UNIMPLEMENTED
*
- * Return value: -1 on error.
+ * Returns: -1 on error.
**/
gint
camel_data_cache_clear(CamelDataCache *cache, const gchar *path, CamelException *ex)
diff --git a/camel/camel-debug.c b/camel/camel-debug.c
index 91cf5cf..da7db58 100644
--- a/camel/camel-debug.c
+++ b/camel/camel-debug.c
@@ -84,7 +84,7 @@ void camel_debug_init(void)
* returns a boolean to indicate if the module or module and target is
* currently activated for debug output.
*
- * Return value:
+ * Returns:
**/
gboolean camel_debug(const gchar *mode)
{
@@ -126,7 +126,7 @@ static pthread_mutex_t debug_lock = PTHREAD_MUTEX_INITIALIZER;
* Start debug output for a given mode, used to make sure debug output
* is output atomically and not interspersed with unrelated stuff.
*
- * Return value: Returns true if mode is set, and in which case, you must
+ * Returns: Returns true if mode is set, and in which case, you must
* call debug_end when finished any screen output.
**/
gboolean
diff --git a/camel/camel-digest-store.c b/camel/camel-digest-store.c
index 925095c..e49efa6 100644
--- a/camel/camel-digest-store.c
+++ b/camel/camel-digest-store.c
@@ -126,7 +126,7 @@ digest_getv (CamelObject *object, CamelException *ex, CamelArgGetV *args)
*
* Create a new CamelDigestStore object.
*
- * Return value: A new CamelDigestStore widget.
+ * Returns: A new CamelDigestStore widget.
**/
CamelStore *
camel_digest_store_new (const gchar *url)
diff --git a/camel/camel-disco-store.c b/camel/camel-disco-store.c
index 3148d9c..0771bde 100644
--- a/camel/camel-disco-store.c
+++ b/camel/camel-disco-store.c
@@ -276,7 +276,7 @@ disco_get_folder_info (CamelStore *store, const gchar *top,
* camel_disco_store_status:
* @store: a disconnectable store
*
- * Return value: the current online/offline status of @store.
+ * Returns: the current online/offline status of @store.
**/
CamelDiscoStoreStatus
camel_disco_store_status (CamelDiscoStore *store)
@@ -372,7 +372,7 @@ can_work_offline (CamelDiscoStore *disco_store)
* camel_disco_store_can_work_offline:
* @store: a disconnectable store
*
- * Return value: whether or not @store can be used offline. (Will be
+ * Returns: whether or not @store can be used offline. (Will be
* %FALSE if the store is not caching data to local disk, for example.)
**/
gboolean
@@ -390,7 +390,7 @@ camel_disco_store_can_work_offline (CamelDiscoStore *store)
* can be used as a simple way to set a generic error message in @ex
* for operations that won't work offline.
*
- * Return value: whether or not @store is online.
+ * Returns: whether or not @store is online.
**/
gboolean
camel_disco_store_check_online (CamelDiscoStore *store, CamelException *ex)
diff --git a/camel/camel-file-utils.c b/camel/camel-file-utils.c
index 55e33cf..0c6d891 100644
--- a/camel/camel-file-utils.c
+++ b/camel/camel-file-utils.c
@@ -53,7 +53,7 @@
*
* Utility function to save an uint32 to a file.
*
- * Return value: %0 on success, %-1 on error.
+ * Returns: %0 on success, %-1 on error.
**/
gint
camel_file_util_encode_uint32 (FILE *out, guint32 value)
@@ -77,7 +77,7 @@ camel_file_util_encode_uint32 (FILE *out, guint32 value)
*
* Retrieve an encoded uint32 from a file.
*
- * Return value: %0 on success, %-1 on error. @*dest will contain the
+ * Returns: %0 on success, %-1 on error. @*dest will contain the
* decoded value.
**/
gint
@@ -108,7 +108,7 @@ camel_file_util_decode_uint32 (FILE *in, guint32 *dest)
* Encode a gint32, performing no compression, but converting
* to network order.
*
- * Return value: %0 on success, %-1 on error.
+ * Returns: %0 on success, %-1 on error.
**/
gint
camel_file_util_encode_fixed_int32 (FILE *out, gint32 value)
@@ -128,7 +128,7 @@ camel_file_util_encode_fixed_int32 (FILE *out, gint32 value)
*
* Retrieve a gint32.
*
- * Return value: %0 on success, %-1 on error.
+ * Returns: %0 on success, %-1 on error.
**/
gint
camel_file_util_decode_fixed_int32 (FILE *in, gint32 *dest)
@@ -181,7 +181,7 @@ camel_file_util_decode_##type(FILE *in, type *dest) \
*
* Encode a time_t value to the file.
*
- * Return value: %0 on success, %-1 on error.
+ * Returns: %0 on success, %-1 on error.
**/
CFU_ENCODE_T(time_t)
@@ -192,7 +192,7 @@ CFU_ENCODE_T(time_t)
*
* Decode a time_t value.
*
- * Return value: %0 on success, %-1 on error.
+ * Returns: %0 on success, %-1 on error.
**/
CFU_DECODE_T(time_t)
@@ -203,7 +203,7 @@ CFU_DECODE_T(time_t)
*
* Encode an off_t type.
*
- * Return value: %0 on success, %-1 on error.
+ * Returns: %0 on success, %-1 on error.
**/
CFU_ENCODE_T(off_t)
@@ -214,7 +214,7 @@ CFU_ENCODE_T(off_t)
*
* Decode an off_t type.
*
- * Return value: %0 on success, %-1 on failure.
+ * Returns: %0 on success, %-1 on failure.
**/
CFU_DECODE_T(off_t)
@@ -225,7 +225,7 @@ CFU_DECODE_T(off_t)
*
* Encode an gsize type.
*
- * Return value: %0 on success, %-1 on error.
+ * Returns: %0 on success, %-1 on error.
**/
CFU_ENCODE_T(gsize)
@@ -236,7 +236,7 @@ CFU_ENCODE_T(gsize)
*
* Decode an gsize type.
*
- * Return value: %0 on success, %-1 on failure.
+ * Returns: %0 on success, %-1 on failure.
**/
CFU_DECODE_T(gsize)
@@ -247,7 +247,7 @@ CFU_DECODE_T(gsize)
*
* Encode a normal string and save it in the output file.
*
- * Return value: %0 on success, %-1 on error.
+ * Returns: %0 on success, %-1 on error.
**/
gint
camel_file_util_encode_string (FILE *out, const gchar *str)
@@ -274,7 +274,7 @@ camel_file_util_encode_string (FILE *out, const gchar *str)
*
* Decode a normal string from the input file.
*
- * Return value: %0 on success, %-1 on error.
+ * Returns: %0 on success, %-1 on error.
**/
gint
camel_file_util_decode_string (FILE *in, gchar **str)
@@ -315,7 +315,7 @@ camel_file_util_decode_string (FILE *in, gchar **str)
* Unlike @camel_file_util_encode_string, it pads the
* @str with "NULL" bytes, if @len is > strlen(str)
*
- * Return value: %0 on success, %-1 on error.
+ * Returns: %0 on success, %-1 on error.
**/
gint
camel_file_util_encode_fixed_string (FILE *out, const gchar *str, gsize len)
@@ -347,7 +347,7 @@ camel_file_util_encode_fixed_string (FILE *out, const gchar *str, gsize len)
*
* Decode a normal string from the input file.
*
- * Return value: %0 on success, %-1 on error.
+ * Returns: %0 on success, %-1 on error.
**/
gint
camel_file_util_decode_fixed_string (FILE *in, gchar **str, gsize len)
@@ -726,7 +726,7 @@ camel_write_socket (gint fd, const gchar *buf, gsize n)
* basename of @filename, for instance used in a two-stage commit file
* write.
*
- * Return value: The new pathname. It must be free'd with g_free().
+ * Returns: The new pathname. It must be free'd with g_free().
**/
gchar *
camel_file_util_savename(const gchar *filename)
diff --git a/camel/camel-filter-driver.c b/camel/camel-filter-driver.c
index cdfe7cc..7a85339 100644
--- a/camel/camel-filter-driver.c
+++ b/camel/camel-filter-driver.c
@@ -279,7 +279,7 @@ camel_filter_driver_finalise (CamelObject *obj)
/**
* camel_filter_driver_new:
*
- * Return value: A new CamelFilterDriver object
+ * Returns: A new CamelFilterDriver object
**/
CamelFilterDriver *
camel_filter_driver_new (CamelSession *session)
diff --git a/camel/camel-folder-search.c b/camel/camel-folder-search.c
index 27af4a6..93ac4ee 100644
--- a/camel/camel-folder-search.c
+++ b/camel/camel-folder-search.c
@@ -252,7 +252,7 @@ camel_folder_search_construct (CamelFolderSearch *search)
* Particular methods may be overriden by an implementation to
* implement a search for any sort of backend.
*
- * Return value: A new CamelFolderSearch widget.
+ * Returns: A new CamelFolderSearch widget.
**/
CamelFolderSearch *
camel_folder_search_new (void)
@@ -329,7 +329,7 @@ camel_folder_search_set_body_index(CamelFolderSearch *search, CamelIndex *index)
* TODO: The interface should probably return summary items instead
* (since they are much more useful to any client).
*
- * Return value: A GPtrArray of strings of all matching messages.
+ * Returns: A GPtrArray of strings of all matching messages.
* This must only be freed by camel_folder_search_free_result.
**/
GPtrArray *
@@ -418,7 +418,7 @@ camel_folder_search_execute_expression(CamelFolderSearch *search, const gchar *e
* Run a search. Search must have had Folder already set on it, and
* it must implement summaries.
*
- * Return value: Number of messages that match the query.
+ * Returns: Number of messages that match the query.
*
* Since: 2.26
**/
@@ -565,7 +565,7 @@ do_search_in_memory (const gchar *expr)
* Run a search. Search must have had Folder already set on it, and
* it must implement summaries.
*
- * Return value:
+ * Returns:
**/
GPtrArray *
camel_folder_search_search(CamelFolderSearch *search, const gchar *expr, GPtrArray *uids, CamelException *ex)
diff --git a/camel/camel-folder-thread.c b/camel/camel-folder-thread.c
index 4c3b51e..8b13ebe 100644
--- a/camel/camel-folder-thread.c
+++ b/camel/camel-folder-thread.c
@@ -591,7 +591,7 @@ thread_summary(CamelFolderThread *thread, GPtrArray *summary)
*
* This function is probably to be removed soon.
*
- * Return value: A CamelFolderThread contianing a tree of CamelFolderThreadNode's
+ * Returns: A CamelFolderThread contianing a tree of CamelFolderThreadNode's
* which represent the threaded structure of the messages.
**/
CamelFolderThread *
@@ -728,7 +728,7 @@ camel_folder_thread_messages_unref(CamelFolderThread *thread)
* life of the CamelFolderThread created by this function, and it is upto the
* caller to ensure this.
*
- * Return value: A CamelFolderThread contianing a tree of CamelFolderThreadNode's
+ * Returns: A CamelFolderThread contianing a tree of CamelFolderThreadNode's
* which represent the threaded structure of the messages.
**/
CamelFolderThread *
diff --git a/camel/camel-html-parser.c b/camel/camel-html-parser.c
index 4efa277..1c1fb43 100644
--- a/camel/camel-html-parser.c
+++ b/camel/camel-html-parser.c
@@ -117,7 +117,7 @@ camel_html_parser_class_init (CamelHTMLParserClass *klass)
*
* Create a new CamelHTMLParser object.
*
- * Return value: A new CamelHTMLParser widget.
+ * Returns: A new CamelHTMLParser widget.
**/
CamelHTMLParser *
camel_html_parser_new (void)
diff --git a/camel/camel-http-stream.c b/camel/camel-http-stream.c
index 3d2d5e9..cbab535 100644
--- a/camel/camel-http-stream.c
+++ b/camel/camel-http-stream.c
@@ -143,7 +143,7 @@ camel_http_stream_get_type (void)
* @session: active session
* @url: URL to act upon
*
- * Return value: a http stream
+ * Returns: a http stream
**/
CamelStream *
camel_http_stream_new (CamelHttpMethod method, struct _CamelSession *session, CamelURL *url)
diff --git a/camel/camel-list-utils.c b/camel/camel-list-utils.c
index 86606ac..a8a47c5 100644
--- a/camel/camel-list-utils.c
+++ b/camel/camel-list-utils.c
@@ -50,7 +50,7 @@ camel_dlist_init (CamelDList *v)
*
* Add the list node @n to the head (start) of the list @l.
*
- * Return value: @n.
+ * Returns: @n.
**/
CamelDListNode *
camel_dlist_addhead (CamelDList *l, CamelDListNode *n)
@@ -69,7 +69,7 @@ camel_dlist_addhead (CamelDList *l, CamelDListNode *n)
*
* Add the list onde @n to the tail (end) of the list @l.
*
- * Return value: @n.
+ * Returns: @n.
**/
CamelDListNode *
camel_dlist_addtail (CamelDList *l, CamelDListNode *n)
@@ -87,7 +87,7 @@ camel_dlist_addtail (CamelDList *l, CamelDListNode *n)
*
* Remove @n from the list it's in. @n must belong to a list.
*
- * Return value: @n.
+ * Returns: @n.
**/
CamelDListNode *
camel_dlist_remove (CamelDListNode *n)
@@ -127,7 +127,7 @@ camel_dlist_remhead (CamelDList *l)
*
* Remove the last node in the list.
*
- * Return value: The previously last-node in the list, or NULL if @l
+ * Returns: The previously last-node in the list, or NULL if @l
* is an empty list.
**/
CamelDListNode *
@@ -151,7 +151,7 @@ camel_dlist_remtail (CamelDList *l)
*
* Returns %TRUE if @l is an empty list.
*
- * Return value: %TRUE if @l is an empty list, %FALSE otherwise.
+ * Returns: %TRUE if @l is an empty list, %FALSE otherwise.
**/
gint
camel_dlist_empty (CamelDList *l)
@@ -165,7 +165,7 @@ camel_dlist_empty (CamelDList *l)
*
* Returns the number of nodes in the list @l.
*
- * Return value: The number of nodes.
+ * Returns: The number of nodes.
**/
gint
camel_dlist_length (CamelDList *l)
diff --git a/camel/camel-lock.c b/camel/camel-lock.c
index d584791..f871bbc 100644
--- a/camel/camel-lock.c
+++ b/camel/camel-lock.c
@@ -70,7 +70,7 @@
* Create an exclusive lock using .lock semantics.
* All locks are equivalent to write locks (exclusive).
*
- * Return value: -1 on error, sets @ex appropriately.
+ * Returns: -1 on error, sets @ex appropriately.
**/
gint
camel_lock_dot(const gchar *path, CamelException *ex)
@@ -178,7 +178,7 @@ camel_unlock_dot(const gchar *path)
* @type is CAMEL_LOCK_WRITE or CAMEL_LOCK_READ,
* to create exclusive or shared read locks
*
- * Return value: -1 on error.
+ * Returns: -1 on error.
**/
gint
camel_lock_fcntl(gint fd, CamelLockType type, CamelException *ex)
@@ -242,7 +242,7 @@ camel_unlock_fcntl(gint fd)
* @type is CAMEL_LOCK_WRITE or CAMEL_LOCK_READ,
* to create exclusive or shared read locks
*
- * Return value: -1 on error.
+ * Returns: -1 on error.
**/
gint
camel_lock_flock(gint fd, CamelLockType type, CamelException *ex)
@@ -293,7 +293,7 @@ camel_unlock_flock(gint fd)
* Attempt to lock a folder, multiple attempts will be made using all
* locking strategies available.
*
- * Return value: -1 on error, @ex will describe the locking system that failed.
+ * Returns: -1 on error, @ex will describe the locking system that failed.
**/
gint
camel_lock_folder(const gchar *path, gint fd, CamelLockType type, CamelException *ex)
diff --git a/camel/camel-mime-parser.c b/camel/camel-mime-parser.c
index 2b72275..857b955 100644
--- a/camel/camel-mime-parser.c
+++ b/camel/camel-mime-parser.c
@@ -238,7 +238,7 @@ camel_mime_parser_get_type (void)
*
* Create a new CamelMimeParser object.
*
- * Return value: A new CamelMimeParser widget.
+ * Returns: A new CamelMimeParser widget.
**/
CamelMimeParser *
camel_mime_parser_new (void)
@@ -260,7 +260,7 @@ camel_mime_parser_new (void)
* 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.
*
- * Return value: An id that may be passed to filter_remove() to remove
+ * Returns: An id that may be passed to filter_remove() to remove
* the filter, or -1 if the operation failed.
*
* Since: 2.22
@@ -326,7 +326,7 @@ camel_mime_parser_filter_remove(CamelMimeParser *m, gint id)
*
* Lookup a header by name.
*
- * Return value: The header value, or NULL if the header is not
+ * Returns: The header value, or NULL if the header is not
* defined.
**/
const gchar *
@@ -349,7 +349,7 @@ camel_mime_parser_header(CamelMimeParser *m, const gchar *name, gint *offset)
* current state of the parser. These headers are valid
* until the next call to parser_step(), or parser_drop_step().
*
- * Return value: The raw headers, or NULL if there are no headers
+ * Returns: The raw headers, or NULL if there are no headers
* defined for the current part or state. These are READ ONLY.
*
* Since: 2.22
@@ -383,7 +383,7 @@ byte_array_to_string(GByteArray *array)
* Retrieve the preface text for the current multipart.
* Can only be used when the state is CAMEL_MIME_PARSER_STATE_MULTIPART_END.
*
- * Return value: The preface text, or NULL if there wasn't any.
+ * Returns: The preface text, or NULL if there wasn't any.
*
* Since: 2.22
**/
@@ -406,7 +406,7 @@ camel_mime_parser_preface(CamelMimeParser *m)
* Only returns valid data when the current state if
* CAMEL_MIME_PARSER_STATE_MULTIPART_END.
*
- * Return value: The postface text, or NULL if there wasn't any.
+ * Returns: The postface text, or NULL if there wasn't any.
*
* Since: 2.22
**/
@@ -432,7 +432,7 @@ camel_mime_parser_postface(CamelMimeParser *m)
* The return value will remain valid while in the CAMEL_MIME_PARSER_STATE_FROM
* state, or any deeper state.
*
- * Return value: The From line, or NULL if called out of context.
+ * Returns: The From line, or NULL if called out of context.
*
* Since: 2.22
**/
@@ -457,7 +457,7 @@ camel_mime_parser_from_line(CamelMimeParser *m)
* descriptor. As a result, seekable descritors should
* be seeked using the parser seek functions.
*
- * Return value: Returns -1 on error.
+ * Returns: Returns -1 on error.
**/
gint
camel_mime_parser_init_with_fd(CamelMimeParser *m, gint fd)
@@ -477,7 +477,7 @@ camel_mime_parser_init_with_fd(CamelMimeParser *m, gint fd)
* the stream. As a result, seekable streams should only
* be seeked using the parser seek function.
*
- * Return value: -1 on error.
+ * Returns: -1 on error.
**/
gint
camel_mime_parser_init_with_stream(CamelMimeParser *m, CamelStream *stream)
@@ -534,7 +534,7 @@ camel_mime_parser_scan_pre_from (CamelMimeParser *parser, gboolean scan_pre_from
*
* Get the content type defined in the current part.
*
- * Return value: A content_type structure, or NULL if there
+ * Returns: A content_type structure, or NULL if there
* is no content-type defined for this part of state of the
* parser.
**/
@@ -612,7 +612,7 @@ camel_mime_parser_drop_step (CamelMimeParser *parser)
* the states an application is gauranteed to get from the
* scanner.
*
- * Return value: The current new state of the parser
+ * Returns: The current new state of the parser
* is returned.
**/
camel_mime_parser_state_t
@@ -658,7 +658,7 @@ camel_mime_parser_step (CamelMimeParser *parser, gchar **databuffer, gsize *data
* occurs, so no state changes occur, but the seek position
* is updated appropriately.
*
- * Return value: The number of bytes available, or -1 on error.
+ * Returns: The number of bytes available, or -1 on error.
**/
gint
camel_mime_parser_read (CamelMimeParser *parser, const gchar **databuffer, gint len)
@@ -709,7 +709,7 @@ camel_mime_parser_read (CamelMimeParser *parser, const gchar **databuffer, gint
* the next section of the scan (the last position + 1 of
* the respective current state).
*
- * Return value: See above.
+ * Returns: See above.
*
* Since: 2.22
**/
@@ -729,7 +729,7 @@ camel_mime_parser_tell (CamelMimeParser *parser)
* headers started, this is cached by the parser
* at the time.
*
- * Return value: The header start position, or -1 if
+ * Returns: The header start position, or -1 if
* no headers were scanned in the current state.
*
* Since: 2.22
@@ -749,7 +749,7 @@ camel_mime_parser_tell_start_headers (CamelMimeParser *parser)
* If the parser is scanning From lines, then this returns
* the position of the start of the From line.
*
- * Return value: The start of the from line, or -1 if there
+ * Returns: The start of the from line, or -1 if there
* was no From line, or From lines are not being scanned.
*
* Since: 2.22
@@ -769,7 +769,7 @@ camel_mime_parser_tell_start_from (CamelMimeParser *parser)
* When parsing a multipart, this returns the start of the last
* boundary.
*
- * Return value: The start of the boundary, or -1 if there
+ * Returns: The start of the boundary, or -1 if there
* was no boundary encountered yet.
*
* Since: 2.22
@@ -795,7 +795,7 @@ camel_mime_parser_tell_start_boundary(CamelMimeParser *parser)
* is specified (whence != SEEK_CUR), then the seek
* position may not match the desired seek position.
*
- * Return value: The new seek offset, or -1 on
+ * Returns: The new seek offset, or -1 on
* an error (for example, trying to seek on a non-seekable
* stream or file descriptor).
*
@@ -815,7 +815,7 @@ camel_mime_parser_seek(CamelMimeParser *parser, off_t offset, gint whence)
*
* Get the current parser state.
*
- * Return value: The current parser state.
+ * Returns: The current parser state.
**/
camel_mime_parser_state_t
camel_mime_parser_state (CamelMimeParser *parser)
@@ -858,7 +858,7 @@ camel_mime_parser_push_state(CamelMimeParser *mp, camel_mime_parser_state_t news
* be read from directly (without saving and restoring
* the seek position in between).
*
- * Return value: The stream from _init_with_stream(), or NULL
+ * Returns: The stream from _init_with_stream(), or NULL
* if the parser is reading from a file descriptor or is
* uninitialised.
**/
@@ -881,7 +881,7 @@ camel_mime_parser_stream (CamelMimeParser *parser)
* or the seek offset can be reset before the next parse
* step.
*
- * Return value: The file descriptor or -1 if the parser
+ * Returns: The file descriptor or -1 if the parser
* is reading from a stream or has not been initialised.
**/
gint
diff --git a/camel/camel-mime-utils.c b/camel/camel-mime-utils.c
index 51cb654..d4e0c27 100644
--- a/camel/camel-mime-utils.c
+++ b/camel/camel-mime-utils.c
@@ -3702,7 +3702,7 @@ static const gchar tm_days [][4] = {
* Allocates a string buffer containing the rfc822 formatted date
* string represented by @time and @tz_offset.
*
- * Return value: a valid string representation of the date.
+ * Returns: a valid string representation of the date.
**/
gchar *
camel_header_format_date (time_t date, gint tz_offset)
diff --git a/camel/camel-news-address.c b/camel/camel-news-address.c
index 3680f8e..8a946ce 100644
--- a/camel/camel-news-address.c
+++ b/camel/camel-news-address.c
@@ -53,7 +53,7 @@ camel_news_address_get_type (void)
*
* Create a new CamelNewsAddress object.
*
- * Return value: A new CamelNewsAddress widget.
+ * Returns: A new CamelNewsAddress widget.
**/
CamelNewsAddress *
camel_news_address_new (void)
diff --git a/camel/camel-nntp-address.c b/camel/camel-nntp-address.c
index 7f489d6..16487d2 100644
--- a/camel/camel-nntp-address.c
+++ b/camel/camel-nntp-address.c
@@ -150,7 +150,7 @@ nntp_remove (CamelAddress *a, gint index)
*
* Create a new CamelNNTPAddress object.
*
- * Return value: A new CamelNNTPAddress object.
+ * Returns: A new CamelNNTPAddress object.
**/
CamelNNTPAddress *
camel_nntp_address_new (void)
@@ -166,7 +166,7 @@ camel_nntp_address_new (void)
*
* Add a new nntp address to the address object. Duplicates are not added twice.
*
- * Return value: Index of added entry, or existing matching entry.
+ * Returns: Index of added entry, or existing matching entry.
**/
gint
camel_nntp_address_add (CamelNNTPAddress *a, const gchar *name)
@@ -193,7 +193,7 @@ camel_nntp_address_add (CamelNNTPAddress *a, const gchar *name)
*
* Get the address at @index.
*
- * Return value: TRUE if such an address exists, or FALSE otherwise.
+ * Returns: TRUE if such an address exists, or FALSE otherwise.
**/
gboolean
camel_nntp_address_get (const CamelNNTPAddress *a, gint index, const gchar **namep)
diff --git a/camel/camel-object.c b/camel/camel-object.c
index c54ae59..0c86166 100644
--- a/camel/camel-object.c
+++ b/camel/camel-object.c
@@ -1730,7 +1730,7 @@ co_metadata_free(CamelObject *obj, CamelObjectMeta *meta)
*
* Get a meta-data on an object.
*
- * Return value: NULL if the meta-data is not set.
+ * Returns: NULL if the meta-data is not set.
**/
gchar *
camel_object_meta_get(gpointer vo, const gchar * name)
@@ -1781,7 +1781,7 @@ camel_object_meta_set(gpointer vo, const gchar * name, const gchar *value)
*
* Read persistent object state from object_set(CAMEL_OBJECT_STATE_FILE).
*
- * Return value: -1 on error.
+ * Returns: -1 on error.
**/
gint camel_object_state_read(gpointer vo)
{
@@ -1816,7 +1816,7 @@ gint camel_object_state_read(gpointer vo)
*
* Write persistent state to the file as set by object_set(CAMEL_OBJECT_STATE_FILE).
*
- * Return value: -1 on error.
+ * Returns: -1 on error.
**/
gint camel_object_state_write(gpointer vo)
{
@@ -1945,7 +1945,7 @@ camel_object_class_dump_tree(CamelType root)
* camel-objects which can be updated atomically using transaction
* semantics.
*
- * Return value:
+ * Returns:
**/
CamelObjectBag *
camel_object_bag_new(GHashFunc hash, GEqualFunc equal, CamelCopyFunc keycopy, GFreeFunc keyfree)
@@ -2076,7 +2076,7 @@ camel_object_bag_add(CamelObjectBag *bag, gconstpointer key, gpointer vo)
* Lookup an object by @key. If the key is currently reserved, then
* wait until the key has been committed before continuing.
*
- * Return value: NULL if the object corresponding to @key is not
+ * Returns: NULL if the object corresponding to @key is not
* in the bag. Otherwise a ref'd object pointer which the caller owns
* the ref to.
**/
@@ -2142,7 +2142,7 @@ camel_object_bag_get(CamelObjectBag *bag, gconstpointer key)
* Unlike other 'peek' operations, the object is still reffed if
* found.
*
- * Return value: A referenced object, or NULL if @key is not
+ * Returns: A referenced object, or NULL if @key is not
* present in the bag.
**/
gpointer
@@ -2179,7 +2179,7 @@ camel_object_bag_peek(CamelObjectBag *bag, gconstpointer key)
* You may reserve multiple keys from the same thread, but they should
* always be reserved in the same order, to avoid deadlocks.
*
- * Return value:
+ * Returns:
**/
gpointer
camel_object_bag_reserve(CamelObjectBag *bag, gconstpointer key)
diff --git a/camel/camel-operation.c b/camel/camel-operation.c
index 2d87904..87425a9 100644
--- a/camel/camel-operation.c
+++ b/camel/camel-operation.c
@@ -119,7 +119,7 @@ co_getcc(void)
* operations and to obtain notification messages of the internal
* status of messages.
*
- * Return value: A new operation handle.
+ * Returns: A new operation handle.
**/
CamelOperation *
camel_operation_new (CamelOperationStatusFunc status, gpointer status_data)
@@ -381,7 +381,7 @@ camel_operation_unregister (CamelOperation *cc)
* Check if cancellation has been applied to @cc. If @cc is NULL,
* then the CamelOperation registered for the current thread is used.
*
- * Return value: TRUE if the operation has been cancelled.
+ * Returns: TRUE if the operation has been cancelled.
**/
gboolean
camel_operation_cancel_check (CamelOperation *cc)
@@ -424,7 +424,7 @@ camel_operation_cancel_check (CamelOperation *cc)
* Retrieve a file descriptor that can be waited on (select, or poll)
* for read, to asynchronously detect cancellation.
*
- * Return value: The fd, or -1 if cancellation is not available
+ * Returns: The fd, or -1 if cancellation is not available
* (blocked, or has not been registered for this thread).
**/
gint
@@ -454,7 +454,7 @@ camel_operation_cancel_fd (CamelOperation *cc)
* Retrieve a file descriptor that can be waited on (select, or poll)
* for read, to asynchronously detect cancellation.
*
- * Return value: The fd, or NULL if cancellation is not available
+ * Returns: The fd, or NULL if cancellation is not available
* (blocked, or has not been registered for this thread).
**/
PRFileDesc *
diff --git a/camel/camel-provider.c b/camel/camel-provider.c
index c510ff3..7a652d4 100644
--- a/camel/camel-provider.c
+++ b/camel/camel-provider.c
@@ -293,7 +293,7 @@ add_to_list (gpointer key, gpointer value, gpointer user_data)
* is %TRUE, it will first load in all available providers that haven't
* yet been loaded.
*
- * Return value: a GList of providers, which the caller must free.
+ * Returns: a GList of providers, which the caller must free.
**/
GList *
camel_provider_list(gboolean load)
@@ -341,7 +341,7 @@ camel_provider_list(gboolean load)
* This returns the CamelProvider that would be used to handle
* @url_string, loading it in from disk if necessary.
*
- * Return value: the provider, or %NULL, in which case @ex will be set.
+ * Returns: the provider, or %NULL, in which case @ex will be set.
**/
CamelProvider *
camel_provider_get(const gchar *url_string, CamelException *ex)
diff --git a/camel/camel-seekable-stream.c b/camel/camel-seekable-stream.c
index 6d22417..1d6001e 100644
--- a/camel/camel-seekable-stream.c
+++ b/camel/camel-seekable-stream.c
@@ -112,7 +112,7 @@ seek (CamelSeekableStream *stream, off_t offset,
* to the range specified by its lower and upper bounds, and the
* stream's eos state will be updated.
*
- * Return value: new position, %-1 if operation failed.
+ * Returns: new position, %-1 if operation failed.
**/
off_t
camel_seekable_stream_seek (CamelSeekableStream *stream, off_t offset,
diff --git a/camel/camel-seekable-substream.c b/camel/camel-seekable-substream.c
index 4f5a3f9..13f08ff 100644
--- a/camel/camel-seekable-substream.c
+++ b/camel/camel-seekable-substream.c
@@ -106,7 +106,7 @@ camel_seekable_substream_get_type (void)
* the current position of @parent_stream. After the substream has been
* closed, @parent_stream will stabilize again.
*
- * Return value: the substream
+ * Returns: the substream
**/
CamelStream *
camel_seekable_substream_new(CamelSeekableStream *parent_stream, off_t start, off_t end)
diff --git a/camel/camel-store.c b/camel/camel-store.c
index b8aa1d8..96aacbf 100644
--- a/camel/camel-store.c
+++ b/camel/camel-store.c
@@ -989,7 +989,7 @@ camel_folder_info_free (CamelFolderInfo *fi)
/**
* camel_folder_info_new:
*
- * Return value: a new empty CamelFolderInfo instance
+ * Returns: a new empty CamelFolderInfo instance
*
* Since: 2.22
**/
diff --git a/camel/camel-stream-buffer.c b/camel/camel-stream-buffer.c
index 8175af7..34ea168 100644
--- a/camel/camel-stream-buffer.c
+++ b/camel/camel-stream-buffer.c
@@ -211,7 +211,7 @@ camel_stream_buffer_new (CamelStream *stream, CamelStreamBufferMode mode)
* If @buf is NULL, then allocate and manage @size bytes
* for all buffering.
*
- * Return value: A new stream with buffering applied.
+ * Returns: A new stream with buffering applied.
**/
CamelStream *
camel_stream_buffer_new_with_vbuf (CamelStream *stream, CamelStreamBufferMode mode, gchar *buf, guint32 size)
diff --git a/camel/camel-stream-process.c b/camel/camel-stream-process.c
index 91053f3..a6536b3 100644
--- a/camel/camel-stream-process.c
+++ b/camel/camel-stream-process.c
@@ -110,7 +110,7 @@ camel_stream_process_get_type (void)
*
* Returns a PROCESS stream.
*
- * Return value: the stream
+ * Returns: the stream
**/
CamelStream *
camel_stream_process_new (void)
diff --git a/camel/camel-string-utils.c b/camel/camel-string-utils.c
index 6a70052..6efe85c 100644
--- a/camel/camel-string-utils.c
+++ b/camel/camel-string-utils.c
@@ -112,7 +112,7 @@ camel_strdown (gchar *str)
*
* ASCII to-lower function.
*
- * Return value:
+ * Returns:
**/
gchar camel_tolower(gchar c)
{
@@ -128,7 +128,7 @@ gchar camel_tolower(gchar c)
*
* ASCII to-upper function.
*
- * Return value:
+ * Returns:
**/
gchar camel_toupper(gchar c)
{
@@ -151,7 +151,7 @@ static GHashTable *pstring_table = NULL;
*
* The NULL and empty strings are special cased to constant values.
*
- * Return value: A pointer to an equivalent string of @s. Use
+ * Returns: A pointer to an equivalent string of @s. Use
* camel_pstring_free() when it is no longer needed.
**/
const gchar *
@@ -197,7 +197,7 @@ camel_pstring_add (gchar *str, gboolean own)
*
* The NULL and empty strings are special cased to constant values.
*
- * Return value: A pointer to an equivalent string of @s. Use
+ * Returns: A pointer to an equivalent string of @s. Use
* camel_pstring_free() when it is no longer needed.
*
* Since: 2.24
@@ -239,7 +239,7 @@ camel_pstring_peek (const gchar *str)
*
* The NULL and empty strings are special cased to constant values.
*
- * Return value: A pointer to an equivalent string of @s. Use
+ * Returns: A pointer to an equivalent string of @s. Use
* camel_pstring_free() when it is no longer needed.
**/
const gchar *
diff --git a/camel/camel-uid-cache.c b/camel/camel-uid-cache.c
index ca219d4..70f24a9 100644
--- a/camel/camel-uid-cache.c
+++ b/camel/camel-uid-cache.c
@@ -52,7 +52,7 @@ struct _uid_state {
* doesn't already exist, the UID cache will be empty. Otherwise, if
* it does exist but can't be read, the function will return %NULL.
*
- * Return value: a new UID cache, or %NULL
+ * Returns: a new UID cache, or %NULL
**/
CamelUIDCache *
camel_uid_cache_new (const gchar *filename)
@@ -144,7 +144,7 @@ maybe_write_uid (gpointer key, gpointer value, gpointer data)
*
* Attempts to save @cache back to disk.
*
- * Return value: success or failure
+ * Returns: success or failure
**/
gboolean
camel_uid_cache_save (CamelUIDCache *cache)
@@ -258,7 +258,7 @@ camel_uid_cache_destroy (CamelUIDCache *cache)
* Returns an array of UIDs from @uids that are not in @cache, and
* removes UIDs from @cache that aren't in @uids.
*
- * Return value: an array of new UIDs, which must be freed with
+ * Returns: an array of new UIDs, which must be freed with
* camel_uid_cache_free_uids().
**/
GPtrArray *
diff --git a/camel/camel-utf8.c b/camel/camel-utf8.c
index fcdb268..a5702d4 100644
--- a/camel/camel-utf8.c
+++ b/camel/camel-utf8.c
@@ -72,7 +72,7 @@ camel_utf8_putc(guchar **ptr, guint32 c)
* to the next character position. Invalid utf8 characters will be
* silently skipped. @ptr should point to a NUL terminated array.
*
- * Return value: The next Unicode character. @ptr will be advanced to
+ * Returns: The next Unicode character. @ptr will be advanced to
* the next character always.
**/
guint32
@@ -123,7 +123,7 @@ loop:
* returned as a sentinel (Unicode 3.1, section 2.7), and @ptr is not
* advanced.
*
- * Return value: The next utf8 char, or 0xffff.
+ * Returns: The next utf8 char, or 0xffff.
**/
guint32
camel_utf8_getc_limit(const guchar **ptr, const guchar *end)
@@ -210,7 +210,7 @@ static const guchar utf7_rank[256] = {
*
* The IMAP rules [rfc2060] are used in the utf7 encoding.
*
- * Return value: The converted string.
+ * Returns: The converted string.
**/
gchar *
camel_utf7_utf8(const gchar *ptr)
@@ -291,7 +291,7 @@ static void utf7_closeb64(GString *out, guint32 v, guint32 i)
*
* The IMAP rules [rfc2060] are used in the utf7 encoding.
*
- * Return value:
+ * Returns:
**/
gchar *
camel_utf8_utf7(const gchar *ptr)
@@ -348,7 +348,7 @@ camel_utf8_utf7(const gchar *ptr)
* Convert a utf8 string into a ucs2 one. The ucs string will be in
* network byte order, and terminated with a 16 bit NULL.
*
- * Return value:
+ * Returns:
**/
gchar *
camel_utf8_ucs2(const gchar *pptr)
@@ -381,7 +381,7 @@ camel_utf8_ucs2(const gchar *pptr)
* Convert a ucs2 string into a utf8 one. The ucs2 string is treated
* as network byte ordered, and terminated with a 16 bit NUL.
*
- * Return value:
+ * Returns:
**/
gchar *camel_ucs2_utf8(const gchar *ptr)
{
diff --git a/camel/camel-vee-folder.c b/camel/camel-vee-folder.c
index a2507ed..6647c17 100644
--- a/camel/camel-vee-folder.c
+++ b/camel/camel-vee-folder.c
@@ -122,7 +122,7 @@ camel_vee_folder_construct (CamelVeeFolder *vf, CamelStore *parent_store, const
*
* Create a new CamelVeeFolder object.
*
- * Return value: A new CamelVeeFolder widget.
+ * Returns: A new CamelVeeFolder widget.
**/
CamelFolder *
camel_vee_folder_new(CamelStore *parent_store, const gchar *full, guint32 flags)
@@ -415,7 +415,7 @@ camel_vee_folder_hash_folder(CamelFolder *folder, gchar buffer[8])
*
* Find the real folder (and uid)
*
- * Return value:
+ * Returns:
**/
CamelFolder *
camel_vee_folder_get_location(CamelVeeFolder *vf, const CamelVeeMessageInfo *vinfo, gchar **realuid)
diff --git a/camel/camel-vee-summary.c b/camel/camel-vee-summary.c
index 16b631f..b01ca22 100644
--- a/camel/camel-vee-summary.c
+++ b/camel/camel-vee-summary.c
@@ -446,7 +446,7 @@ camel_vee_summary_get_type (void)
* This will create a new CamelVeeSummary object and read in the
* summary data from disk, if it exists.
*
- * Return value: A new CamelVeeSummary object.
+ * Returns: A new CamelVeeSummary object.
**/
CamelFolderSummary *
camel_vee_summary_new(CamelFolder *parent)
diff --git a/camel/providers/groupwise/camel-groupwise-summary.c b/camel/providers/groupwise/camel-groupwise-summary.c
index b765645..3ac986b 100644
--- a/camel/providers/groupwise/camel-groupwise-summary.c
+++ b/camel/providers/groupwise/camel-groupwise-summary.c
@@ -153,7 +153,7 @@ camel_groupwise_summary_init (CamelGroupwiseSummary *obj)
* This will create a new CamelGroupwiseSummary object and read in the
* summary data from disk, if it exists.
*
- * Return value: A new CamelGroupwiseSummary object.
+ * Returns: A new CamelGroupwiseSummary object.
**/
CamelFolderSummary *
camel_groupwise_summary_new (struct _CamelFolder *folder, const gchar *filename)
diff --git a/camel/providers/groupwise/camel-groupwise-utils.c b/camel/providers/groupwise/camel-groupwise-utils.c
index ca52f36..2d282dd 100644
--- a/camel/providers/groupwise/camel-groupwise-utils.c
+++ b/camel/providers/groupwise/camel-groupwise-utils.c
@@ -58,7 +58,7 @@ static void do_multipart (EGwConnection *cnc, EGwItem *item, CamelMultipart *mp,
*
* If @prefix is non-%NULL, it will be prepended to the returned path.
*
- * Return value: the expanded path
+ * Returns: the expanded path
**/
gchar *
e_path_to_physical (const gchar *prefix, const gchar *vpath)
@@ -205,7 +205,7 @@ find_folders_recursive (const gchar *physical_path, const gchar *path,
* Walks the folder tree starting at @prefix and calls @callback
* on each folder.
*
- * Return value: %TRUE on success, %FALSE if an error occurs at any point
+ * Returns: %TRUE on success, %FALSE if an error occurs at any point
**/
gboolean
e_path_find_folders (const gchar *prefix,
@@ -224,7 +224,7 @@ e_path_find_folders (const gchar *prefix,
* and attempts to remove its parent "subfolders" directory too
* if it's empty.
*
- * Return value: -1 (with errno set) if it failed to rmdir the
+ * Returns: -1 (with errno set) if it failed to rmdir the
* specified directory. 0 otherwise, whether or not it removed
* the parent directory.
**/
diff --git a/camel/providers/imap/camel-imap-command.c b/camel/providers/imap/camel-imap-command.c
index 27beb32..7a4c0a2 100644
--- a/camel/providers/imap/camel-imap-command.c
+++ b/camel/providers/imap/camel-imap-command.c
@@ -81,7 +81,7 @@ static gchar *imap_command_strdup_printf (CamelImapStore *store,
* callers can grab and release it themselves if they need to run
* multiple commands atomically.)
*
- * Return value: %NULL if an error occurred (in which case @ex will
+ * Returns: %NULL if an error occurred (in which case @ex will
* be set). Otherwise, a CamelImapResponse describing the server's
* response, which the caller must free with camel_imap_response_free().
**/
@@ -147,7 +147,7 @@ camel_imap_command (CamelImapStore *store, CamelFolder *folder,
* recursive, so callers can grab and release it themselves if they
* need to run multiple commands atomically.)
*
- * Return value: %TRUE if the command was sent successfully, %FALSE if
+ * Returns: %TRUE if the command was sent successfully, %FALSE if
* an error occurred (in which case @ex will be set).
**/
gboolean
@@ -251,7 +251,7 @@ imap_command_start (CamelImapStore *store, CamelFolder *folder,
*
* This function assumes you have an exclusive lock on the imap stream.
*
- * Return value: as for camel_imap_command(). On failure, the store's
+ * Returns: as for camel_imap_command(). On failure, the store's
* connect_lock will be released.
**/
CamelImapResponse *
@@ -297,7 +297,7 @@ camel_imap_command_continuation (CamelImapStore *store, const gchar *cmd,
* @store into * response The caller must free the string when it is
* done with it.
*
- * Return value: One of %CAMEL_IMAP_RESPONSE_CONTINUATION,
+ * Returns: One of %CAMEL_IMAP_RESPONSE_CONTINUATION,
* %CAMEL_IMAP_RESPONSE_UNTAGGED, %CAMEL_IMAP_RESPONSE_TAGGED, or
* %CAMEL_IMAP_RESPONSE_ERROR. If either of the last two, @store's
* command lock will be unlocked.
@@ -679,7 +679,7 @@ camel_imap_response_free_without_processing (CamelImapStore *store,
* and return %NULL. Either way, @response will be freed and the
* store's connect_lock released.
*
- * Return value: the desired response string, which the caller must free.
+ * Returns: the desired response string, which the caller must free.
**/
gchar *
camel_imap_response_extract (CamelImapStore *store,
@@ -728,7 +728,7 @@ camel_imap_response_extract (CamelImapStore *store,
* response, the function will set @ex, release @store's connect_lock,
* and return %NULL. Either way, @response will be freed.
*
- * Return value: the desired response string, which the caller must free.
+ * Returns: the desired response string, which the caller must free.
**/
gchar *
camel_imap_response_extract_continuation (CamelImapStore *store,
diff --git a/camel/providers/imap/camel-imap-message-cache.c b/camel/providers/imap/camel-imap-message-cache.c
index 4509a49..484ff7b 100644
--- a/camel/providers/imap/camel-imap-message-cache.c
+++ b/camel/providers/imap/camel-imap-message-cache.c
@@ -157,7 +157,7 @@ cache_put (CamelImapMessageCache *cache, const gchar *uid, const gchar *key,
* @summary: CamelFolderSummary for the folder we are caching
* @ex: a CamelException
*
- * Return value: a new CamelImapMessageCache object using @path for
+ * Returns: a new CamelImapMessageCache object using @path for
* storage. If cache files already exist in @path, then any that do not
* correspond to messages in @summary will be deleted.
* @path is scanned for its contents, which means creating a cache object can be
@@ -267,7 +267,7 @@ camel_imap_message_cache_delete (const gchar *path, CamelException *ex)
* camel_imap_message_cache_max_uid:
* @cache: the cache
*
- * Return value: the largest (real) UID in the cache.
+ * Returns: the largest (real) UID in the cache.
**/
guint32
camel_imap_message_cache_max_uid (CamelImapMessageCache *cache)
@@ -367,7 +367,7 @@ insert_finish (CamelImapMessageCache *cache, const gchar *uid, gchar *path,
*
* Caches the provided data into @cache.
*
- * Return value: a CamelStream containing the cached data, which the
+ * Returns: a CamelStream containing the cached data, which the
* caller must unref.
**/
CamelStream *
@@ -463,7 +463,7 @@ camel_imap_message_cache_insert_wrapper (CamelImapMessageCache *cache,
* @part_spec: the part_spec of the data to get
* @ex: exception
*
- * Return value: the filename of a cache item
+ * Returns: the filename of a cache item
**/
gchar *
camel_imap_message_cache_get_filename (CamelImapMessageCache *cache,
@@ -493,7 +493,7 @@ camel_imap_message_cache_get_filename (CamelImapMessageCache *cache,
* @part_spec: the part_spec of the data to get
* @ex: exception
*
- * Return value: a CamelStream containing the cached data (which the
+ * Returns: a CamelStream containing the cached data (which the
* caller must unref), or %NULL if that data is not cached.
**/
CamelStream *
diff --git a/camel/providers/imap/camel-imap-search.c b/camel/providers/imap/camel-imap-search.c
index 8f7dfb3..7d3c1ba 100644
--- a/camel/providers/imap/camel-imap-search.c
+++ b/camel/providers/imap/camel-imap-search.c
@@ -151,7 +151,7 @@ camel_imap_search_get_type (void)
/**
* camel_imap_search_new:
*
- * Return value: A new CamelImapSearch widget.
+ * Returns: A new CamelImapSearch widget.
**/
CamelFolderSearch *
camel_imap_search_new (const gchar *cachedir)
diff --git a/camel/providers/imap/camel-imap-store-summary.c b/camel/providers/imap/camel-imap-store-summary.c
index 4216060..3b1c5d2 100644
--- a/camel/providers/imap/camel-imap-store-summary.c
+++ b/camel/providers/imap/camel-imap-store-summary.c
@@ -124,7 +124,7 @@ camel_imap_store_summary_get_type (void)
*
* Create a new CamelImapStoreSummary object.
*
- * Return value: A new CamelImapStoreSummary widget.
+ * Returns: A new CamelImapStoreSummary widget.
**/
CamelImapStoreSummary *
camel_imap_store_summary_new (void)
@@ -144,7 +144,7 @@ camel_imap_store_summary_new (void)
* A referenced to the summary item is returned, which may be
* ref'd or free'd as appropriate.
*
- * Return value: The summary item, or NULL if the @full_name name
+ * Returns: The summary item, or NULL if the @full_name name
* is not available.
* It must be freed using camel_store_summary_info_free().
**/
diff --git a/camel/providers/imap/camel-imap-summary.c b/camel/providers/imap/camel-imap-summary.c
index a8c2328..a75b784 100644
--- a/camel/providers/imap/camel-imap-summary.c
+++ b/camel/providers/imap/camel-imap-summary.c
@@ -186,7 +186,7 @@ uid_compare (gconstpointer va, gconstpointer vb)
* This will create a new CamelImapSummary object and read in the
* summary data from disk, if it exists.
*
- * Return value: A new CamelImapSummary object.
+ * Returns: A new CamelImapSummary object.
**/
CamelFolderSummary *
camel_imap_summary_new (struct _CamelFolder *folder, const gchar *filename)
diff --git a/camel/providers/imap/camel-imap-utils.c b/camel/providers/imap/camel-imap-utils.c
index 89ff01a..e4ee339 100644
--- a/camel/providers/imap/camel-imap-utils.c
+++ b/camel/providers/imap/camel-imap-utils.c
@@ -305,7 +305,7 @@ imap_parse_namespace_response (const gchar *response)
* Parses a LIST or LSUB response and returns the desired parts of it.
* If @folder is non-%NULL, its value must be freed by the caller.
*
- * Return value: whether or not the response was successfully parsed.
+ * Returns: whether or not the response was successfully parsed.
**/
gboolean
imap_parse_list_response (CamelImapStore *store, const gchar *buf, gint *flags, gchar *sep, gchar **folder)
@@ -465,9 +465,9 @@ imap_parse_folder_name (CamelImapStore *store, const gchar *folder_name)
* Converts label flag name on server to name used in Evolution or back.
* It will never return NULL, it will return empty string, instead.
*
- * @param flag Flag to rename.
- * @param len Length of the flag name.
- * @param server_to_evo if TRUE, then converting server names to evo's names, if FALSE then opposite.
+ * @flag: Flag to rename.
+ * @len: Length of the flag name.
+ * @server_to_evo: if TRUE, then converting server names to evo's names, if FALSE then opposite.
*/
static const gchar *
rename_label_flag (const gchar *flag, gint len, gboolean server_to_evo)
@@ -708,7 +708,7 @@ imap_is_atom(const gchar *in)
* camel_imap_command(): that line breaks are indicated by LF rather
* than CRLF.
*
- * Return value: the parsed string, or %NULL if a NIL or no string
+ * Returns: the parsed string, or %NULL if a NIL or no string
* was parsed. (In the former case, * str_p will be %NULL; in the
* latter, it will point to the character after the NIL.)
**/
@@ -1136,7 +1136,7 @@ imap_parse_body (const gchar **body_p, CamelFolder *folder,
* imap_quote_string:
* @str: the string to quote, which must not contain CR or LF
*
- * Return value: an IMAP "quoted" corresponding to the string, which
+ * Returns: an IMAP "quoted" corresponding to the string, which
* the caller must free.
**/
gchar *
@@ -1202,7 +1202,7 @@ get_summary_uid_numeric (CamelFolderSummary *summary, gint index)
*
* Note: @uids MUST be in sorted order for this code to work properly.
*
- * Return value: the set, which the caller must free with g_free()
+ * Returns: the set, which the caller must free with g_free()
**/
gchar *
imap_uid_array_to_set (CamelFolderSummary *summary, GPtrArray *uids, gint uid, gssize maxlen, gint *lastuid)
@@ -1268,7 +1268,7 @@ imap_uid_array_to_set (CamelFolderSummary *summary, GPtrArray *uids, gint uid, g
* of @summary, the function will assume that all of the "missing" UIDs
* do exist.
*
- * Return value: the array of uids, which the caller must free with
+ * Returns: the array of uids, which the caller must free with
* imap_uid_array_free(). (Or %NULL if the uid set can't be parsed.)
**/
GPtrArray *
@@ -1476,7 +1476,7 @@ find_folders_recursive (const gchar *physical_path, const gchar *path,
* Walks the folder tree starting at @prefix and calls @callback
* on each folder.
*
- * Return value: %TRUE on success, %FALSE if an error occurs at any point
+ * Returns: %TRUE on success, %FALSE if an error occurs at any point
**/
gboolean
imap_path_find_folders (const gchar *prefix, IMAPPathFindFoldersCallback callback, gpointer data)
diff --git a/camel/providers/imapx/camel-imapx-store-summary.c b/camel/providers/imapx/camel-imapx-store-summary.c
index e46caa7..bc0854f 100644
--- a/camel/providers/imapx/camel-imapx-store-summary.c
+++ b/camel/providers/imapx/camel-imapx-store-summary.c
@@ -124,7 +124,7 @@ camel_imapx_store_summary_get_type (void)
*
* Create a new CamelIMAPXStoreSummary object.
*
- * Return value: A new CamelIMAPXStoreSummary widget.
+ * Returns: A new CamelIMAPXStoreSummary widget.
**/
CamelIMAPXStoreSummary *
camel_imapx_store_summary_new (void)
@@ -144,7 +144,7 @@ camel_imapx_store_summary_new (void)
* A referenced to the summary item is returned, which may be
* ref'd or free'd as appropriate.
*
- * Return value: The summary item, or NULL if the @full_name name
+ * Returns: The summary item, or NULL if the @full_name name
* is not available.
* It must be freed using camel_store_summary_info_free().
**/
diff --git a/camel/providers/imapx/camel-imapx-stream.c b/camel/providers/imapx/camel-imapx-stream.c
index 7c9114a..076bbea 100644
--- a/camel/providers/imapx/camel-imapx-stream.c
+++ b/camel/providers/imapx/camel-imapx-stream.c
@@ -200,7 +200,7 @@ camel_imapx_stream_get_type (void)
* Returns a NULL stream. A null stream is always at eof, and
* always returns success for all reads and writes.
*
- * Return value: the stream
+ * Returns: the stream
**/
CamelStream *
camel_imapx_stream_new(CamelStream *source)
diff --git a/camel/providers/imapx/camel-imapx-summary.c b/camel/providers/imapx/camel-imapx-summary.c
index a69ff36..b000c13 100644
--- a/camel/providers/imapx/camel-imapx-summary.c
+++ b/camel/providers/imapx/camel-imapx-summary.c
@@ -186,7 +186,7 @@ uid_compare (gconstpointer va, gconstpointer vb)
* This will create a new CamelIMAPXSummary object and read in the
* summary data from disk, if it exists.
*
- * Return value: A new CamelIMAPXSummary object.
+ * Returns: A new CamelIMAPXSummary object.
**/
CamelFolderSummary *
camel_imapx_summary_new (struct _CamelFolder *folder, const gchar *filename)
diff --git a/camel/providers/imapx/camel-imapx-utils.c b/camel/providers/imapx/camel-imapx-utils.c
index f220fd1..59d4d37 100644
--- a/camel/providers/imapx/camel-imapx-utils.c
+++ b/camel/providers/imapx/camel-imapx-utils.c
@@ -110,9 +110,9 @@ imapx_parse_flags(CamelIMAPXStream *stream, guint32 *flagsp, CamelFlag **user_fl
* if the flags does not match returns the original one as it is.
* It will never return NULL, it will return empty string, instead.
*
- * @param flag Flag to rename.
- * @param len Length of the flag name.
- * @param server_to_evo if TRUE, then converting server names to evo's names, if FALSE then opposite.
+ * @flag: Flag to rename.
+ * @len: Length of the flag name.
+ * @server_to_evo: if TRUE, then converting server names to evo's names, if FALSE then opposite.
*/
static const gchar *
rename_label_flag (const gchar *flag, gint len, gboolean server_to_evo)
diff --git a/camel/providers/imapx/camel-imapx-view-summary.c b/camel/providers/imapx/camel-imapx-view-summary.c
index 109700c..b8a6a3e 100644
--- a/camel/providers/imapx/camel-imapx-view-summary.c
+++ b/camel/providers/imapx/camel-imapx-view-summary.c
@@ -44,7 +44,7 @@ static CamelViewSummaryDiskClass *cmvs_parent;
*
* Create a new CamelIMAPXViewSummary object.
*
- * Return value: A new CamelIMAPXViewSummary widget.
+ * Returns: A new CamelIMAPXViewSummary widget.
**/
CamelIMAPXViewSummary *
camel_imapx_view_summary_new(const gchar *base, CamelException *ex)
diff --git a/camel/providers/local/camel-local-summary.c b/camel/providers/local/camel-local-summary.c
index c146d8f..b3fd143 100644
--- a/camel/providers/local/camel-local-summary.c
+++ b/camel/providers/local/camel-local-summary.c
@@ -325,7 +325,7 @@ camel_local_summary_add(CamelLocalSummary *cls, CamelMimeMessage *msg, const Cam
* If @status is non NULL, then a Status header line is also written.
* The headers written are termianted with a blank line.
*
- * Return value: -1 on error, otherwise the number of bytes written.
+ * Returns: -1 on error, otherwise the number of bytes written.
**/
gint
camel_local_summary_write_headers(gint fd, struct _camel_header_raw *header, const gchar *xevline, const gchar *status, const gchar *xstatus)
diff --git a/camel/providers/local/camel-maildir-summary.c b/camel/providers/local/camel-maildir-summary.c
index 347fc7e..5b172e2 100644
--- a/camel/providers/local/camel-maildir-summary.c
+++ b/camel/providers/local/camel-maildir-summary.c
@@ -158,7 +158,7 @@ camel_maildir_summary_finalise(CamelObject *obj)
*
* Create a new CamelMaildirSummary object.
*
- * Return value: A new #CamelMaildirSummary object.
+ * Returns: A new #CamelMaildirSummary object.
**/
CamelMaildirSummary
*camel_maildir_summary_new(struct _CamelFolder *folder, const gchar *filename, const gchar *maildirdir, CamelIndex *index)
diff --git a/camel/providers/local/camel-mbox-summary.c b/camel/providers/local/camel-mbox-summary.c
index 242d13b..bd2bb9a 100644
--- a/camel/providers/local/camel-mbox-summary.c
+++ b/camel/providers/local/camel-mbox-summary.c
@@ -217,7 +217,7 @@ camel_mbox_summary_finalise(CamelObject *obj)
*
* Create a new CamelMboxSummary object.
*
- * Return value: A new CamelMboxSummary widget.
+ * Returns: A new CamelMboxSummary widget.
**/
CamelMboxSummary *
camel_mbox_summary_new(struct _CamelFolder *folder, const gchar *filename, const gchar *mbox_name, CamelIndex *index)
diff --git a/camel/providers/local/camel-mh-summary.c b/camel/providers/local/camel-mh-summary.c
index 80d5780..2150bc2 100644
--- a/camel/providers/local/camel-mh-summary.c
+++ b/camel/providers/local/camel-mh-summary.c
@@ -121,7 +121,7 @@ camel_mh_summary_finalise(CamelObject *obj)
*
* Create a new CamelMhSummary object.
*
- * Return value: A new #CamelMhSummary object.
+ * Returns: A new #CamelMhSummary object.
**/
CamelMhSummary *camel_mh_summary_new(struct _CamelFolder *folder, const gchar *filename, const gchar *mhdir, CamelIndex *index)
{
diff --git a/camel/providers/nntp/camel-nntp-store-summary.c b/camel/providers/nntp/camel-nntp-store-summary.c
index dd72d28..5fc5757 100644
--- a/camel/providers/nntp/camel-nntp-store-summary.c
+++ b/camel/providers/nntp/camel-nntp-store-summary.c
@@ -125,7 +125,7 @@ camel_nntp_store_summary_get_type (void)
*
* Create a new CamelNNTPStoreSummary object.
*
- * Return value: A new CamelNNTPStoreSummary widget.
+ * Returns: A new CamelNNTPStoreSummary widget.
**/
CamelNNTPStoreSummary *
camel_nntp_store_summary_new (void)
@@ -143,7 +143,7 @@ camel_nntp_store_summary_new (void)
* A referenced to the summary item is returned, which may be
* ref'd or free'd as appropriate.
*
- * Return value: The summary item, or NULL if the @full_name name
+ * Returns: The summary item, or NULL if the @full_name name
* is not available.
* It must be freed using camel_store_summary_info_free().
**/
diff --git a/camel/providers/nntp/camel-nntp-stream.c b/camel/providers/nntp/camel-nntp-stream.c
index fa2533e..4f2ade1 100644
--- a/camel/providers/nntp/camel-nntp-stream.c
+++ b/camel/providers/nntp/camel-nntp-stream.c
@@ -248,7 +248,7 @@ camel_nntp_stream_get_type (void)
* Returns a NULL stream. A null stream is always at eof, and
* always returns success for all reads and writes.
*
- * Return value: the stream
+ * Returns: the stream
**/
CamelStream *
camel_nntp_stream_new(CamelStream *source)
diff --git a/camel/providers/pop3/camel-pop3-engine.c b/camel/providers/pop3/camel-pop3-engine.c
index 6f647df..1888c14 100644
--- a/camel/providers/pop3/camel-pop3-engine.c
+++ b/camel/providers/pop3/camel-pop3-engine.c
@@ -132,7 +132,7 @@ read_greeting (CamelPOP3Engine *pe)
* Returns a NULL stream. A null stream is always at eof, and
* always returns success for all reads and writes.
*
- * Return value: the stream
+ * Returns: the stream
**/
CamelPOP3Engine *
camel_pop3_engine_new(CamelStream *source, guint32 flags)
diff --git a/camel/providers/pop3/camel-pop3-stream.c b/camel/providers/pop3/camel-pop3-stream.c
index 7357fa5..486fc52 100644
--- a/camel/providers/pop3/camel-pop3-stream.c
+++ b/camel/providers/pop3/camel-pop3-stream.c
@@ -249,7 +249,7 @@ camel_pop3_stream_get_type (void)
* Returns a NULL stream. A null stream is always at eof, and
* always returns success for all reads and writes.
*
- * Return value: the stream
+ * Returns: the stream
**/
CamelStream *
camel_pop3_stream_new(CamelStream *source)
diff --git a/libebackend/e-file-cache.c b/libebackend/e-file-cache.c
index 12ca96f..fb0d90c 100644
--- a/libebackend/e-file-cache.c
+++ b/libebackend/e-file-cache.c
@@ -170,7 +170,7 @@ e_file_cache_init (EFileCache *cache)
* Creates a new #EFileCache object, which implements a cache of
* objects, very useful for remote backends.
*
- * Return value: The newly created object.
+ * Returns: The newly created object.
*/
EFileCache *
e_file_cache_new (const gchar *filename)
@@ -494,7 +494,7 @@ e_file_cache_thaw_changes (EFileCache *cache)
*
* Gets the name of the file where the cache is being stored.
*
- * Return value: The name of the cache.
+ * Returns: The name of the cache.
*/
const gchar *
e_file_cache_get_filename (EFileCache *cache)
diff --git a/libedataserver/e-account-list.c b/libedataserver/e-account-list.c
index 6e23bc1..eec8592 100644
--- a/libedataserver/e-account-list.c
+++ b/libedataserver/e-account-list.c
@@ -221,7 +221,7 @@ free_func (gpointer data, gpointer closure)
* you must call e_account_list_save() to push the changes back to
* GConf.
*
- * Return value: the list of accounts
+ * Returns: the list of accounts
**/
EAccountList *
e_account_list_new (GConfClient *gconf)
@@ -396,7 +396,7 @@ e_account_list_remove(EAccountList *accounts, EAccount *account)
* Get the default account. If no default is specified, or the default
* has become stale, then the first account is made the default.
*
- * Return value: The account or NULL if no accounts are defined.
+ * Returns: The account or NULL if no accounts are defined.
**/
const EAccount *
e_account_list_get_default(EAccountList *accounts)
@@ -457,7 +457,7 @@ e_account_list_set_default(EAccountList *accounts, EAccount *account)
* E_ACCOUNT_FIND_ID_NAME - Find an account by the owner's identity name.
* E_ACCOUNT_FIND_ID_ADDRESS - Find an account by the owner's identity address.
*
- * Return value: The account or NULL if it doesn't exist.
+ * Returns: The account or NULL if it doesn't exist.
**/
const EAccount *
e_account_list_find(EAccountList *accounts, e_account_find_t type, const gchar *key)
diff --git a/libedataserver/e-account.c b/libedataserver/e-account.c
index 7f72c0d..baa9491 100644
--- a/libedataserver/e-account.c
+++ b/libedataserver/e-account.c
@@ -169,7 +169,7 @@ finalize (GObject *object)
/**
* e_account_new:
*
- * Return value: a blank new account which can be filled in and
+ * Returns: a blank new account which can be filled in and
* added to an #EAccountList.
**/
EAccount *
@@ -187,7 +187,7 @@ e_account_new (void)
* e_account_new_from_xml:
* @xml: an XML account description
*
- * Return value: a new #EAccount based on the data in @xml, or %NULL
+ * Returns: a new #EAccount based on the data in @xml, or %NULL
* if @xml could not be parsed as valid account data.
**/
EAccount *
@@ -415,7 +415,7 @@ xml_set_service (xmlNodePtr node, EAccountService *service)
*
* Changes @account to match @xml.
*
- * Return value: %TRUE if @account was changed, %FALSE if @account
+ * Returns: %TRUE if @account was changed, %FALSE if @account
* already matched @xml or @xml could not be parsed
**/
gboolean
@@ -582,7 +582,7 @@ e_account_import (EAccount *dest, EAccount *src)
* e_account_to_xml:
* @account: an #EAccount
*
- * Return value: an XML representation of @account, which the caller
+ * Returns: an XML representation of @account, which the caller
* must free.
**/
gchar *
@@ -684,7 +684,7 @@ e_account_to_xml (EAccount *account)
* e_account_uid_from_xml:
* @xml: an XML account description
*
- * Return value: the permanent UID of the account described by @xml
+ * Returns: the permanent UID of the account described by @xml
* (or %NULL if @xml could not be parsed or did not contain a uid).
* The caller must free this string.
**/
diff --git a/libedataserver/e-categories.c b/libedataserver/e-categories.c
index c90bbda..24af1ef 100644
--- a/libedataserver/e-categories.c
+++ b/libedataserver/e-categories.c
@@ -478,7 +478,7 @@ add_hash_to_list (gpointer key, gpointer value, gpointer user_data)
*
* Returns a sorted list of all the category names currently configured.
*
- * Return value: a sorted GList containing the names of the categories. The
+ * Returns: a sorted GList containing the names of the categories. The
* list should be freed using g_list_free, but the names of the categories
* should not be touched at all, they are internal strings.
*/
@@ -553,7 +553,7 @@ e_categories_remove (const gchar *category)
*
* Checks whether the given category is available in the configuration.
*
- * Return value: %TRUE if the category is available, %FALSE otherwise.
+ * Returns: %TRUE if the category is available, %FALSE otherwise.
*/
gboolean
e_categories_exist (const gchar *category)
@@ -602,7 +602,7 @@ e_categories_set_color_for (const gchar *category, const gchar *color)
*
* Gets the icon file associated with the given category.
*
- * Return value: icon file name.
+ * Returns: icon file name.
*/
const gchar *
e_categories_get_icon_file_for (const gchar *category)
diff --git a/libedataserver/e-memory.c b/libedataserver/e-memory.c
index acbdd10..0854ee9 100644
--- a/libedataserver/e-memory.c
+++ b/libedataserver/e-memory.c
@@ -123,7 +123,7 @@ typedef struct _EMemChunk {
* e_memchunks are effectively the same as gmemchunks, only faster (much), and
* they use less memory overhead for housekeeping.
*
- * Return value: The new header.
+ * Returns: The new header.
**/
MemChunk *e_memchunk_new(gint atomcount, gint atomsize)
{
@@ -397,7 +397,7 @@ static GStaticMutex mempool_mutex = G_STATIC_MUTEX_INIT;
* However, each allocation cannot be freed individually, only all
* or nothing.
*
- * Return value:
+ * Returns:
**/
MemPool *e_mempool_new(gint blocksize, gint threshold, EMemPoolFlags flags)
{
@@ -583,7 +583,7 @@ struct _e_strvunpacked {
* change as arrays of this size suffer significant performance
* penalties when looking up strings with high indices.
*
- * Return value:
+ * Returns:
**/
struct _EStrv *
e_strv_new(gint size)
@@ -640,7 +640,7 @@ strv_unpack(struct _EStrv *strv)
* The memory used by the original @strv is not freed until
* the new strv is packed, or freed itself.
*
- * Return value: A new EStrv if the strv has already
+ * Returns: A new EStrv if the strv has already
* been packed, otherwise @strv.
**/
struct _EStrv *
@@ -673,7 +673,7 @@ e_strv_set_ref(struct _EStrv *strv, gint index, gchar *str)
* is not copied until the strv is packed, and not at
* all if the index is overwritten.
*
- * Return value: @strv if already unpacked, otherwise an packed
+ * Returns: @strv if already unpacked, otherwise an packed
* EStrv.
**/
struct _EStrv *
@@ -710,7 +710,7 @@ e_strv_set_ref_free(struct _EStrv *strv, gint index, gchar *str)
* If @strv has been packed, then it is unpacked ready
* for more inserts, and should be packed again once finished with.
*
- * Return value: A new EStrv if the strv has already
+ * Returns: A new EStrv if the strv has already
* been packed, otherwise @strv.
**/
struct _EStrv *
@@ -745,7 +745,7 @@ e_strv_set(struct _EStrv *strv, gint index, const gchar *str)
* All strings are packed into a single allocated block, separated
* by single \0 characters, together with a count byte.
*
- * Return value:
+ * Returns:
**/
struct _EStrv *
e_strv_pack(struct _EStrv *strv)
@@ -789,7 +789,7 @@ e_strv_pack(struct _EStrv *strv)
* identically on both packed and unpacked strv's, although
* may be much slower on a packed strv.
*
- * Return value:
+ * Returns:
**/
const gchar *
e_strv_get(struct _EStrv *strv, gint index)
@@ -898,7 +898,7 @@ struct _EPoolv {
* we should probably in the future ref count the strings contained in
* the hash table, but for now let's not.
*
- * Return value: new pooled string vector
+ * Returns: new pooled string vector
**/
EPoolv *
e_poolv_new(guint size)
@@ -952,7 +952,7 @@ e_poolv_new(guint size)
*
* Copy the contents of a pooled string vector
*
- * Return value: @dest, which may be re-allocated if the strings
+ * Returns: @dest, which may be re-allocated if the strings
* are different lengths.
**/
EPoolv *
@@ -1044,7 +1044,7 @@ poolv_profile_update (void)
* referencing the string, freeit should be TRUE. Otherwise, this
* will duplicate the string if it is not found in the pool.
*
- * Return value: @poolv
+ * Returns: @poolv
**/
EPoolv *
e_poolv_set (EPoolv *poolv, gint index, gchar *str, gint freeit)
@@ -1136,7 +1136,7 @@ e_poolv_set (EPoolv *poolv, gint index, gchar *str, gint freeit)
* Since the pool is never freed, this string does not need to be
* duplicated, but should not be modified.
*
- * Return value: string at that index.
+ * Returns: string at that index.
**/
const gchar *
e_poolv_get(EPoolv *poolv, gint index)
diff --git a/libedataserver/e-msgport.c b/libedataserver/e-msgport.c
index 868143e..a839fcf 100644
--- a/libedataserver/e-msgport.c
+++ b/libedataserver/e-msgport.c
@@ -296,7 +296,7 @@ struct _EMCache {
* Setup a new timeout cache. @nodesize is the size of nodes in the
* cache, and @nodefree will be called to free YOUR content.
*
- * Return value:
+ * Returns:
**/
EMCache *
em_cache_new(time_t timeout, gsize nodesize, GFreeFunc nodefree)
@@ -336,7 +336,7 @@ em_cache_destroy(EMCache *emc)
* Lookup a cache node. once you're finished with it, you need to
* unref it.
*
- * Return value:
+ * Returns:
**/
EMCacheNode *
em_cache_lookup(EMCache *emc, const gchar *key)
@@ -366,7 +366,7 @@ em_cache_lookup(EMCache *emc, const gchar *key)
* Create a new key'd cache node. The node will not be added to the
* cache until you insert it.
*
- * Return value:
+ * Returns:
**/
EMCacheNode *
em_cache_node_new(EMCache *emc, const gchar *key)
diff --git a/libedataserver/e-source-group.c b/libedataserver/e-source-group.c
index 42306d7..e482491 100644
--- a/libedataserver/e-source-group.c
+++ b/libedataserver/e-source-group.c
@@ -820,7 +820,7 @@ compare_source_lists (GSList *a, GSList *b)
*
* Compares if @a is equivalent to @b.
*
- * Return value: %TRUE if @a is equivalent to @b,
+ * Returns: %TRUE if @a is equivalent to @b,
* %FALSE otherwise.
*
* Since: 2.24
@@ -867,7 +867,7 @@ e_source_group_equal (ESourceGroup *a, ESourceGroup *b)
*
* Compares if @a is equivalent to @b.
*
- * Return value: %TRUE if @a is equivalent to @b,
+ * Returns: %TRUE if @a is equivalent to @b,
* %FALSE otherwise.
*
* Since: 2.24
diff --git a/libedataserver/e-source.c b/libedataserver/e-source.c
index d9a7eb3..d4dc239 100644
--- a/libedataserver/e-source.c
+++ b/libedataserver/e-source.c
@@ -274,7 +274,7 @@ compare_str_hashes (GHashTable *table1, GHashTable *table2)
*
* Update the ESource properties from @node.
*
- * Return value: %TRUE if the data in @node was recognized and parsed into
+ * Returns: %TRUE if the data in @node was recognized and parsed into
* acceptable values for @source, %FALSE otherwise.
**/
gboolean
@@ -408,7 +408,7 @@ e_source_update_from_xml_node (ESource *source,
* Assuming that @node is a valid ESource specification, retrieve the name of
* the source from it.
*
- * Return value: Name of the source in the specified @node. The caller must
+ * Returns: Name of the source in the specified @node. The caller must
* free the string.
**/
gchar *
@@ -653,7 +653,7 @@ e_source_peek_absolute_uri (ESource *source)
* Return the textual representation of the color for @source, or %NULL if it
* has none. The returned string should be parsable by #gdk_color_parse().
*
- * Return value: a string specifying the color
+ * Returns: a string specifying the color
*
* Since: 1.10
**/
@@ -682,7 +682,7 @@ e_source_get_readonly (ESource *source)
*
* If @source has an associated color, return it in * color_return
*
- * Return value: %TRUE if the @source has a defined color (and hence
+ * Returns: %TRUE if the @source has a defined color (and hence
* * color_return was set), %FALSE otherwise.
**/
gboolean
@@ -822,7 +822,7 @@ e_source_to_standalone_xml (ESource *source)
*
* Compares if @a is equivalent to @b.
*
- * Return value: %TRUE if @a is equivalent to @b,
+ * Returns: %TRUE if @a is equivalent to @b,
* %FALSE otherwise.
*
* Since: 2.24
@@ -880,7 +880,7 @@ e_source_equal (ESource *a, ESource *b)
*
* Compares if @a is equivalent to @b.
*
- * Return value: %TRUE if @a is equivalent to @b,
+ * Returns: %TRUE if @a is equivalent to @b,
* %FALSE otherwise.
*
* Since: 2.24
diff --git a/libedataserver/e-uid.c b/libedataserver/e-uid.c
index 42bfa12..eed5fcc 100644
--- a/libedataserver/e-uid.c
+++ b/libedataserver/e-uid.c
@@ -33,7 +33,7 @@
*
* Generate a new unique string for use e.g. in account lists.
*
- * Return value: The newly generated UID. The caller should free the string
+ * Returns: The newly generated UID. The caller should free the string
* when it's done with it.
**/
gchar *
diff --git a/libedataserverui/e-book-auth-util.c b/libedataserverui/e-book-auth-util.c
index f03cad8..b5d2ff0 100644
--- a/libedataserverui/e-book-auth-util.c
+++ b/libedataserverui/e-book-auth-util.c
@@ -277,7 +277,7 @@ load_source_cb (EBook *book, EBookStatus status, gpointer closure)
* if it succeeded or not. If you don't care, you can pass %NULL for
* @open_func, and no action will be taken on completion.
*
- * Return value: A new #EBook that is being opened.
+ * Returns: A new #EBook that is being opened.
**/
EBook *
e_load_book_source (ESource *source, EBookCallback open_func, gpointer user_data)
diff --git a/libedataserverui/e-contact-store.c b/libedataserverui/e-contact-store.c
index bb9ef72..6ad47d8 100644
--- a/libedataserverui/e-contact-store.c
+++ b/libedataserverui/e-contact-store.c
@@ -160,7 +160,7 @@ e_contact_store_finalize (GObject *object)
*
* Creates a new #EContactStore.
*
- * Return value: A new #EContactStore.
+ * Returns: A new #EContactStore.
**/
EContactStore *
e_contact_store_new (void)
@@ -765,7 +765,7 @@ query_contact_source (EContactStore *contact_store, ContactSource *source)
*
* Gets the #EBook that provided the contact at @iter.
*
- * Return value: An #EBook.
+ * Returns: An #EBook.
**/
EBook *
e_contact_store_get_book (EContactStore *contact_store, GtkTreeIter *iter)
@@ -787,7 +787,7 @@ e_contact_store_get_book (EContactStore *contact_store, GtkTreeIter *iter)
*
* Gets the #EContact at @iter.
*
- * Return value: An #EContact.
+ * Returns: An #EContact.
**/
EContact *
e_contact_store_get_contact (EContactStore *contact_store, GtkTreeIter *iter)
@@ -810,7 +810,7 @@ e_contact_store_get_contact (EContactStore *contact_store, GtkTreeIter *iter)
*
* Sets @iter to point to the contact row matching @uid.
*
- * Return value: %TRUE if the contact was found, and @iter was set. %FALSE otherwise.
+ * Returns: %TRUE if the contact was found, and @iter was set. %FALSE otherwise.
**/
gboolean
e_contact_store_find_contact (EContactStore *contact_store, const gchar *uid,
@@ -835,7 +835,7 @@ e_contact_store_find_contact (EContactStore *contact_store, const gchar *uid,
*
* Gets the list of books that provide contacts for @contact_store.
*
- * Return value: A #GList of pointers to #EBook. The caller owns the list,
+ * Returns: A #GList of pointers to #EBook. The caller owns the list,
* but not the books.
**/
GList *
@@ -959,7 +959,7 @@ e_contact_store_set_query (EContactStore *contact_store, EBookQuery *book_query)
* Gets the query that's being used to fetch contacts from the books
* assigned to @contact_store.
*
- * Return value: The #EBookQuery being used.
+ * Returns: The #EBookQuery being used.
**/
EBookQuery *
e_contact_store_peek_query (EContactStore *contact_store)
diff --git a/libedataserverui/e-destination-store.c b/libedataserverui/e-destination-store.c
index de546bc..4577776 100644
--- a/libedataserverui/e-destination-store.c
+++ b/libedataserverui/e-destination-store.c
@@ -144,7 +144,7 @@ e_destination_store_finalize (GObject *object)
*
* Creates a new #EDestinationStore.
*
- * Return value: A new #EDestinationStore.
+ * Returns: A new #EDestinationStore.
**/
EDestinationStore *
e_destination_store_new (void)
@@ -280,7 +280,7 @@ destination_changed (EDestinationStore *destination_store, EDestination *destina
*
* Gets the #EDestination from @destination_store at @iter.
*
- * Return value: An #EDestination.
+ * Returns: An #EDestination.
**/
EDestination *
e_destination_store_get_destination (EDestinationStore *destination_store, GtkTreeIter *iter)
@@ -301,7 +301,7 @@ e_destination_store_get_destination (EDestinationStore *destination_store, GtkTr
*
* Gets a list of all the #EDestinations in @destination_store.
*
- * Return value: A #GList of pointers to #EDestination. The list is owned
+ * Returns: A #GList of pointers to #EDestination. The list is owned
* by the caller, but the #EDestination elements aren't.
**/
GList *
diff --git a/libedataserverui/e-name-selector-dialog.c b/libedataserverui/e-name-selector-dialog.c
index 279c18f..b773e6e 100644
--- a/libedataserverui/e-name-selector-dialog.c
+++ b/libedataserverui/e-name-selector-dialog.c
@@ -349,7 +349,7 @@ e_name_selector_dialog_class_init (ENameSelectorDialogClass *name_selector_dialo
*
* Creates a new #ENameSelectorDialog.
*
- * Return value: A new #ENameSelectorDialog.
+ * Returns: A new #ENameSelectorDialog.
**/
ENameSelectorDialog *
e_name_selector_dialog_new (void)
@@ -1224,7 +1224,7 @@ destination_column_formatter (GtkTreeViewColumn *column, GtkCellRenderer *cell,
*
* Gets the #ENameSelectorModel used by @name_selector_model.
*
- * Return value: The #ENameSelectorModel being used.
+ * Returns: The #ENameSelectorModel being used.
**/
ENameSelectorModel *
e_name_selector_dialog_peek_model (ENameSelectorDialog *name_selector_dialog)
diff --git a/libedataserverui/e-name-selector-entry.c b/libedataserverui/e-name-selector-entry.c
index 156f5a8..f429002 100644
--- a/libedataserverui/e-name-selector-entry.c
+++ b/libedataserverui/e-name-selector-entry.c
@@ -2742,7 +2742,7 @@ e_name_selector_entry_init (ENameSelectorEntry *name_selector_entry)
*
* Creates a new #ENameSelectorEntry.
*
- * Return value: A new #ENameSelectorEntry.
+ * Returns: A new #ENameSelectorEntry.
**/
ENameSelectorEntry *
e_name_selector_entry_new (void)
@@ -2756,7 +2756,7 @@ e_name_selector_entry_new (void)
*
* Gets the #EContactStore being used by @name_selector_entry.
*
- * Return value: An #EContactStore.
+ * Returns: An #EContactStore.
**/
EContactStore *
e_name_selector_entry_peek_contact_store (ENameSelectorEntry *name_selector_entry)
@@ -2798,7 +2798,7 @@ e_name_selector_entry_set_contact_store (ENameSelectorEntry *name_selector_entry
*
* Gets the #EDestinationStore being used to store @name_selector_entry's destinations.
*
- * Return value: An #EDestinationStore.
+ * Returns: An #EDestinationStore.
**/
EDestinationStore *
e_name_selector_entry_peek_destination_store (ENameSelectorEntry *name_selector_entry)
diff --git a/libedataserverui/e-name-selector-model.c b/libedataserverui/e-name-selector-model.c
index 439a92d..033ec19 100644
--- a/libedataserverui/e-name-selector-model.c
+++ b/libedataserverui/e-name-selector-model.c
@@ -130,7 +130,7 @@ e_name_selector_model_class_init (ENameSelectorModelClass *name_selector_model_c
*
* Creates a new #ENameSelectorModel.
*
- * Return value: A new #ENameSelectorModel.
+ * Returns: A new #ENameSelectorModel.
**/
ENameSelectorModel *
e_name_selector_model_new (void)
@@ -357,7 +357,7 @@ find_section_by_name (ENameSelectorModel *name_selector_model, const gchar *name
*
* Gets the #EContactStore associated with @name_selector_model.
*
- * Return value: An #EContactStore.
+ * Returns: An #EContactStore.
**/
EContactStore *
e_name_selector_model_peek_contact_store (ENameSelectorModel *name_selector_model)
@@ -374,7 +374,7 @@ e_name_selector_model_peek_contact_store (ENameSelectorModel *name_selector_mode
* Gets the #ETreeModelGenerator being used to filter and/or extend the
* list of contacts in @name_selector_model's #EContactStore.
*
- * Return value: An #ETreeModelGenerator.
+ * Returns: An #ETreeModelGenerator.
**/
ETreeModelGenerator *
e_name_selector_model_peek_contact_filter (ENameSelectorModel *name_selector_model)
@@ -390,7 +390,7 @@ e_name_selector_model_peek_contact_filter (ENameSelectorModel *name_selector_mod
*
* Gets a list of the destination sections in @name_selector_model.
*
- * Return value: A #GList of pointers to strings. The #GList and the
+ * Returns: A #GList of pointers to strings. The #GList and the
* strings belong to the caller, and must be freed when no longer needed.
**/
GList *
diff --git a/libedataserverui/e-name-selector.c b/libedataserverui/e-name-selector.c
index a50440a..5ad7426 100644
--- a/libedataserverui/e-name-selector.c
+++ b/libedataserverui/e-name-selector.c
@@ -200,7 +200,7 @@ e_name_selector_finalize (GObject *object)
*
* Creates a new #ENameSelector.
*
- * Return value: A new #ENameSelector.
+ * Returns: A new #ENameSelector.
**/
ENameSelector *
e_name_selector_new (void)
@@ -253,7 +253,7 @@ find_section_by_name (ENameSelector *name_selector, const gchar *name)
*
* Gets the #ENameSelectorModel used by @name_selector.
*
- * Return value: The #ENameSelectorModel used by @name_selector.
+ * Returns: The #ENameSelectorModel used by @name_selector.
**/
ENameSelectorModel *
e_name_selector_peek_model (ENameSelector *name_selector)
@@ -269,7 +269,7 @@ e_name_selector_peek_model (ENameSelector *name_selector)
*
* Gets the #ENameSelectorDialog used by @name_selector.
*
- * Return value: The #ENameSelectorDialog used by @name_selector.
+ * Returns: The #ENameSelectorDialog used by @name_selector.
**/
ENameSelectorDialog *
e_name_selector_peek_dialog (ENameSelector *name_selector)
@@ -293,7 +293,7 @@ e_name_selector_peek_dialog (ENameSelector *name_selector)
*
* Gets the #ENameSelectorEntry for the section specified by @name.
*
- * Return value: The #ENameSelectorEntry for the named section, or %NULL if it
+ * Returns: The #ENameSelectorEntry for the named section, or %NULL if it
* doesn't exist in the #ENameSelectorModel.
**/
ENameSelectorEntry *
@@ -357,7 +357,7 @@ e_name_selector_peek_section_entry (ENameSelector *name_selector, const gchar *n
*
* Gets the #ENameSelectorList for the section specified by @name.
*
- * Return value: The #ENameSelectorList for the named section, or %NULL if it
+ * Returns: The #ENameSelectorList for the named section, or %NULL if it
* doesn't exist in the #ENameSelectorModel.
**/
diff --git a/libedataserverui/e-passwords.c b/libedataserverui/e-passwords.c
index 9081f99..e675284 100644
--- a/libedataserverui/e-passwords.c
+++ b/libedataserverui/e-passwords.c
@@ -1426,7 +1426,7 @@ e_passwords_forget_password (const gchar *component_name, const gchar *key)
* e_passwords_get_password:
* @key: the key
*
- * Return value: the password associated with @key, or %NULL. Caller
+ * Returns: the password associated with @key, or %NULL. Caller
* must free the returned password.
**/
gchar *
@@ -1490,7 +1490,7 @@ e_passwords_add_password (const gchar *key, const gchar *passwd)
*
* Asks the user for a password.
*
- * Return value: the password, which the caller must free, or %NULL if
+ * Returns: the password, which the caller must free, or %NULL if
* the user cancelled the operation. * remember will be set if the
* return value is non-%NULL and @remember_type is not
* E_PASSWORDS_DO_NOT_REMEMBER.
diff --git a/libedataserverui/e-source-option-menu.c b/libedataserverui/e-source-option-menu.c
index f9afc26..cfacb5b 100644
--- a/libedataserverui/e-source-option-menu.c
+++ b/libedataserverui/e-source-option-menu.c
@@ -271,7 +271,7 @@ e_source_option_menu_init (ESourceOptionMenu *source_option_menu)
* Creates a new #ESourceOptionMenu widget that lets the user pick
* an #ESource from the provided #ESourceList.
*
- * Return value: A new #ESourceOptionMenu.
+ * Returns: A new #ESourceOptionMenu.
**/
GtkWidget *
e_source_option_menu_new (ESourceList *source_list)
@@ -295,7 +295,7 @@ e_source_option_menu_new (ESourceList *source_list)
* e_source_option_menu_peek_selected:
* @menu: an #ESourceOptionMenu
*
- * Return value: The selected #ESource, or %NULL if none was selected.
+ * Returns: The selected #ESource, or %NULL if none was selected.
**/
ESource *
e_source_option_menu_peek_selected (ESourceOptionMenu *menu)
diff --git a/libedataserverui/e-source-selector-dialog.c b/libedataserverui/e-source-selector-dialog.c
index fc6f16e..27fba4a 100644
--- a/libedataserverui/e-source-selector-dialog.c
+++ b/libedataserverui/e-source-selector-dialog.c
@@ -214,7 +214,7 @@ setup_dialog (GtkWindow *parent, ESourceSelectorDialog *dialog, ESourceList *sou
*
* Create a new source selector dialog for the given @list.
*
- * Return value: The newly created widget.
+ * Returns: The newly created widget.
*/
GtkWidget *
e_source_selector_dialog_new (GtkWindow *parent, ESourceList *source_list)
@@ -234,7 +234,7 @@ e_source_selector_dialog_new (GtkWindow *parent, ESourceList *source_list)
*
* Selects default source in the dialog.
*
- * Return value: Whether found any default source.
+ * Returns: Whether found any default source.
*
* Since: 2.28
**/
@@ -282,7 +282,7 @@ e_source_selector_dialog_select_default_source (ESourceSelectorDialog *dialog)
*
* Peek the currently selected source in the given @dialog.
*
- * Return value: the selected ESource.
+ * Returns: the selected ESource.
*/
ESource *
e_source_selector_dialog_peek_primary_selection (ESourceSelectorDialog *dialog)
diff --git a/libedataserverui/e-source-selector.c b/libedataserverui/e-source-selector.c
index 1b9f4a6..f6ee77f 100644
--- a/libedataserverui/e-source-selector.c
+++ b/libedataserverui/e-source-selector.c
@@ -1322,7 +1322,7 @@ e_source_selector_init (ESourceSelector *selector)
* Create a new view for @list. The view will update automatically when @list
* changes.
*
- * Return value: The newly created widget.
+ * Returns: The newly created widget.
**/
GtkWidget *
e_source_selector_new (ESourceList *list)
@@ -1358,7 +1358,7 @@ e_source_selector_get_source_list (ESourceSelector *selector)
* Get the list of selected sources, i.e. those that were enabled through the
* corresponding checkboxes in the tree.
*
- * Return value: A list of the ESources currently selected. The sources will
+ * Returns: A list of the ESources currently selected. The sources will
* be in the same order as they appear on the screen, and the list should be
* freed using e_source_selector_free_selection().
**/
@@ -1399,7 +1399,7 @@ e_source_selector_get_selection (ESourceSelector *selector)
*
* Gets the primary source group associated with the selector.
*
- * Return value: primary_source_group if selector is valid, NULL otherwise.
+ * Returns: primary_source_group if selector is valid, NULL otherwise.
**/
ESourceGroup *
e_source_selector_get_primary_source_group (ESourceSelector *selector)
@@ -1457,7 +1457,7 @@ e_source_selector_show_selection (ESourceSelector *selector,
*
* Check whether the checkboxes in the ESourceSelector are being shown or not.
*
- * Return value: %TRUE if the checkboxes are shown, %FALSE otherwise.
+ * Returns: %TRUE if the checkboxes are shown, %FALSE otherwise.
**/
gboolean
e_source_selector_selection_shown (ESourceSelector *selector)
@@ -1635,7 +1635,7 @@ e_source_selector_select_exclusive (ESourceSelector *selector,
*
* Check whether @source is selected in @selector.
*
- * Return value: %TRUE if @source is currently selected, %FALSE otherwise.
+ * Returns: %TRUE if @source is currently selected, %FALSE otherwise.
**/
gboolean
e_source_selector_source_is_selected (ESourceSelector *selector,
@@ -1720,7 +1720,7 @@ e_source_selector_edit_primary_selection (ESourceSelector *selector)
* to the "normal" selection, which is the set of source whose checkboxes are
* checked).
*
- * Return value: The selected source.
+ * Returns: The selected source.
**/
ESource *
e_source_selector_peek_primary_selection (ESourceSelector *selector)
diff --git a/libedataserverui/e-tree-model-generator.c b/libedataserverui/e-tree-model-generator.c
index 3d666bd..b1237f7 100644
--- a/libedataserverui/e-tree-model-generator.c
+++ b/libedataserverui/e-tree-model-generator.c
@@ -689,7 +689,7 @@ child_row_deleted (ETreeModelGenerator *tree_model_generator, GtkTreePath *path)
*
* Creates a new #ETreeModelGenerator wrapping @child_model.
*
- * Return value: A new #ETreeModelGenerator.
+ * Returns: A new #ETreeModelGenerator.
**/
ETreeModelGenerator *
e_tree_model_generator_new (GtkTreeModel *child_model)
@@ -706,7 +706,7 @@ e_tree_model_generator_new (GtkTreeModel *child_model)
*
* Gets the child model being wrapped by @tree_model_generator.
*
- * Return value: A #GtkTreeModel being wrapped.
+ * Returns: A #GtkTreeModel being wrapped.
**/
GtkTreeModel *
e_tree_model_generator_get_model (ETreeModelGenerator *tree_model_generator)
@@ -771,7 +771,7 @@ e_tree_model_generator_set_modify_func (ETreeModelGenerator *tree_model_generato
*
* Convert a path to a child row to a path to a @tree_model_generator row.
*
- * Return value: A new GtkTreePath, owned by the caller.
+ * Returns: A new GtkTreePath, owned by the caller.
**/
GtkTreePath *
e_tree_model_generator_convert_child_path_to_path (ETreeModelGenerator *tree_model_generator,
@@ -863,7 +863,7 @@ e_tree_model_generator_convert_child_iter_to_iter (ETreeModelGenerator *tree_mod
*
* Converts @generator_path to a corresponding #GtkTreePath in the child model.
*
- * Return value: A new #GtkTreePath, owned by the caller.
+ * Returns: A new #GtkTreePath, owned by the caller.
**/
GtkTreePath *
e_tree_model_generator_convert_path_to_child_path (ETreeModelGenerator *tree_model_generator,
diff --git a/servers/groupwise/soup-soap-message.c b/servers/groupwise/soup-soap-message.c
index 4180f72..2f26bc9 100644
--- a/servers/groupwise/soup-soap-message.c
+++ b/servers/groupwise/soup-soap-message.c
@@ -754,7 +754,7 @@ soup_soap_message_persist (SoupSoapMessage *msg)
* Returns the namespace prefix for @ns_uri (or an empty string if
* @ns_uri is set to the default namespace)
*
- * Return value: The namespace prefix, or %NULL if no namespace exists
+ * Returns: The namespace prefix, or %NULL if no namespace exists
* for the URI given.
*/
const gchar *
@@ -785,7 +785,7 @@ soup_soap_message_get_namespace_prefix (SoupSoapMessage *msg, const gchar *ns_ur
* Returns the internal XML representation tree of the
* #SoupSoapMessage pointed to by @msg.
*
- * Return value: the #xmlDocPtr representing the SOAP message.
+ * Returns: the #xmlDocPtr representing the SOAP message.
*/
xmlDocPtr
soup_soap_message_get_xml_doc (SoupSoapMessage *msg)
@@ -804,7 +804,7 @@ soup_soap_message_get_xml_doc (SoupSoapMessage *msg)
*
* Parses the response returned by the server.
*
- * Return value: a #SoupSoapResponse representing the response from
+ * Returns: a #SoupSoapResponse representing the response from
* the server, or %NULL if there was an error.
*/
SoupSoapResponse *
diff --git a/servers/groupwise/soup-soap-response.c b/servers/groupwise/soup-soap-response.c
index 6b03d5d..9c0f048 100644
--- a/servers/groupwise/soup-soap-response.c
+++ b/servers/groupwise/soup-soap-response.c
@@ -61,7 +61,7 @@ soup_soap_response_init (SoupSoapResponse *response)
* Create a new empty #SoupSoapResponse object, which can be modified
* with the accessor functions provided with this class.
*
- * Return value: the new #SoupSoapResponse (or %NULL if there was an
+ * Returns: the new #SoupSoapResponse (or %NULL if there was an
* error).
*/
SoupSoapResponse *
@@ -80,7 +80,7 @@ soup_soap_response_new (void)
* Create a new #SoupSoapResponse object from the XML string contained
* in @xmlstr.
*
- * Return value: the new #SoupSoapResponse (or %NULL if there was an
+ * Returns: the new #SoupSoapResponse (or %NULL if there was an
* error).
*/
SoupSoapResponse *
@@ -125,7 +125,7 @@ parse_parameters (SoupSoapResponsePrivate *priv, xmlNodePtr xml_method)
* Parses the string contained in @xmlstr and sets all properties from
* it in the @response object.
*
- * Return value: %TRUE if successful, %FALSE otherwise.
+ * Returns: %TRUE if successful, %FALSE otherwise.
*/
gboolean
soup_soap_response_from_string (SoupSoapResponse *response, const gchar *xmlstr)
@@ -194,7 +194,7 @@ soup_soap_response_from_string (SoupSoapResponse *response, const gchar *xmlstr)
*
* Gets the method name from the SOAP response.
*
- * Return value: the method name.
+ * Returns: the method name.
*/
const gchar *
soup_soap_response_get_method_name (SoupSoapResponse *response)
@@ -234,7 +234,7 @@ soup_soap_response_set_method_name (SoupSoapResponse *response, const gchar *met
*
* Returns the parameter name.
*
- * Return value: the parameter name.
+ * Returns: the parameter name.
*/
const gchar *
soup_soap_parameter_get_name (SoupSoapParameter *param)
@@ -250,7 +250,7 @@ soup_soap_parameter_get_name (SoupSoapParameter *param)
*
* Returns the parameter's (integer) value.
*
- * Return value: the parameter value as an integer
+ * Returns: the parameter value as an integer
*/
gint
soup_soap_parameter_get_int_value (SoupSoapParameter *param)
@@ -276,7 +276,7 @@ soup_soap_parameter_get_int_value (SoupSoapParameter *param)
*
* Returns the parameter's value.
*
- * Return value: the parameter value as a string, which must be freed
+ * Returns: the parameter value as a string, which must be freed
* by the caller.
*/
gchar *
@@ -301,7 +301,7 @@ soup_soap_parameter_get_string_value (SoupSoapParameter *param)
* for compound data types, which can contain several parameters
* themselves.
*
- * Return value: the first child or %NULL if there are no children.
+ * Returns: the first child or %NULL if there are no children.
*/
SoupSoapParameter *
soup_soap_parameter_get_first_child (SoupSoapParameter *param)
@@ -319,7 +319,7 @@ soup_soap_parameter_get_first_child (SoupSoapParameter *param)
* Gets the first child of the given #SoupSoapParameter whose name is
* @name.
*
- * Return value: the first child with the given name or %NULL if there
+ * Returns: the first child with the given name or %NULL if there
* are no children.
*/
SoupSoapParameter *
@@ -350,7 +350,7 @@ soup_soap_parameter_get_first_child_by_name (SoupSoapParameter *param, const gch
*
* FIXME: the name of this method is wrong
*
- * Return value: the next sibling, or %NULL if there are no more
+ * Returns: the next sibling, or %NULL if there are no more
* siblings.
*/
SoupSoapParameter *
@@ -371,7 +371,7 @@ soup_soap_parameter_get_next_child (SoupSoapParameter *param)
*
* FIXME: the name of this method is wrong
*
- * Return value: the next sibling with the given name, or %NULL
+ * Returns: the next sibling with the given name, or %NULL
*/
SoupSoapParameter *
soup_soap_parameter_get_next_child_by_name (SoupSoapParameter *param,
@@ -399,7 +399,7 @@ soup_soap_parameter_get_next_child_by_name (SoupSoapParameter *param,
*
* Returns the named property of @param.
*
- * Return value: the property, which must be freed by the caller.
+ * Returns: the property, which must be freed by the caller.
*/
gchar *
soup_soap_parameter_get_property (SoupSoapParameter *param, const gchar *prop_name)
@@ -423,7 +423,7 @@ soup_soap_parameter_get_property (SoupSoapParameter *param, const gchar *prop_na
*
* Returns the list of parameters received in the SOAP response.
*
- * Return value: a list of #SoupSoapParameter
+ * Returns: a list of #SoupSoapParameter
*/
const GList *
soup_soap_response_get_parameters (SoupSoapResponse *response)
@@ -442,7 +442,7 @@ soup_soap_response_get_parameters (SoupSoapResponse *response)
*
* Retrieves the first parameter contained in the SOAP response.
*
- * Return value: a #SoupSoapParameter representing the first
+ * Returns: a #SoupSoapParameter representing the first
* parameter, or %NULL if there are no parameters.
*/
SoupSoapParameter *
@@ -464,7 +464,7 @@ soup_soap_response_get_first_parameter (SoupSoapResponse *response)
* Retrieves the first parameter contained in the SOAP response whose
* name is @name.
*
- * Return value: a #SoupSoapParameter representing the first parameter
+ * Returns: a #SoupSoapParameter representing the first parameter
* with the given name, or %NULL.
*/
SoupSoapParameter *
@@ -496,7 +496,7 @@ soup_soap_response_get_first_parameter_by_name (SoupSoapResponse *response,
* Retrieves the parameter following @from in the #SoupSoapResponse
* object.
*
- * Return value: a #SoupSoapParameter representing the parameter.
+ * Returns: a #SoupSoapParameter representing the parameter.
*/
SoupSoapParameter *
soup_soap_response_get_next_parameter (SoupSoapResponse *response,
@@ -525,7 +525,7 @@ soup_soap_response_get_next_parameter (SoupSoapResponse *response,
* Retrieves the first parameter following @from in the
* #SoupSoapResponse object whose name matches @name.
*
- * Return value: a #SoupSoapParameter representing the parameter.
+ * Returns: a #SoupSoapParameter representing the parameter.
*/
SoupSoapParameter *
soup_soap_response_get_next_parameter_by_name (SoupSoapResponse *response,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
