[gnio] Use Returns: in gtk-doc, not Return value:



commit 475e60f6e4b7418e07f44f9bbb6f9742f8c96879
Author: Alexander Larsson <alexl redhat com>
Date:   Thu May 7 16:48:20 2009 +0200

    Use Returns: in gtk-doc, not Return value:
---
 gio/gsocket.c |   22 +++++++++++-----------
 1 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/gio/gsocket.c b/gio/gsocket.c
index 7fc9e4b..f015093 100644
--- a/gio/gsocket.c
+++ b/gio/gsocket.c
@@ -1511,7 +1511,7 @@ g_socket_connect (GSocket         *socket,
  *
  * On error -1 is returned and @error is set accordingly.
  *
- * Return value: Number of bytes read, or -1 on error
+ * Returns: Number of bytes read, or -1 on error
  *
  * Since: 2.22
  **/
@@ -1575,7 +1575,7 @@ g_socket_receive (GSocket       *socket,
  *
  * On error -1 is returned and @error is set accordingly.
  *
- * Return value: Number of bytes read, or -1 on error
+ * Returns: Number of bytes read, or -1 on error
  *
  * Since: 2.22
  **/
@@ -1622,7 +1622,7 @@ g_socket_receive_from (GSocket       *socket,
  *
  * On error -1 is returned and @error is set accordingly.
  *
- * Return value: Number of bytes read, or -1 on error
+ * Returns: Number of bytes read, or -1 on error
  *
  * Since: 2.22
  **/
@@ -1689,7 +1689,7 @@ g_socket_send (GSocket      *socket,
  *
  * On error -1 is returned and @error is set accordingly.
  *
- * Return value: Number of bytes read, or -1 on error
+ * Returns: Number of bytes read, or -1 on error
  *
  * Since: 2.22
  **/
@@ -1730,7 +1730,7 @@ g_socket_send_to (GSocket      *socket,
  * is dropped, but you might want to call this function to make sure
  * resources are released as early as possible.
  *
- * Return value: %TRUE on success, %FALSE on error
+ * Returns: %TRUE on success, %FALSE on error
  *
  * Since: 2.22
  **/
@@ -1790,7 +1790,7 @@ g_socket_close (GSocket *socket,
  *
  * Checks whether a socket is closed.
  *
- * Return value: %TRUE if socket is closed, %FALSE otherwise
+ * Returns: %TRUE if socket is closed, %FALSE otherwise
  *
  * Since: 2.22
  **/
@@ -2118,7 +2118,7 @@ winsock_source_new (GSocket      *socket,
  * cause the source to trigger, reporting the current condition. You can
  * check for this in the callback using g_cancellable_is_cancelled().
  *
- * Return value: a newly allocated %GSource, free with g_source_unref().
+ * Returns: a newly allocated %GSource, free with g_source_unref().
  *
  * Since: 2.22
  **/
@@ -2153,7 +2153,7 @@ g_socket_create_source (GSocket      *socket,
  *
  * This call never blocks.
  *
- * Return value: the @GIOCondition mask of the current state
+ * Returns: the @GIOCondition mask of the current state
  *
  * Since: 2.22
  **/
@@ -2204,7 +2204,7 @@ g_socket_condition_check (GSocket       *socket,
  * If @cancellable is cancelled before the condition becomes true then
  * %FALSE is returned and @error, if non-%NULL, is set to %G_IO_ERROR_CANCELLED.
  *
- * Return value: %TRUE if the condition was met, %FALSE otherwise
+ * Returns: %TRUE if the condition was met, %FALSE otherwise
  *
  * Since: 2.22
  **/
@@ -2343,7 +2343,7 @@ g_socket_condition_wait (GSocket       *socket,
  *
  * On error -1 is returned and @error is set accordingly.
  *
- * Return value: Number of bytes read, or -1 on error
+ * Returns: Number of bytes read, or -1 on error
  *
  * Since: 2.22
  **/
@@ -2607,7 +2607,7 @@ g_socket_send_message (GSocket                *socket,
  *
  * On error -1 is returned and @error is set accordingly.
  *
- * Return value: Number of bytes read, or -1 on error
+ * Returns: Number of bytes read, or -1 on error
  *
  * Since: 2.22
  **/



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]