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/psk.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/psk.c')
| -rw-r--r-- | lib/psk.c | 12 |
1 files changed, 4 insertions, 8 deletions
@@ -39,8 +39,7 @@ * gnutls_psk_free_client_credentials: * @sc: is a #gnutls_psk_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_psk_client_credentials_t structure. **/ void gnutls_psk_free_client_credentials(gnutls_psk_client_credentials_t sc) { @@ -53,8 +52,7 @@ void gnutls_psk_free_client_credentials(gnutls_psk_client_credentials_t sc) * gnutls_psk_allocate_client_credentials: * @sc: is a pointer to a #gnutls_psk_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_psk_client_credentials_t structure. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise * an error code is returned. @@ -152,8 +150,7 @@ gnutls_psk_set_client_credentials(gnutls_psk_client_credentials_t res, * gnutls_psk_free_server_credentials: * @sc: is a #gnutls_psk_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_psk_server_credentials_t structure. **/ void gnutls_psk_free_server_credentials(gnutls_psk_server_credentials_t sc) { @@ -166,8 +163,7 @@ void gnutls_psk_free_server_credentials(gnutls_psk_server_credentials_t sc) * gnutls_psk_allocate_server_credentials: * @sc: is a pointer to a #gnutls_psk_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_psk_server_credentials_t structure. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise * an error code is returned. |