From: Simon Josefsson <simon@josefsson.org>
Date: Wed, 17 Feb 2010 15:59:59 +0000 (+0100)
Subject: Document enum.
X-Git-Tag: gnutls_2_9_10~87
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=2d77f6a1be61e43bb3baec5f136fb1c4a3b36986;p=thirdparty%2Fgnutls.git

Document enum.
---

diff --git a/lib/includes/gnutls/pkcs12.h b/lib/includes/gnutls/pkcs12.h
index a2cea1d8c3..8867224056 100644
--- a/lib/includes/gnutls/pkcs12.h
+++ b/lib/includes/gnutls/pkcs12.h
@@ -61,18 +61,31 @@ extern "C"
   int gnutls_pkcs12_bag_encrypt (gnutls_pkcs12_bag_t bag, const char *pass,
 				 unsigned int flags);
 
+  /**
+   * gnutls_pkcs12_bag_type_t:
+   * @GNUTLS_BAG_EMPTY: Empty PKCS-12 bag.
+   * @GNUTLS_BAG_PKCS8_ENCRYPTED_KEY: PKCS-12 bag with PKCS-8 encrypted key.
+   * @GNUTLS_BAG_PKCS8_KEY: PKCS-12 bag with PKCS-8 key.
+   * @GNUTLS_BAG_CERTIFICATE: PKCS-12 bag with certificate.
+   * @GNUTLS_BAG_CRL: PKCS-12 bag with CRL.
+   * @GNUTLS_BAG_SECRET: PKCS-12 bag with secret PKCS-9 keys.
+   * @GNUTLS_BAG_ENCRYPTED: Encrypted PKCS-12 bag.
+   * @GNUTLS_BAG_UNKNOWN: Unknown PKCS-12 bag.
+   *
+   * Enumeration of different PKCS 12 bag types.
+   */
   typedef enum gnutls_pkcs12_bag_type_t
   {
     GNUTLS_BAG_EMPTY = 0,
-
     GNUTLS_BAG_PKCS8_ENCRYPTED_KEY = 1,
-    GNUTLS_BAG_PKCS8_KEY,
-    GNUTLS_BAG_CERTIFICATE,
-    GNUTLS_BAG_CRL,
-    GNUTLS_BAG_SECRET, /* secret data. Underspecified in pkcs-12, gnutls extension. We use
-                        * the PKCS-9 random nonce ID (1.2.840.113549.1.9.25.3) to store randomly
-                        * generated keys.
-                        */
+    GNUTLS_BAG_PKCS8_KEY = 2,
+    GNUTLS_BAG_CERTIFICATE = 3,
+    GNUTLS_BAG_CRL = 4,
+    GNUTLS_BAG_SECRET = 5, /* Secret data. Underspecified in pkcs-12,
+			    * gnutls extension. We use the PKCS-9
+			    * random nonce ID 1.2.840.113549.1.9.25.3
+			    * to store randomly generated keys.
+			    */
     GNUTLS_BAG_ENCRYPTED = 10,
     GNUTLS_BAG_UNKNOWN = 20
   } gnutls_pkcs12_bag_type_t;