From 24d802e87be5870b7d91aa83965fe5d5deb4141b Mon Sep 17 00:00:00 2001 From: Attila Molnar Date: Sat, 6 Feb 2016 18:16:59 +0100 Subject: doc: Update description of credential alloc/dealloc functions Get rid of "This structure is complex enough to manipulate directly..." text which suggests that these functions are optional, "helper" functions when in fact their usage is required for encapsulation reasons. --- lib/anon_cred.c | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) (limited to 'lib/anon_cred.c') diff --git a/lib/anon_cred.c b/lib/anon_cred.c index 66a3ce29ea..7d4adb374e 100644 --- a/lib/anon_cred.c +++ b/lib/anon_cred.c @@ -35,8 +35,7 @@ * gnutls_anon_free_server_credentials: * @sc: is a #gnutls_anon_server_credentials_t type. * - * This structure is complex enough to manipulate directly thus this - * helper function is provided in order to free (deallocate) it. + * Free a gnutls_anon_server_credentials_t structure. **/ void gnutls_anon_free_server_credentials(gnutls_anon_server_credentials_t sc) @@ -49,8 +48,7 @@ gnutls_anon_free_server_credentials(gnutls_anon_server_credentials_t sc) * gnutls_anon_allocate_server_credentials: * @sc: is a pointer to a #gnutls_anon_server_credentials_t type. * - * This structure is complex enough to manipulate directly thus this - * helper function is provided in order to allocate it. + * Allocate a gnutls_anon_server_credentials_t structure. * * Returns: %GNUTLS_E_SUCCESS on success, or an error code. **/ @@ -69,8 +67,7 @@ gnutls_anon_allocate_server_credentials(gnutls_anon_server_credentials_t * * gnutls_anon_free_client_credentials: * @sc: is a #gnutls_anon_client_credentials_t type. * - * This structure is complex enough to manipulate directly thus this - * helper function is provided in order to free (deallocate) it. + * Free a gnutls_anon_client_credentials_t structure. **/ void gnutls_anon_free_client_credentials(gnutls_anon_client_credentials_t sc) @@ -85,8 +82,7 @@ static const gnutls_anon_client_credentials_t anon_dummy = * gnutls_anon_allocate_client_credentials: * @sc: is a pointer to a #gnutls_anon_client_credentials_t type. * - * This structure is complex enough to manipulate directly thus - * this helper function is provided in order to allocate it. + * Allocate a gnutls_anon_client_credentials_t structure. * * Returns: %GNUTLS_E_SUCCESS on success, or an error code. **/ -- cgit v1.2.1