summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Josefsson <simon@josefsson.org>2006-11-16 14:10:31 +0000
committerSimon Josefsson <simon@josefsson.org>2006-11-16 14:10:31 +0000
commitc28295339bdcd84f3c50d5ed503cfe590281e08c (patch)
tree3e40e4b67441534ad6d9ed0a2d9255647b304db7
parentf9cf5f59facbe28a5ad086c4dda5286f8d098adc (diff)
downloadgnutls-c28295339bdcd84f3c50d5ed503cfe590281e08c.tar.gz
(gnutls_record_recv): Fix docstring, suggested by Tim Kosse
<tim.kosse@filezilla-project.org>.
-rw-r--r--lib/gnutls_record.c9
1 files changed, 4 insertions, 5 deletions
diff --git a/lib/gnutls_record.c b/lib/gnutls_record.c
index 2c7bc4a1b6..bb0182819b 100644
--- a/lib/gnutls_record.c
+++ b/lib/gnutls_record.c
@@ -1133,11 +1133,10 @@ gnutls_record_send (gnutls_session_t session, const void *data,
* the client's will.
*
* If EINTR is returned by the internal push function (the default is
- * @code{recv()}) then GNUTLS_E_INTERRUPTED will be returned. If
- * GNUTLS_E_INTERRUPTED or GNUTLS_E_AGAIN is returned, you must call
- * this function again, with the same parameters; alternatively you
- * could provide a NULL pointer for data, and 0 for
- * size. cf. @code{gnutls_record_get_direction()}.
+ * @code{recv()}) then %GNUTLS_E_INTERRUPTED will be returned. If
+ * %GNUTLS_E_INTERRUPTED or %GNUTLS_E_AGAIN is returned, you must
+ * call this function again to get the data. See also
+ * @code{gnutls_record_get_direction()}.
*
* A server may also receive GNUTLS_E_REHANDSHAKE when a client has
* initiated a handshake. In that case the server can only initiate a