]> git.ipfire.org Git - thirdparty/gnutls.git/commitdiff
Fix GTK-DOC warnings.
authorSimon Josefsson <simon@josefsson.org>
Sat, 16 Jul 2005 11:18:02 +0000 (11:18 +0000)
committerSimon Josefsson <simon@josefsson.org>
Sat, 16 Jul 2005 11:18:02 +0000 (11:18 +0000)
lib/gnutls_alert.c
lib/gnutls_anon_cred.c

index ea34abb82bfb33025509752bc2c074229b01b227..32fd597b818d9ffbecac2a07ddd554df0d826835 100644 (file)
@@ -78,8 +78,8 @@ static const gnutls_alert_entry sup_alerts[] = {
   * gnutls_alert_get_name - Returns a string describing the alert number given
   * @alert: is an alert number #gnutls_session_t structure.
   *
-  * Returns a string that describes the given alert number or NULL.
-  * See gnutls_alert_get().
+  * This function will return a string that describes the given alert
+  * number or NULL.  See gnutls_alert_get().
   *
   **/
 const char *gnutls_alert_get_name(gnutls_alert_description_t alert)
@@ -274,11 +274,11 @@ int gnutls_alert_send_appropriate(gnutls_session_t session, int err)
   * gnutls_alert_get - Returns the last alert number received.
   * @session: is a #gnutls_session_t structure.
   *
-  * Returns the last alert number received. This function
-  * should be called if GNUTLS_E_WARNING_ALERT_RECEIVED or
-  * GNUTLS_E_FATAL_ALERT_RECEIVED has been returned by a gnutls function.
-  * The peer may send alerts if he thinks some things were not 
-  * right. Check gnutls.h for the available alert descriptions.
+  * This function will return the last alert number received. This
+  * function should be called if GNUTLS_E_WARNING_ALERT_RECEIVED or
+  * GNUTLS_E_FATAL_ALERT_RECEIVED has been returned by a gnutls
+  * function.  The peer may send alerts if he thinks some things were
+  * not right. Check gnutls.h for the available alert descriptions.
   *
   * If no alert has been received the returned value is undefined.
   *
index eb34478cca4c7ee3d65bef7b5ee97fe3738edbdc..84cf5ca928d4f864ea0b2d26340c42ee4bdba410 100644 (file)
@@ -85,6 +85,8 @@ gnutls_dh_params_t _gnutls_anon_get_dh_params(const
   *
   * This structure is complex enough to manipulate directly thus
   * this helper function is provided in order to allocate it.
+  *
+  * Returns a negative value in case of an error.
   **/
 int
 gnutls_anon_allocate_server_credentials(gnutls_anon_server_credentials_t *
@@ -115,6 +117,8 @@ void gnutls_anon_free_client_credentials(gnutls_anon_client_credentials_t
  *
  * This structure is complex enough to manipulate directly thus
  * this helper function is provided in order to allocate it.
+ *
+ * Returns a negative value in case of an error.
  **/
 int
 gnutls_anon_allocate_client_credentials(gnutls_anon_client_credentials_t *