From: Simon Josefsson <simon@josefsson.org>
Date: Wed, 3 Aug 2011 06:32:21 +0000 (+0200)
Subject: More GTK-DOC fixes.
X-Git-Tag: gnutls_3_0_1~15^2~31
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f9f6655af3521dde83f2fa84c85b7e245ecb4356;p=thirdparty%2Fgnutls.git

More GTK-DOC fixes.
---

diff --git a/lib/includes/gnutls/abstract.h b/lib/includes/gnutls/abstract.h
index ba0eff5c68..638a5ec0cd 100644
--- a/lib/includes/gnutls/abstract.h
+++ b/lib/includes/gnutls/abstract.h
@@ -180,11 +180,19 @@ int gnutls_x509_crq_privkey_sign (gnutls_x509_crq_t crq,
                                   gnutls_digest_algorithm_t dig,
                                   unsigned int flags);
 
-/* pcert */
-typedef struct gnutls_pcert_st {
-	gnutls_pubkey_t pubkey;
-	gnutls_datum_t cert;
-	gnutls_certificate_type_t type;    /* type of the certificate */
+/**
+ * gnutls_pcert_st:
+ * @pubkey: public key of parsed certificate.
+ * @cert: certificate itself of parsed certificate
+ * @type: type of certificate, a #gnutls_certificate_type_t type.
+ *
+ * A parsed certificate.
+ */
+typedef struct gnutls_pcert_st
+{
+  gnutls_pubkey_t pubkey;
+  gnutls_datum_t cert;
+  gnutls_certificate_type_t type;
 } gnutls_pcert_st;
 
 /* Do not initialize the "cert" element of
diff --git a/lib/includes/gnutls/dtls.h b/lib/includes/gnutls/dtls.h
index da8d283335..91497419ca 100644
--- a/lib/includes/gnutls/dtls.h
+++ b/lib/includes/gnutls/dtls.h
@@ -38,34 +38,49 @@ extern "C"
 
 #define GNUTLS_COOKIE_KEY_SIZE 16
 
-void gnutls_dtls_set_timeouts (gnutls_session_t session, unsigned int retrans_timeout,
-  unsigned int total_timeout);
+void gnutls_dtls_set_timeouts (gnutls_session_t session,
+			       unsigned int retrans_timeout,
+			       unsigned int total_timeout);
 
 unsigned int gnutls_dtls_get_mtu (gnutls_session_t session);
 unsigned int gnutls_dtls_get_data_mtu (gnutls_session_t session);
 
-void gnutls_dtls_set_mtu (gnutls_session_t session, unsigned int mtu);
-
-typedef struct {
-  unsigned int record_seq;
-  unsigned int hsk_read_seq;
-  unsigned int hsk_write_seq;
-} gnutls_dtls_prestate_st;
-
-int gnutls_dtls_cookie_send(gnutls_datum_t* key, void* client_data, size_t client_data_size, 
-  gnutls_dtls_prestate_st* prestate,
-  gnutls_transport_ptr_t ptr, gnutls_push_func push_func);
-
-
-int gnutls_dtls_cookie_verify(gnutls_datum_t* key, 
-  void* client_data, size_t client_data_size, 
-  void* _msg, size_t msg_size, gnutls_dtls_prestate_st* prestate);
-
-void gnutls_dtls_prestate_set(gnutls_session_t session, gnutls_dtls_prestate_st* prestate);
+  void gnutls_dtls_set_mtu (gnutls_session_t session, unsigned int mtu);
+
+  /**
+   * gnutls_dtls_prestate_st:
+   * @record_seq: record sequence number
+   * @hsk_read_seq: handshake read sequence number
+   * @hsk_write_seq: handshake write sequence number
+   *
+   * DTLS cookie prestate struct.  This is usually never modified by
+   * the application, it is used to carry the cookie data between
+   * gnutls_dtls_cookie_send(), gnutls_dtls_cookie_verify() and
+   * gnutls_dtls_prestate_set().
+   */
+  typedef struct
+  {
+    unsigned int record_seq;
+    unsigned int hsk_read_seq;
+    unsigned int hsk_write_seq;
+  } gnutls_dtls_prestate_st;
+
+  int gnutls_dtls_cookie_send (gnutls_datum_t* key,
+			       void* client_data, size_t client_data_size,
+			       gnutls_dtls_prestate_st* prestate,
+			       gnutls_transport_ptr_t ptr,
+			       gnutls_push_func push_func);
+
+  int gnutls_dtls_cookie_verify (gnutls_datum_t* key,
+				 void* client_data, size_t client_data_size,
+				 void* _msg, size_t msg_size,
+				 gnutls_dtls_prestate_st* prestate);
+
+  void gnutls_dtls_prestate_set (gnutls_session_t session,
+				 gnutls_dtls_prestate_st* prestate);
 
 #ifdef __cplusplus
 }
 #endif
 
 #endif                          /* GNUTLS_DTLS_H */
-