diff options
| author | Nikos Mavrogiannopoulos <nmav@gnutls.org> | 2012-03-17 09:24:00 +0100 |
|---|---|---|
| committer | Nikos Mavrogiannopoulos <nmav@gnutls.org> | 2012-03-17 09:24:00 +0100 |
| commit | 8af7669ec60d3f8bddeda0bd7295aff4986bd708 (patch) | |
| tree | 41abf6df62cf98ce7d350be77cf45ddfb9969b94 | |
| parent | dbd17e9817319a4a32038f3559f7677003560fba (diff) | |
| download | gnutls-8af7669ec60d3f8bddeda0bd7295aff4986bd708.tar.gz | |
corrected the documentation of the verification functions.
| -rw-r--r-- | lib/gnutls_pubkey.c | 12 | ||||
| -rw-r--r-- | lib/x509/crq.c | 5 | ||||
| -rw-r--r-- | lib/x509/x509.c | 4 |
3 files changed, 10 insertions, 11 deletions
diff --git a/lib/gnutls_pubkey.c b/lib/gnutls_pubkey.c index ba0c2c4e05..d66a531a83 100644 --- a/lib/gnutls_pubkey.c +++ b/lib/gnutls_pubkey.c @@ -1304,8 +1304,8 @@ gnutls_pubkey_import_dsa_raw (gnutls_pubkey_t key, * This function will verify the given signed data, using the * parameters from the certificate. * - * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a - * negative error value (%GNUTLS_E_PK_SIG_VERIFY_FAILED in verification failure). + * Returns: In case of a verification failure %GNUTLS_E_PK_SIG_VERIFY_FAILED + * is returned, and zero or positive code on success. * * Since: 2.12.0 **/ @@ -1343,8 +1343,8 @@ gnutls_pubkey_verify_data (gnutls_pubkey_t pubkey, unsigned int flags, * This function will verify the given signed data, using the * parameters from the certificate. * - * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a - * negative error value (%GNUTLS_E_PK_SIG_VERIFY_FAILED in verification failure). + * Returns: In case of a verification failure %GNUTLS_E_PK_SIG_VERIFY_FAILED + * is returned, and zero or positive code on success. * * Since: 3.0 **/ @@ -1384,8 +1384,8 @@ gnutls_pubkey_verify_data2 (gnutls_pubkey_t pubkey, * This function will verify the given signed digest, using the * parameters from the public key. * - * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a - * negative error value (%GNUTLS_E_PK_SIG_VERIFY_FAILED in verification failure). + * Returns: In case of a verification failure %GNUTLS_E_PK_SIG_VERIFY_FAILED + * is returned, and zero or positive code on success. * * Since: 2.12.0 **/ diff --git a/lib/x509/crq.c b/lib/x509/crq.c index e21341ebba..4873d69087 100644 --- a/lib/x509/crq.c +++ b/lib/x509/crq.c @@ -2422,9 +2422,8 @@ gnutls_x509_crq_privkey_sign (gnutls_x509_crq_t crq, gnutls_privkey_t key, * This function will verify self signature in the certificate * request and return its status. * - * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, - * %GNUTLS_E_PK_SIG_VERIFY_FAILED if verification failed, otherwise a - * negative error value. + * Returns: In case of a verification failure %GNUTLS_E_PK_SIG_VERIFY_FAILED + * is returned, and zero or positive code on success. * * Since 2.12.0 **/ diff --git a/lib/x509/x509.c b/lib/x509/x509.c index d98a2b6529..fc36e89192 100644 --- a/lib/x509/x509.c +++ b/lib/x509/x509.c @@ -2585,7 +2585,7 @@ gnutls_x509_crt_get_preferred_hash_algorithm (gnutls_x509_crt_t crt, * Deprecated. Please use gnutls_pubkey_verify_data(). * * Returns: In case of a verification failure %GNUTLS_E_PK_SIG_VERIFY_FAILED - * is returned, and a positive code on success. + * is returned, and zero or positive code on success. **/ int gnutls_x509_crt_verify_data (gnutls_x509_crt_t crt, unsigned int flags, @@ -2623,7 +2623,7 @@ gnutls_x509_crt_verify_data (gnutls_x509_crt_t crt, unsigned int flags, * Deprecated. Please use gnutls_pubkey_verify_data(). * * Returns: In case of a verification failure %GNUTLS_E_PK_SIG_VERIFY_FAILED - * is returned, and a positive code on success. + * is returned, and zero or positive code on success. **/ int gnutls_x509_crt_verify_hash (gnutls_x509_crt_t crt, unsigned int flags, |