diff options
| author | Attila Molnar <attilamolnar@hush.com> | 2016-02-06 18:16:59 +0100 |
|---|---|---|
| committer | Nikos Mavrogiannopoulos <nmav@redhat.com> | 2016-02-10 10:49:11 +0100 |
| commit | 24d802e87be5870b7d91aa83965fe5d5deb4141b (patch) | |
| tree | eb521a18d2b39b5f464d86773d2af736e3973039 /lib/anon_cred.c | |
| parent | a48797fc0de2c01e4834c4b5b5889b44027fe54a (diff) | |
| download | gnutls-24d802e87be5870b7d91aa83965fe5d5deb4141b.tar.gz | |
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.
Diffstat (limited to 'lib/anon_cred.c')
| -rw-r--r-- | lib/anon_cred.c | 12 |
1 files changed, 4 insertions, 8 deletions
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. **/ |