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/cert.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/cert.c')
| -rw-r--r-- | lib/cert.c | 6 |
1 files changed, 2 insertions, 4 deletions
diff --git a/lib/cert.c b/lib/cert.c index 7e0b24268f..99b2effe7e 100644 --- a/lib/cert.c +++ b/lib/cert.c @@ -183,8 +183,7 @@ void gnutls_certificate_free_ca_names(gnutls_certificate_credentials_t sc) * gnutls_certificate_free_credentials: * @sc: is a #gnutls_certificate_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_certificate_credentials_t structure. * * This function does not free any temporary parameters associated * with this structure (ie RSA and DH parameters are not freed by this @@ -209,8 +208,7 @@ gnutls_certificate_free_credentials(gnutls_certificate_credentials_t sc) * gnutls_certificate_allocate_credentials: * @res: is a pointer to a #gnutls_certificate_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_certificate_credentials_t structure. * * Returns: %GNUTLS_E_SUCCESS on success, or an error code. **/ |