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.

diff --git a/lib/anon_cred.c b/lib/anon_cred.c
index 66a3ce29eade88845d0b1eb92b426e6b26fdaeed..7d4adb374e3a88ccad134a76ab08bb35b8dd3bd4 100644 (file)
--- 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.
  **/

diff --git a/lib/cert.c b/lib/cert.c
index 7e0b24268f2c522c0ed9be62ab72d0a0091a2499..99b2effe7e4bf30345d2967ebd684297ba778793 100644 (file)
--- 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.
  **/

diff --git a/lib/psk.c b/lib/psk.c
index 73383fabb701db9d13e52e75543d8f875efb507b..6b305ee457ae3d9cf1232d71dc2429c26ffa4ed7 100644 (file)
--- a/lib/psk.c
+++ b/lib/psk.c
@@ -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.

diff --git a/lib/srp.c b/lib/srp.c
index 74df3f0fdaf364103d978af8b936a1bb76f17077..655b4a38d10c6f8fda2003380c9553706497e566 100644 (file)
--- a/lib/srp.c
+++ b/lib/srp.c
@@ -408,8 +408,7 @@ _gnutls_calc_srp_S2(bigint_t B, bigint_t g, bigint_t x, bigint_t a,
  * gnutls_srp_free_client_credentials:
  * @sc: is a #gnutls_srp_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_srp_client_credentials_t structure.
  **/
 void gnutls_srp_free_client_credentials(gnutls_srp_client_credentials_t sc)
 {
@@ -422,8 +421,7 @@ void gnutls_srp_free_client_credentials(gnutls_srp_client_credentials_t sc)
  * gnutls_srp_allocate_client_credentials:
  * @sc: is a pointer to a #gnutls_srp_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_srp_client_credentials_t structure.
  *
  * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, or an
  *   error code.
@@ -483,8 +481,7 @@ gnutls_srp_set_client_credentials(gnutls_srp_client_credentials_t res,
  * gnutls_srp_free_server_credentials:
  * @sc: is a #gnutls_srp_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_srp_server_credentials_t structure.
  **/
 void gnutls_srp_free_server_credentials(gnutls_srp_server_credentials_t sc)
 {
@@ -511,8 +508,7 @@ void gnutls_srp_free_server_credentials(gnutls_srp_server_credentials_t sc)
  * gnutls_srp_allocate_server_credentials:
  * @sc: is a pointer to a #gnutls_srp_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_srp_server_credentials_t structure.
  *
  * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, or an
  *   error code.