diff options
author | Simon Josefsson <simon@josefsson.org> | 2007-11-14 17:52:54 +0100 |
---|---|---|
committer | Simon Josefsson <simon@josefsson.org> | 2007-11-14 17:52:54 +0100 |
commit | 48b83d0ef3c6e043905ef2b0be74c09527254ae6 (patch) | |
tree | 95cc754fa8b2e5303af835737795d355ab407424 | |
parent | 9e8a131169e82446705ce3bd32c49aef6aefb4c5 (diff) | |
download | gnutls-48b83d0ef3c6e043905ef2b0be74c09527254ae6.tar.gz |
Doc fix.
-rw-r--r-- | lib/gnutls_anon_cred.c | 40 |
1 files changed, 17 insertions, 23 deletions
diff --git a/lib/gnutls_anon_cred.c b/lib/gnutls_anon_cred.c index 66b9f2f9d7..9ebceb0fe9 100644 --- a/lib/gnutls_anon_cred.c +++ b/lib/gnutls_anon_cred.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2001, 2004, 2005 Free Software Foundation + * Copyright (C) 2001, 2004, 2005, 2007 Free Software Foundation * * Author: Nikos Mavrogiannopoulos * @@ -39,8 +39,8 @@ static const int anon_dummy; * gnutls_anon_free_server_credentials - Used to free an allocated gnutls_anon_server_credentials_t structure * @sc: is an #gnutls_anon_server_credentials_t structure. * - * This structure is complex enough to manipulate directly thus - * this helper function is provided in order to free (deallocate) it. + * This structure is complex enough to manipulate directly thus this + * helper function is provided in order to free (deallocate) it. **/ void gnutls_anon_free_server_credentials (gnutls_anon_server_credentials_t sc) @@ -53,14 +53,13 @@ gnutls_anon_free_server_credentials (gnutls_anon_server_credentials_t sc) * gnutls_anon_allocate_server_credentials - Used to allocate an gnutls_anon_server_credentials_t structure * @sc: is a pointer to an #gnutls_anon_server_credentials_t structure. * - * This structure is complex enough to manipulate directly thus - * this helper function is provided in order to allocate it. + * This structure is complex enough to manipulate directly thus this + * helper function is provided in order to allocate it. * - * Returns a negative value in case of an error. + * Returns: %GNUTLS_E_SUCCESS on success, or an error code. **/ int -gnutls_anon_allocate_server_credentials (gnutls_anon_server_credentials_t * - sc) +gnutls_anon_allocate_server_credentials (gnutls_anon_server_credentials_t *sc) { *sc = gnutls_calloc (1, sizeof (anon_server_credentials_st)); @@ -73,8 +72,8 @@ gnutls_anon_allocate_server_credentials (gnutls_anon_server_credentials_t * * gnutls_anon_free_client_credentials - Used to free an allocated gnutls_anon_client_credentials_t structure * @sc: is an #gnutls_anon_client_credentials_t structure. * - * This structure is complex enough to manipulate directly thus - * this helper function is provided in order to free (deallocate) it. + * This structure is complex enough to manipulate directly thus this + * helper function is provided in order to free (deallocate) it. **/ void gnutls_anon_free_client_credentials (gnutls_anon_client_credentials_t sc) @@ -88,11 +87,10 @@ gnutls_anon_free_client_credentials (gnutls_anon_client_credentials_t sc) * This structure is complex enough to manipulate directly thus * this helper function is provided in order to allocate it. * - * Returns a negative value in case of an error. + * Returns: %GNUTLS_E_SUCCESS on success, or an error code. **/ int -gnutls_anon_allocate_client_credentials (gnutls_anon_client_credentials_t * - sc) +gnutls_anon_allocate_client_credentials (gnutls_anon_client_credentials_t *sc) { /* anon_dummy is only there for *sc not to be null. * it is not used at all; @@ -107,10 +105,9 @@ gnutls_anon_allocate_client_credentials (gnutls_anon_client_credentials_t * * @res: is a gnutls_anon_server_credentials_t structure * @dh_params: is a structure that holds diffie hellman parameters. * - * This function will set the diffie hellman parameters for an anonymous - * server to use. These parameters will be used in Anonymous Diffie Hellman - * cipher suites. - * + * This function will set the diffie hellman parameters for an + * anonymous server to use. These parameters will be used in + * Anonymous Diffie Hellman cipher suites. **/ void gnutls_anon_set_server_dh_params (gnutls_anon_server_credentials_t res, @@ -124,10 +121,9 @@ gnutls_anon_set_server_dh_params (gnutls_anon_server_credentials_t res, * @res: is a gnutls_certificate_credentials_t structure * @func: is the function to be called * - * This function will set a callback in order for the server to get the - * diffie hellman parameters for anonymous authentication. The callback should - * return zero on success. - * + * This function will set a callback in order for the server to get + * the diffie hellman parameters for anonymous authentication. The + * callback should return zero on success. **/ void gnutls_anon_set_server_params_function (gnutls_anon_server_credentials_t res, @@ -136,6 +132,4 @@ gnutls_anon_set_server_params_function (gnutls_anon_server_credentials_t res, res->params_func = func; } - - #endif |