updated documentation on gnutls_vdata_types_t based on DKG's suggestions

1 files changed, 11 insertions, 4 deletions

diff --git a/lib/includes/gnutls/gnutls.h.in b/lib/includes/gnutls/gnutls.h.in
index 24ab202d35..e74679c173 100644
--- a/lib/includes/gnutls/gnutls.h.in
+++ b/lib/includes/gnutls/gnutls.h.in
@@ -2042,11 +2042,18 @@ int gnutls_certificate_verify_peers3(gnutls_session_t session,
 /**
  * gnutls_vdata_types_t:
  * @GNUTLS_DT_UNKNOWN: Unknown data type.
- * @GNUTLS_DT_DNS_HOSTNAME: The data contain a null-terminated DNS hostname.
- * @GNUTLS_DT_RFC822NAME: The data contain a null-terminated email address.
- * @GNUTLS_DT_KEY_PURPOSE_OID: The data contain a null-terminated key purpose OID.
+ * @GNUTLS_DT_DNS_HOSTNAME: The data contain a null-terminated DNS hostname; the hostname will be 
+ *   matched using the RFC6125 rules.
+ * @GNUTLS_DT_RFC822NAME: The data contain a null-terminated email address; the email will be
+ *   matched against the RFC822Name field of the certificate, or the EMAIL DN component if the
+ *   former isn't available. Prior to matching the email address will be converted to ACE
+ *   (ASCII-compatible-encoding).
+ * @GNUTLS_DT_KEY_PURPOSE_OID: The data contain a null-terminated key purpose OID. It will be matched
+ *   against the certificate's Extended Key Usage extension.
  *
- * Enumeration of different key exchange algorithms.
+ * Enumeration of different typed-data options. They are used as input to certificate
+ * verification functions to provide information about the name and purpose of the
+ * certificate. Only a single option of a type can be provided to the relevant functions.
  */
 typedef enum {
 	GNUTLS_DT_UNKNOWN = 0,