From d607d38a877e8cea68aee3b3196e1a5f797bef2d Mon Sep 17 00:00:00 2001
From: Simon Josefsson <simon@josefsson.org>
Date: Thu, 28 May 2009 11:24:29 +0200
Subject: Doc fix.

---
 lib/gnutls_ui.c | 43 +++++++++++++++++++++----------------------
 1 file changed, 21 insertions(+), 22 deletions(-)

(limited to 'lib/gnutls_ui.c')

diff --git a/lib/gnutls_ui.c b/lib/gnutls_ui.c
index cedf1a0d47..6ad2e4f729 100644
--- a/lib/gnutls_ui.c
+++ b/lib/gnutls_ui.c
@@ -63,14 +63,14 @@ gnutls_dh_set_prime_bits (gnutls_session_t session, unsigned int bits)
 
 
 /**
- * gnutls_dh_get_group - return the group of the DH authentication
+ * gnutls_dh_get_group - return the group of the D-H key exchange
  * @session: is a gnutls session
  * @raw_gen: will hold the generator.
  * @raw_prime: will hold the prime.
  *
  * This function will return the group parameters used in the last
- * Diffie-Hellman authentication with the peer.  These are the prime
- * and the generator used.  This function should be used for both
+ * Diffie-Hellman key exchange with the peer.  These are the prime and
+ * the generator used.  This function should be used for both
  * anonymous and ephemeral Diffie-Hellman.  The output parameters must
  * be freed with gnutls_free().
  *
@@ -131,14 +131,14 @@ gnutls_dh_get_group (gnutls_session_t session,
 }
 
 /**
- * gnutls_dh_get_pubkey - return the peer's public key used in DH authentication
+ * gnutls_dh_get_pubkey - return the peer's public key used in D-H key exchange
  * @session: is a gnutls session
  * @raw_key: will hold the public key.
  *
  * This function will return the peer's public key used in the last
- * Diffie-Hellman authentication.  This function should be used for
- * both anonymous and ephemeral Diffie-Hellman.  The output parameters
- * must be freed with gnutls_free().
+ * Diffie-Hellman key exchange.  This function should be used for both
+ * anonymous and ephemeral Diffie-Hellman.  The output parameters must
+ * be freed with gnutls_free().
  *
  * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
  *   an error code is returned.
@@ -239,12 +239,12 @@ gnutls_rsa_export_get_pubkey (gnutls_session_t session,
 
 
 /**
- * gnutls_dh_get_secret_bits - return the bits used in DH authentication
+ * gnutls_dh_get_secret_bits - return the bits used in D-H key exchange
  * @session: is a gnutls session
  *
  * This function will return the bits used in the last Diffie-Hellman
- * authentication with the peer.  Should be used for both anonymous
- * and ephemeral Diffie-Hellman.
+ * key exchange with the peer.  Should be used for both anonymous and
+ * ephemeral Diffie-Hellman.
  *
  * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
  *   an error code is returned.
@@ -290,17 +290,17 @@ gnutls_dh_get_secret_bits (gnutls_session_t session)
 
 
 /**
- * gnutls_dh_get_prime_bits - return the bits used in DH authentication
+ * gnutls_dh_get_prime_bits - return the bits used in D-H key exchange
  * @session: is a gnutls session
  *
  * This function will return the bits of the prime used in the last
- * Diffie-Hellman authentication with the peer.  Should be used for
- * both anonymous and ephemeral Diffie-Hellman.  Note that some
- * ciphers, like RSA and DSA without DHE, does not use a
- * Diffie-Hellman exchange, and then this function will return 0.
+ * Diffie-Hellman key exchange with the peer.  Should be used for both
+ * anonymous and ephemeral Diffie-Hellman.  Note that some ciphers,
+ * like RSA and DSA without DHE, does not use a Diffie-Hellman key
+ * exchange, and then this function will return 0.
  *
  * Returns: The Diffie-Hellman bit strength is returned, or 0 if no
- *   Diffie-Hellman exchange was done, or a negative error code on
+ *   Diffie-Hellman key exchange was done, or a negative error code on
  *   failure.
  **/
 int
@@ -372,14 +372,14 @@ gnutls_rsa_export_get_modulus_bits (gnutls_session_t session)
 }
 
 /**
- * gnutls_dh_get_peers_public_bits - return the bits used in DH authentication
+ * gnutls_dh_get_peers_public_bits - return the bits used in D-H key exchange
  * @session: is a gnutls session
  *
  * Get the Diffie-Hellman public key bit size.  Can be used for both
  * anonymous and ephemeral Diffie-Hellman.
  *
  * Returns: the public key bit size used in the last Diffie-Hellman
- * authentication with the peer, or a negative value in case of error.
+ *   key exchange with the peer, or a negative value in case of error.
  **/
 int
 gnutls_dh_get_peers_public_bits (gnutls_session_t session)
@@ -507,8 +507,8 @@ gnutls_certificate_get_peers (gnutls_session_t
  * Get whether client certificate is requested or not.
  *
  * Returns: 0 if the peer (server) did not request client
- * authentication or 1 otherwise, or a negative value in case of
- * error.
+ *   authentication or 1 otherwise, or a negative value in case of
+ *   error.
  **/
 int
 gnutls_certificate_client_get_request_status (gnutls_session_t session)
@@ -604,7 +604,6 @@ gnutls_certificate_set_dh_params (gnutls_certificate_credentials_t res,
  * This function will set a callback in order for the server to get
  * the Diffie-Hellman or RSA parameters for certificate
  * authentication.  The callback should return zero on success.
- *
  **/
 void
 gnutls_certificate_set_params_function (gnutls_certificate_credentials_t res,
@@ -673,7 +672,7 @@ gnutls_certificate_set_rsa_export_params (gnutls_certificate_credentials_t
  * @func: is the function to be called
  *
  * This function will set a callback in order for the server to get
- * the Diffie-Hellman or RSA parameters for psk authentication.  The
+ * the Diffie-Hellman or RSA parameters for PSK authentication.  The
  * callback should return zero on success.
  **/
 void
-- 
cgit v1.2.1