Doc markup for newly added APIs.

8 files changed, 87 insertions, 0 deletions

diff --git a/doc/reference/gnutls-docs.sgml b/doc/reference/gnutls-docs.sgml
index cbd9951a91..c418ae9f1e 100644
--- a/doc/reference/gnutls-docs.sgml
+++ b/doc/reference/gnutls-docs.sgml
@@ -33,4 +33,10 @@
   <index>
     <title>Index</title>
   </index>
+  <index role="deprecated">
+    <title>Index of deprecated symbols</title>
+  </index>
+  <index role="2.4.0">
+    <title>Index of new symbols in 2.4.0</title>
+  </index>
 </book>
diff --git a/lib/gnutls_cert.c b/lib/gnutls_cert.c
index 18ae9a86d6..9fce4bd79e 100644
--- a/lib/gnutls_cert.c
+++ b/lib/gnutls_cert.c
@@ -122,6 +122,7 @@ gnutls_certificate_free_cas (gnutls_certificate_credentials_t sc)
   * This function will export all the CAs associated
   * with the given credentials. 
   *
+  * Since: 2.4.0
   **/
 void
 gnutls_certificate_get_x509_cas (gnutls_certificate_credentials_t sc, 
@@ -140,6 +141,7 @@ gnutls_certificate_get_x509_cas (gnutls_certificate_credentials_t sc,
   * This function will export the OpenPGP keyring associated
   * with the given credentials. 
   *
+  * Since: 2.4.0
   **/
 void
 gnutls_certificate_get_x509_crls (gnutls_certificate_credentials_t sc, 
@@ -159,6 +161,7 @@ gnutls_certificate_get_x509_crls (gnutls_certificate_credentials_t sc,
   * This function will export all the CRLs associated
   * with the given credentials. 
   *
+  * Since: 2.4.0
   **/
 void
 gnutls_certificate_get_openpgp_keyring (gnutls_certificate_credentials_t sc, 
diff --git a/lib/gnutls_openpgp.c b/lib/gnutls_openpgp.c
index 16e1d0c83d..de64fddcb6 100644
--- a/lib/gnutls_openpgp.c
+++ b/lib/gnutls_openpgp.c
@@ -354,6 +354,8 @@ static int get_keyid( gnutls_openpgp_keyid_t keyid, const char* str)
  *
  * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
  *   negative error value.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_certificate_set_openpgp_key_mem2 (gnutls_certificate_credentials_t
@@ -444,6 +446,8 @@ gnutls_certificate_set_openpgp_key_mem2 (gnutls_certificate_credentials_t
  *
  * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
  *   negative error value.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_certificate_set_openpgp_key_file2 (gnutls_certificate_credentials_t
diff --git a/lib/gnutls_str.c b/lib/gnutls_str.c
index d566f99ce5..723d6f30eb 100644
--- a/lib/gnutls_str.c
+++ b/lib/gnutls_str.c
@@ -281,6 +281,8 @@ _gnutls_bin2hex (const void *_old, size_t oldlen,
  * Convert a buffer with hex data to binary data.
  *
  * Returns: %GNUTLS_E_SUCCESS on success, otherwise an error.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_hex2bin (const char * hex_data,
diff --git a/lib/gnutls_x509.c b/lib/gnutls_x509.c
index 74baede6e5..b2a834dadc 100644
--- a/lib/gnutls_x509.c
+++ b/lib/gnutls_x509.c
@@ -863,6 +863,8 @@ gnutls_certificate_set_x509_key_mem (gnutls_certificate_credentials_t
   * for the server).
   *
   * Returns: %GNUTLS_E_SUCCESS on success, or an error code.
+  *
+  * Since: 2.4.0
   **/
 int
 gnutls_certificate_set_x509_key (gnutls_certificate_credentials_t res,
@@ -1292,6 +1294,8 @@ gnutls_certificate_set_x509_trust_mem (gnutls_certificate_credentials_t
   * gnutls_certificate_send_x509_rdn_sequence().
   *
   * Returns: %GNUTLS_E_SUCCESS on success, or an error code.
+  *
+  * Since: 2.4.0
   **/
 int
 gnutls_certificate_set_x509_trust (gnutls_certificate_credentials_t res,
@@ -1599,6 +1603,8 @@ gnutls_certificate_set_x509_crl_mem (gnutls_certificate_credentials_t
   * multiple times.
   *
   * Returns: %GNUTLS_E_SUCCESS on success, or an error code.
+  *
+  * Since: 2.4.0
   **/
 int
 gnutls_certificate_set_x509_crl (gnutls_certificate_credentials_t res,
diff --git a/lib/openpgp/pgp.c b/lib/openpgp/pgp.c
index 50609e406e..81e1e771e8 100644
--- a/lib/openpgp/pgp.c
+++ b/lib/openpgp/pgp.c
@@ -483,6 +483,8 @@ gnutls_openpgp_crt_get_expiration_time (gnutls_openpgp_crt_t key)
  * Get key id string.
  *
  * Returns: the 64-bit keyID of the OpenPGP key.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_crt_get_key_id (gnutls_openpgp_crt_t key,
@@ -516,6 +518,8 @@ gnutls_openpgp_crt_get_key_id (gnutls_openpgp_crt_t key,
  *
  * Returns: true (1) if the key has been revoked, or false (0) if it
  *   has not.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_crt_get_revoked_status (gnutls_openpgp_crt_t key)
@@ -631,6 +635,8 @@ gnutls_openpgp_crt_get_key_usage (gnutls_openpgp_crt_t key,
  * given OpenPGP certificate.
  *
  * Returns: the number of subkeys, or a negative value on error.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_crt_get_subkey_count (gnutls_openpgp_crt_t key)
@@ -767,6 +773,8 @@ int _gnutls_openpgp_find_subkey_idx( cdk_kbnode_t knode, uint32_t keyid[2],
  *
  * Returns: true (1) if the key has been revoked, or false (0) if it
  *   has not.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_crt_get_subkey_revoked_status (gnutls_openpgp_crt_t key,
@@ -803,6 +811,8 @@ gnutls_openpgp_crt_get_subkey_revoked_status (gnutls_openpgp_crt_t key,
  *
  * Returns: a member of the #gnutls_pk_algorithm_t enumeration on
  *   success, or a negative value on error.
+ *
+ * Since: 2.4.0
  **/
 gnutls_pk_algorithm_t
 gnutls_openpgp_crt_get_subkey_pk_algorithm (gnutls_openpgp_crt_t key,
@@ -838,6 +848,8 @@ gnutls_openpgp_crt_get_subkey_pk_algorithm (gnutls_openpgp_crt_t key,
  * Get subkey creation time.
  *
  * Returns: the timestamp when the OpenPGP sub-key was created.
+ *
+ * Since: 2.4.0
  **/
 time_t
 gnutls_openpgp_crt_get_subkey_creation_time (gnutls_openpgp_crt_t key,
@@ -868,6 +880,8 @@ gnutls_openpgp_crt_get_subkey_creation_time (gnutls_openpgp_crt_t key,
  * doesn't expire at all.
  *
  * Returns: the time when the OpenPGP key expires.
+ *
+ * Since: 2.4.0
  **/
 time_t
 gnutls_openpgp_crt_get_subkey_expiration_time (gnutls_openpgp_crt_t key,
@@ -931,6 +945,8 @@ gnutls_openpgp_crt_get_subkey_id (gnutls_openpgp_crt_t key,
  * Get subkey's index.
  *
  * Returns: the index of the subkey or a negative error value.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_crt_get_subkey_idx (gnutls_openpgp_crt_t key,
@@ -969,6 +985,8 @@ gnutls_openpgp_crt_get_subkey_idx (gnutls_openpgp_crt_t key,
  * A negative value may be returned in case of parsing error.
  *
  * Returns: key usage value.
+ *
+ * Since: 2.4.0
  */
 int
 gnutls_openpgp_crt_get_subkey_usage (gnutls_openpgp_crt_t key,
@@ -1300,6 +1318,8 @@ cleanup:
  * gnutls_malloc() and will be stored in the appropriate datum.
  *
  * Returns: %GNUTLS_E_SUCCESS on success, otherwise an error.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_crt_get_pk_rsa_raw (gnutls_openpgp_crt_t crt, 
@@ -1331,6 +1351,8 @@ int ret;
  * gnutls_malloc() and will be stored in the appropriate datum.
  *
  * Returns: %GNUTLS_E_SUCCESS on success, otherwise an error.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_crt_get_pk_dsa_raw (gnutls_openpgp_crt_t crt, 
@@ -1362,6 +1384,8 @@ int ret;
  * gnutls_malloc() and will be stored in the appropriate datum.
  *
  * Returns: %GNUTLS_E_SUCCESS on success, otherwise an error.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_crt_get_subkey_pk_rsa_raw (gnutls_openpgp_crt_t crt, unsigned int idx,
@@ -1394,6 +1418,8 @@ int ret;
  * gnutls_malloc() and will be stored in the appropriate datum.
  *
  * Returns: %GNUTLS_E_SUCCESS on success, otherwise an error.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_crt_get_subkey_pk_dsa_raw (gnutls_openpgp_crt_t crt,
diff --git a/lib/openpgp/privkey.c b/lib/openpgp/privkey.c
index 49208ff22d..012ce15d10 100644
--- a/lib/openpgp/privkey.c
+++ b/lib/openpgp/privkey.c
@@ -153,6 +153,8 @@ gnutls_openpgp_privkey_import (gnutls_openpgp_privkey_t key,
  * GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
  *
  * Returns: %GNUTLS_E_SUCCESS on success, or an error code.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_privkey_export (gnutls_openpgp_privkey_t key,
@@ -179,6 +181,8 @@ gnutls_openpgp_privkey_export (gnutls_openpgp_privkey_t key,
  *
  * Returns: a member of the #gnutls_pk_algorithm_t enumeration on
  *   success, or a negative value on error.
+ *
+ * Since: 2.4.0
  **/
 gnutls_pk_algorithm_t
 gnutls_openpgp_privkey_get_pk_algorithm (gnutls_openpgp_privkey_t key,
@@ -229,6 +233,8 @@ int algo;
  *
  * Returns: true (1) if the key has been revoked, or false (0) if it
  *   has not, or a negative value indicates an error.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_privkey_get_revoked_status (gnutls_openpgp_privkey_t key)
@@ -259,6 +265,8 @@ gnutls_openpgp_privkey_get_revoked_status (gnutls_openpgp_privkey_t key)
  * algorithm, the fingerprint can be 16 or 20 bytes.
  *
  * Returns: On success, 0 is returned, or an error code.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_privkey_get_fingerprint (gnutls_openpgp_privkey_t key,
@@ -301,6 +309,8 @@ gnutls_openpgp_privkey_get_fingerprint (gnutls_openpgp_privkey_t key,
  * Get key-id.
  *
  * Returns: the 64-bit keyID of the OpenPGP key.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_privkey_get_key_id (gnutls_openpgp_privkey_t key,
@@ -335,6 +345,8 @@ gnutls_openpgp_privkey_get_key_id (gnutls_openpgp_privkey_t key,
  * given OpenPGP certificate.
  *
  * Returns: the number of subkeys, or a negative value on error.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_privkey_get_subkey_count (gnutls_openpgp_privkey_t key)
@@ -389,6 +401,8 @@ static cdk_packet_t _get_secret_subkey(gnutls_openpgp_privkey_t key, unsigned in
  *
  * Returns: true (1) if the key has been revoked, or false (0) if it
  *   has not, or a negative value indicates an error.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_privkey_get_subkey_revoked_status (gnutls_openpgp_privkey_t key, unsigned int idx)
@@ -424,6 +438,8 @@ gnutls_openpgp_privkey_get_subkey_revoked_status (gnutls_openpgp_privkey_t key,
  *
  * Returns: a member of the #gnutls_pk_algorithm_t enumeration on
  *   success, or a negative value on error.
+ *
+ * Since: 2.4.0
  **/
 gnutls_pk_algorithm_t
 gnutls_openpgp_privkey_get_subkey_pk_algorithm (gnutls_openpgp_privkey_t key,
@@ -465,6 +481,8 @@ gnutls_openpgp_privkey_get_subkey_pk_algorithm (gnutls_openpgp_privkey_t key,
  * Get index of subkey.
  *
  * Returns: the index of the subkey or a negative error value.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_privkey_get_subkey_idx (gnutls_openpgp_privkey_t key,
@@ -498,6 +516,8 @@ gnutls_openpgp_privkey_get_subkey_idx (gnutls_openpgp_privkey_t key,
  * Get subkey creation time.
  *
  * Returns: the timestamp when the OpenPGP key was created.
+ *
+ * Since: 2.4.0
  **/
 time_t
 gnutls_openpgp_privkey_get_subkey_creation_time (gnutls_openpgp_privkey_t key,
@@ -527,6 +547,8 @@ gnutls_openpgp_privkey_get_subkey_creation_time (gnutls_openpgp_privkey_t key,
  * doesn't expire at all.
  *
  * Returns: the time when the OpenPGP key expires.
+ *
+ * Since: 2.4.0
  **/
 time_t
 gnutls_openpgp_privkey_get_subkey_expiration_time (gnutls_openpgp_privkey_t key,
@@ -556,6 +578,8 @@ gnutls_openpgp_privkey_get_subkey_expiration_time (gnutls_openpgp_privkey_t key,
  * Get the key-id for the subkey.
  *
  * Returns: the 64-bit keyID of the OpenPGP key.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_privkey_get_subkey_id (gnutls_openpgp_privkey_t key,
@@ -879,6 +903,8 @@ cleanup:
  * gnutls_malloc() and will be stored in the appropriate datum.
  *
  * Returns: %GNUTLS_E_SUCCESS on success, otherwise an error.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_privkey_export_rsa_raw (gnutls_openpgp_privkey_t pkey, 
@@ -913,6 +939,8 @@ int ret;
  * gnutls_malloc() and will be stored in the appropriate datum.
  *
  * Returns: %GNUTLS_E_SUCCESS on success, otherwise an error.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_privkey_export_dsa_raw (gnutls_openpgp_privkey_t pkey, 
@@ -949,6 +977,8 @@ int ret;
  * gnutls_malloc() and will be stored in the appropriate datum.
  *
  * Returns: %GNUTLS_E_SUCCESS on success, otherwise an error.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_privkey_export_subkey_rsa_raw (gnutls_openpgp_privkey_t pkey, unsigned int idx,
@@ -984,6 +1014,8 @@ int ret;
  * using gnutls_malloc() and will be stored in the appropriate datum.
  *
  * Returns: %GNUTLS_E_SUCCESS on success, otherwise an error.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_openpgp_privkey_export_subkey_dsa_raw (gnutls_openpgp_privkey_t pkey,
diff --git a/lib/x509/dn.c b/lib/x509/dn.c
index 0a25d4e695..44fe5ad8c8 100644
--- a/lib/x509/dn.c
+++ b/lib/x509/dn.c
@@ -953,6 +953,8 @@ _gnutls_x509_set_dn_oid (ASN1_TYPE asn1_struct,
  *
  * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
  *   negative error value.
+ *
+ * Since: 2.4.0
  **/
 int gnutls_x509_dn_init (gnutls_x509_dn_t * odn)
 {
@@ -985,6 +987,8 @@ int gnutls_x509_dn_init (gnutls_x509_dn_t * odn)
  *
  * Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
  *   negative error value.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_x509_dn_import (gnutls_x509_dn_t odn,
@@ -1012,6 +1016,8 @@ gnutls_x509_dn_import (gnutls_x509_dn_t odn,
  *
  * This function deallocates the DN object as returned by
  * gnutls_x509_dn_import().
+ *
+ * Since: 2.4.0
  **/
 void
 gnutls_x509_dn_deinit (gnutls_x509_dn_t idn)
@@ -1149,6 +1155,8 @@ gnutls_x509_rdn_get_by_oid (const gnutls_datum_t * idn, const char *oid,
  * %GNUTLS_E_SHORT_MEMORY_BUFFER is returned and *@sizeof_buf is
  * updated if the provided buffer is not long enough, otherwise a
  * negative error value.
+ *
+ * Since: 2.4.0
  **/
 int
 gnutls_x509_rdn_get_oid (const gnutls_datum_t * idn,