Doc fix.

Reported by Peter Hendrickson <pdh@wiredyne.com>.

diff --git a/lib/gnutls_ui.c b/lib/gnutls_ui.c
index bd30a7e69878f6a8f5d12600850e7c70fb2bb5c4..cedf1a0d47d9120e9ae7b396c34c591b89422b2c 100644 (file)
--- a/lib/gnutls_ui.c
+++ b/lib/gnutls_ui.c
@@ -295,10 +295,13 @@ gnutls_dh_get_secret_bits (gnutls_session_t 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.
+ * 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.
  *
- * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
- *   an error code is returned.
+ * Returns: The Diffie-Hellman bit strength is returned, or 0 if no
+ *   Diffie-Hellman exchange was done, or a negative error code on
+ *   failure.
  **/
 int
 gnutls_dh_get_prime_bits (gnutls_session_t session)