Doc fixes.

diff --git a/lib/gnutls_handshake.c b/lib/gnutls_handshake.c
index 2217a72c1c77eecc780d48a5fc5aaba57adbbfcb..2fa35579eb5f6811782e9b40b22c64c2e4602610 100644 (file)
--- a/lib/gnutls_handshake.c
+++ b/lib/gnutls_handshake.c
@@ -2000,21 +2000,23 @@ _gnutls_recv_hello (gnutls_session_t session, opaque * data, int datalen)
   * @session: is a #gnutls_session_t structure.
   *
   * This function will renegotiate security parameters with the
-  * client. This should only be called in case of a server.
+  * client.  This should only be called in case of a server.
   *
   * This message informs the peer that we want to renegotiate
   * parameters (perform a handshake).
   *
-  * If this function succeeds (returns 0), you must call
-  * the gnutls_handshake() function in order to negotiate
-  * the new parameters.
+  * If this function succeeds (returns 0), you must call the
+  * gnutls_handshake() function in order to negotiate the new
+  * parameters.
   *
-  * If the client does not wish to renegotiate parameters he
-  * will should with an alert message, thus the return code will be
-  * GNUTLS_E_WARNING_ALERT_RECEIVED and the alert will be
-  * GNUTLS_A_NO_RENEGOTIATION. A client may also choose to ignore
+  * If the client does not wish to renegotiate parameters he will
+  * should with an alert message, thus the return code will be
+  * %GNUTLS_E_WARNING_ALERT_RECEIVED and the alert will be
+  * %GNUTLS_A_NO_RENEGOTIATION.  A client may also choose to ignore
   * this message.
   *
+  * Returns: %GNUTLS_E_SUCCESS on success, otherwise an error.
+  *
   **/
 int
 gnutls_rehandshake (gnutls_session_t session)
@@ -2150,24 +2152,27 @@ _gnutls_recv_supplemental (gnutls_session_t session)
   * gnutls_handshake - This is the main function in the handshake protocol.
   * @session: is a #gnutls_session_t structure.
   *
-  * This function does the handshake of the TLS/SSL protocol,
-  * and initializes the TLS connection. 
+  * This function does the handshake of the TLS/SSL protocol, and
+  * initializes the TLS connection.
+  *
+  * This function will fail if any problem is encountered, and will
+  * return a negative error code. In case of a client, if the client
+  * has asked to resume a session, but the server couldn't, then a
+  * full handshake will be performed.
   *
-  * This function will fail if any problem is encountered,
-  * and will return a negative error code. In case of a client,
-  * if the client has asked to resume a session, but the server couldn't, 
-  * then a full handshake will be performed.
+  * The non-fatal errors such as %GNUTLS_E_AGAIN and
+  * %GNUTLS_E_INTERRUPTED interrupt the handshake procedure, which
+  * should be later be resumed.  Call this function again, until it
+  * returns 0; cf.  gnutls_record_get_direction() and
+  * gnutls_error_is_fatal().
   *
-  * The non-fatal errors such as GNUTLS_E_AGAIN and GNUTLS_E_INTERRUPTED
-  * interrupt the handshake procedure, which should be later be resumed.
-  * Call this function again, until it returns 0; cf.
-  * gnutls_record_get_direction() and gnutls_error_is_fatal().
+  * If this function is called by a server after a rehandshake request
+  * then %GNUTLS_E_GOT_APPLICATION_DATA or
+  * %GNUTLS_E_WARNING_ALERT_RECEIVED may be returned.  Note that these
+  * are non fatal errors, only in the specific case of a rehandshake.
+  * Their meaning is that the client rejected the rehandshake request.
   *
-  * If this function is called by a server after a rehandshake request then
-  * GNUTLS_E_GOT_APPLICATION_DATA or GNUTLS_E_WARNING_ALERT_RECEIVED 
-  * may be returned. Note that these are non fatal errors, only in the
-  * specific case of a rehandshake. Their meaning is that the client
-  * rejected the rehandshake request.
+  * Returns: %GNUTLS_E_SUCCESS on success, otherwise an error.
   *
   **/
 int
@@ -2906,9 +2911,9 @@ _gnutls_remove_unwanted_ciphersuites (gnutls_session_t session,
   * @max: is the maximum number.
   *
   * This function will set the maximum size of a handshake message.
-  * Handshake messages over this size are rejected.
-  * The default value is 16kb which is large enough. Set this to 0 if you do not want
-  * to set an upper limit.
+  * Handshake messages over this size are rejected.  The default value
+  * is 16kb which is large enough. Set this to 0 if you do not want to
+  * set an upper limit.
   *
   **/
 void
@@ -2935,11 +2940,15 @@ _gnutls_get_adv_version (gnutls_session_t session)
   * gnutls_handshake_get_last_in - Returns the last handshake message received.
   * @session: is a #gnutls_session_t structure.
   *
-  * Returns the last handshake message received. This function is only useful
-  * to check where the last performed handshake failed. If the previous handshake
-  * succeed or was not performed at all then no meaningful value will be returned.
+  * This function is only useful to check where the last performed
+  * handshake failed.  If the previous handshake succeed or was not
+  * performed at all then no meaningful value will be returned.
+  *
+  * Check %gnutls_handshake_description_t in gnutls.h for the
+  * available handshake descriptions.
   *
-  * Check gnutls.h for the available handshake descriptions.
+  * Returns: the last handshake message type received, a
+  * %gnutls_handshake_description_t.
   **/
 gnutls_handshake_description_t
 gnutls_handshake_get_last_in (gnutls_session_t session)
@@ -2951,12 +2960,15 @@ gnutls_handshake_get_last_in (gnutls_session_t session)
   * gnutls_handshake_get_last_out - Returns the last handshake message sent.
   * @session: is a #gnutls_session_t structure.
   *
-  * Returns the last handshake message sent. This function is only useful
-  * to check where the last performed handshake failed. If the previous handshake
-  * succeed or was not performed at all then no meaningful value will be returned.
+  * This function is only useful to check where the last performed
+  * handshake failed.  If the previous handshake succeed or was not
+  * performed at all then no meaningful value will be returned.
   *
-  * Check gnutls.h for the available handshake descriptions.
+  * Check %gnutls_handshake_description_t in gnutls.h for the
+  * available handshake descriptions.
   *
+  * Returns: the last handshake message type sent, a
+  * %gnutls_handshake_description_t.
   **/
 gnutls_handshake_description_t
 gnutls_handshake_get_last_out (gnutls_session_t session)