summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Josefsson <simon@josefsson.org>2011-08-02 20:42:54 +0200
committerSimon Josefsson <simon@josefsson.org>2011-08-02 20:42:54 +0200
commitbb3071944a5cb27b72e19168d7c7630dcc9d3eb9 (patch)
tree7d583defee13105c4cb0c1b990776824f9bf4649
parentd5c4facbf60e704ac574cfb1378fdc3b43b2977b (diff)
downloadgnutls-bb3071944a5cb27b72e19168d7c7630dcc9d3eb9.tar.gz
Add GTK-DOC Since: tags for 3.0.0 additions.
-rw-r--r--doc/manpages/Makefile.am2
-rw-r--r--doc/reference/gnutls-docs.sgml3
-rw-r--r--lib/algorithms/ecc.c4
-rw-r--r--lib/crypto-api.c8
-rw-r--r--lib/gnutls_alert.c4
-rw-r--r--lib/gnutls_cert.c2
-rw-r--r--lib/gnutls_dtls.c7
-rw-r--r--lib/gnutls_global.c4
-rw-r--r--lib/gnutls_pcert.c12
-rw-r--r--lib/gnutls_pubkey.c6
-rw-r--r--lib/gnutls_record.c2
-rw-r--r--lib/gnutls_state.c4
-rw-r--r--lib/system_override.c1
-rw-r--r--lib/x509/crl.c6
-rw-r--r--lib/x509/privkey.c6
-rw-r--r--lib/x509/verify-high.c14
-rw-r--r--lib/x509/x509.c4
17 files changed, 77 insertions, 12 deletions
diff --git a/doc/manpages/Makefile.am b/doc/manpages/Makefile.am
index 4db2c326a9..11dee87995 100644
--- a/doc/manpages/Makefile.am
+++ b/doc/manpages/Makefile.am
@@ -51,6 +51,7 @@ APIMANS += gnutls_hash_get_len.3
APIMANS += gnutls_hash_fast.3
APIMANS += gnutls_key_generate.3
APIMANS += gnutls_alert_get_name.3
+APIMANS += gnutls_alert_get_strname.3
APIMANS += gnutls_alert_send.3
APIMANS += gnutls_error_to_alert.3
APIMANS += gnutls_alert_send_appropriate.3
@@ -130,6 +131,7 @@ APIMANS += gnutls_handshake_get_last_out.3
APIMANS += gnutls_malloc.3
APIMANS += gnutls_free.3
APIMANS += gnutls_pcert_import_x509.3
+APIMANS += gnutls_pcert_list_import_x509_raw.3
APIMANS += gnutls_pcert_import_x509_raw.3
APIMANS += gnutls_pcert_import_openpgp.3
APIMANS += gnutls_pcert_import_openpgp_raw.3
diff --git a/doc/reference/gnutls-docs.sgml b/doc/reference/gnutls-docs.sgml
index 03d3aa3c6c..517244f381 100644
--- a/doc/reference/gnutls-docs.sgml
+++ b/doc/reference/gnutls-docs.sgml
@@ -51,4 +51,7 @@
<index role="2.12.0" id="api-index-2-12-0">
<title>Index of new symbols in 2.12.0</title>
</index>
+ <index role="3.0.0" id="api-index-3-0-0">
+ <title>Index of new symbols in 3.0.0</title>
+ </index>
</book>
diff --git a/lib/algorithms/ecc.c b/lib/algorithms/ecc.c
index 4360aef00f..5b7ff27f84 100644
--- a/lib/algorithms/ecc.c
+++ b/lib/algorithms/ecc.c
@@ -207,6 +207,8 @@ _gnutls_ecc_bits_to_curve (int bits)
*
* Returns: a string that contains the name of the specified
* curve or %NULL.
+ *
+ * Since: 3.0.0
**/
const char *
gnutls_ecc_curve_get_name (gnutls_ecc_curve_t curve)
@@ -280,6 +282,8 @@ _gnutls_ecc_curve_get_params (gnutls_ecc_curve_t curve)
* Returns the size in bytes of the curve.
*
* Returns: a the size or (0).
+ *
+ * Since: 3.0.0
**/
int gnutls_ecc_curve_get_size (gnutls_ecc_curve_t curve)
{
diff --git a/lib/crypto-api.c b/lib/crypto-api.c
index 5f79ad0d11..985c52258f 100644
--- a/lib/crypto-api.c
+++ b/lib/crypto-api.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2000, 2004, 2005, 2008, 2010 Free Software Foundation,
+ * Copyright (C) 2000, 2004, 2005, 2008, 2010, 2011 Free Software Foundation,
* Inc.
*
* Author: Nikos Mavrogiannopoulos
@@ -72,7 +72,7 @@ gnutls_cipher_init (gnutls_cipher_hd_t * handle,
*
* Returns: Zero or a negative error code on error.
*
- * Since: 2.99.0
+ * Since: 3.0.0
**/
int
gnutls_cipher_tag (gnutls_cipher_hd_t handle, void *tag, size_t tag_size)
@@ -98,7 +98,7 @@ gnutls_cipher_tag (gnutls_cipher_hd_t handle, void *tag, size_t tag_size)
*
* Returns: Zero or a negative error code on error.
*
- * Since: 2.99.0
+ * Since: 3.0.0
**/
int
gnutls_cipher_add_auth (gnutls_cipher_hd_t handle, const void *text, size_t text_size)
@@ -120,7 +120,7 @@ gnutls_cipher_add_auth (gnutls_cipher_hd_t handle, const void *text, size_t text
* This function will set the IV to be used for the next
* encryption block.
*
- * Since: 2.99.0
+ * Since: 3.0.0
**/
void
gnutls_cipher_set_iv (gnutls_cipher_hd_t handle, void *iv, size_t ivlen)
diff --git a/lib/gnutls_alert.c b/lib/gnutls_alert.c
index b32c34e3b0..d477f78151 100644
--- a/lib/gnutls_alert.c
+++ b/lib/gnutls_alert.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2008, 2010 Free
+ * Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2008, 2010, 2011 Free
* Software Foundation, Inc.
*
* Author: Nikos Mavrogiannopoulos
@@ -104,6 +104,8 @@ gnutls_alert_get_name (gnutls_alert_description_t alert)
* This function will return a string of the name of the alert.
*
* Returns: string corresponding to #gnutls_alert_description_t value.
+ *
+ * Since: 3.0.0
**/
const char *
gnutls_alert_get_strname (gnutls_alert_description_t alert)
diff --git a/lib/gnutls_cert.c b/lib/gnutls_cert.c
index 403ac917bf..90be402637 100644
--- a/lib/gnutls_cert.c
+++ b/lib/gnutls_cert.c
@@ -453,6 +453,8 @@ void gnutls_certificate_set_retrieve_function
* and return 0 on success. If no certificate was selected then the
* number of certificates should be set to zero. The value (-1)
* indicates error and the handshake will be terminated.
+ *
+ * Since: 3.0.0
**/
void gnutls_certificate_set_retrieve_function2
(gnutls_certificate_credentials_t cred,
diff --git a/lib/gnutls_dtls.c b/lib/gnutls_dtls.c
index b46f83215a..51560f3d3c 100644
--- a/lib/gnutls_dtls.c
+++ b/lib/gnutls_dtls.c
@@ -418,6 +418,7 @@ int i, offset = 0;
* If the retransmission timeout is zero then the handshake will operate
* in a non-blocking way, i.e., return %GNUTLS_E_AGAIN.
*
+ * Since: 3.0.0
**/
void gnutls_dtls_set_timeouts (gnutls_session_t session, unsigned int retrans_timeout,
unsigned int total_timeout)
@@ -434,6 +435,7 @@ void gnutls_dtls_set_timeouts (gnutls_session_t session, unsigned int retrans_ti
* This function will set the maximum transfer unit of the interface
* that DTLS packets are expected to leave from.
*
+ * Since: 3.0.0
**/
void gnutls_dtls_set_mtu (gnutls_session_t session, unsigned int mtu)
{
@@ -450,6 +452,7 @@ void gnutls_dtls_set_mtu (gnutls_session_t session, unsigned int mtu)
*
* Returns: the maximum allowed transfer unit.
*
+ * Since: 3.0.0
**/
unsigned int gnutls_dtls_get_data_mtu (gnutls_session_t session)
{
@@ -473,6 +476,7 @@ int ret;
*
* Returns: the set maximum transfer unit.
*
+ * Since: 3.0.0
**/
unsigned int gnutls_dtls_get_mtu (gnutls_session_t session)
{
@@ -509,6 +513,7 @@ unsigned int gnutls_dtls_get_mtu (gnutls_session_t session)
*
* Returns: the number of bytes sent, or a negative error code.
*
+ * Since: 3.0.0
**/
int gnutls_dtls_cookie_send(gnutls_datum_t* key, void* client_data, size_t client_data_size,
gnutls_dtls_prestate_st* prestate,
@@ -610,6 +615,7 @@ uint8_t digest[C_HASH_SIZE];
*
* Returns: %GNUTLS_E_SUCCESS (0) on success, or a negative error code.
*
+ * Since: 3.0.0
**/
int gnutls_dtls_cookie_verify(gnutls_datum_t* key,
void* client_data, size_t client_data_size,
@@ -679,6 +685,7 @@ uint8_t digest[C_HASH_SIZE];
*
* Returns: %GNUTLS_E_SUCCESS (0) on success, or a negative error code.
*
+ * Since: 3.0.0
**/
void gnutls_dtls_prestate_set(gnutls_session_t session, gnutls_dtls_prestate_st* prestate)
{
diff --git a/lib/gnutls_global.c b/lib/gnutls_global.c
index 2c57717a40..73695ddda9 100644
--- a/lib/gnutls_global.c
+++ b/lib/gnutls_global.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2009, 2010
+ * Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2009, 2010, 2011
* Free Software Foundation, Inc.
*
* Author: Nikos Mavrogiannopoulos
@@ -80,6 +80,8 @@ gnutls_global_set_log_function (gnutls_log_func log_func)
*
* gnutls_audit_log_func is of the form,
* void (*gnutls_audit_log_func)( gnutls_session_t, int level, const char*);
+ *
+ * Since: 3.0.0
**/
void
gnutls_global_set_audit_log_function (gnutls_audit_log_func log_func)
diff --git a/lib/gnutls_pcert.c b/lib/gnutls_pcert.c
index 1927b90bcf..ee5145ea31 100644
--- a/lib/gnutls_pcert.c
+++ b/lib/gnutls_pcert.c
@@ -41,6 +41,8 @@
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
+ *
+ * Since: 3.0.0
**/
int gnutls_pcert_import_x509 (gnutls_pcert_st* pcert,
gnutls_x509_crt_t crt, unsigned int flags)
@@ -115,6 +117,8 @@ cleanup:
* CERTIFICATE", or "CERTIFICATE".
*
* Returns: the number of certificates read or a negative error value.
+ *
+ * Since: 3.0.0
**/
int
gnutls_pcert_list_import_x509_raw (gnutls_pcert_st * pcerts,
@@ -176,6 +180,8 @@ cleanup:
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
+ *
+ * Since: 3.0.0
**/
int gnutls_pcert_import_x509_raw (gnutls_pcert_st *pcert,
const gnutls_datum_t* cert,
@@ -224,6 +230,8 @@ cleanup:
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
+ *
+ * Since: 3.0.0
**/
int gnutls_pcert_import_openpgp (gnutls_pcert_st* pcert,
gnutls_openpgp_crt_t crt, unsigned int flags)
@@ -296,6 +304,8 @@ cleanup:
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
+ *
+ * Since: 3.0.0
**/
int gnutls_pcert_import_openpgp_raw (gnutls_pcert_st *pcert,
const gnutls_datum_t* cert,
@@ -350,6 +360,8 @@ cleanup:
* @pcert: The structure to be deinitialized
*
* This function will deinitialize a pcert structure.
+ *
+ * Since: 3.0.0
**/
void
gnutls_pcert_deinit (gnutls_pcert_st *pcert)
diff --git a/lib/gnutls_pubkey.c b/lib/gnutls_pubkey.c
index 08b6895b95..864a45a955 100644
--- a/lib/gnutls_pubkey.c
+++ b/lib/gnutls_pubkey.c
@@ -396,6 +396,8 @@ gnutls_pubkey_import_openpgp (gnutls_pubkey_t key,
*
* Returns: In case of failure a negative error code will be
* returned, and 0 on success.
+ *
+ * Since: 3.0.0
**/
int
gnutls_pubkey_get_openpgp_key_id (gnutls_pubkey_t key, unsigned int flags,
@@ -683,6 +685,8 @@ gnutls_pubkey_get_pk_dsa_raw (gnutls_pubkey_t key,
* gnutls_malloc() and will be stored in the appropriate datum.
*
* Returns: %GNUTLS_E_SUCCESS on success, otherwise a negative error code.
+ *
+ * Since: 3.0.0
**/
int
gnutls_pubkey_get_pk_ecc_raw (gnutls_pubkey_t key, gnutls_ecc_curve_t *curve,
@@ -1147,7 +1151,7 @@ gnutls_pubkey_verify_data (gnutls_pubkey_t pubkey, unsigned int flags,
* %GNUTLS_E_PK_SIG_VERIFY_FAILED is returned, and a positive code
* on success.
*
- * Since: 2.12.0
+ * Since: 3.0.0
**/
int
gnutls_pubkey_verify_data2 (gnutls_pubkey_t pubkey,
diff --git a/lib/gnutls_record.c b/lib/gnutls_record.c
index cfafc7ba33..771d6e48e8 100644
--- a/lib/gnutls_record.c
+++ b/lib/gnutls_record.c
@@ -1266,6 +1266,8 @@ gnutls_record_recv (gnutls_session_t session, void *data, size_t data_size)
* Returns: the number of bytes received and zero on EOF. A negative
* error code is returned in case of an error. The number of bytes
* received might be less than @data_size.
+ *
+ * Since: 3.0.0
**/
ssize_t
gnutls_record_recv_seq (gnutls_session_t session, void *data, size_t data_size,
diff --git a/lib/gnutls_state.c b/lib/gnutls_state.c
index 5b285f9e3b..d973100ae0 100644
--- a/lib/gnutls_state.c
+++ b/lib/gnutls_state.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
+ * Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
* Free Software Foundation, Inc.
*
* Author: Nikos Mavrogiannopoulos
@@ -1396,6 +1396,8 @@ int total = 0, ret, iv_size;
*
* Returns: the currently used curve, a #gnutls_ecc_curve_t
* type.
+ *
+ * Since: 3.0.0
**/
gnutls_ecc_curve_t gnutls_ecc_curve_get(gnutls_session_t session)
{
diff --git a/lib/system_override.c b/lib/system_override.c
index ae5b495454..b6c18a4907 100644
--- a/lib/system_override.c
+++ b/lib/system_override.c
@@ -102,6 +102,7 @@ gnutls_transport_set_pull_function (gnutls_session_t session,
* gnutls_pull_timeout_func is of the form,
* ssize_t (*gnutls_pull_timeout_func)(gnutls_transport_ptr_t, void*data, size_t size, unsigned int ms);
*
+ * Since: 3.0.0
**/
void
gnutls_transport_set_pull_timeout_function (gnutls_session_t session,
diff --git a/lib/x509/crl.c b/lib/x509/crl.c
index 57decfc98e..00af8b4ded 100644
--- a/lib/x509/crl.c
+++ b/lib/x509/crl.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2010 Free Software
+ * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2010, 2011 Free Software
* Foundation, Inc.
*
* Author: Nikos Mavrogiannopoulos
@@ -1041,6 +1041,8 @@ gnutls_x509_crl_get_extension_data (gnutls_x509_crl_t crl, int indx,
* CRL".
*
* Returns: the number of certificates read or a negative error value.
+ *
+ * Since: 3.0.0
**/
int
gnutls_x509_crl_list_import2 (gnutls_x509_crl_t ** crls,
@@ -1097,6 +1099,8 @@ int ret;
* If the Certificate is PEM encoded it should have a header of "X509 CRL".
*
* Returns: the number of certificates read or a negative error value.
+ *
+ * Since: 3.0.0
**/
int
gnutls_x509_crl_list_import (gnutls_x509_crl_t * crls,
diff --git a/lib/x509/privkey.c b/lib/x509/privkey.c
index bcc2a2c250..3ad16a0ec4 100644
--- a/lib/x509/privkey.c
+++ b/lib/x509/privkey.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2003, 2004, 2005, 2007, 2008, 2009, 2010 Free Software
+ * Copyright (C) 2003, 2004, 2005, 2007, 2008, 2009, 2010, 2011 Free Software
* Foundation, Inc.
*
* Author: Nikos Mavrogiannopoulos
@@ -836,6 +836,8 @@ cleanup:
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
+ *
+ * Since: 3.0.0
**/
int
gnutls_x509_privkey_import_ecc_raw (gnutls_x509_privkey_t key,
@@ -999,6 +1001,8 @@ gnutls_x509_privkey_sec_param (gnutls_x509_privkey_t key)
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
+ *
+ * Since: 3.0.0
**/
int gnutls_x509_privkey_export_ecc_raw (gnutls_x509_privkey_t key,
gnutls_ecc_curve_t *curve,
diff --git a/lib/x509/verify-high.c b/lib/x509/verify-high.c
index ceb62a365d..932e0d6cdc 100644
--- a/lib/x509/verify-high.c
+++ b/lib/x509/verify-high.c
@@ -69,6 +69,8 @@ struct gnutls_x509_trust_list_st {
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
+ *
+ * Since: 3.0.0
**/
int
gnutls_x509_trust_list_init (gnutls_x509_trust_list_t * list, unsigned int size)
@@ -100,6 +102,8 @@ gnutls_x509_trust_list_init (gnutls_x509_trust_list_t * list, unsigned int size)
* @all: if non-(0) it will deinitialize all the certificates and CRLs contained in the structure.
*
* This function will deinitialize a trust list.
+ *
+ * Since: 3.0.0
**/
void
gnutls_x509_trust_list_deinit (gnutls_x509_trust_list_t list, unsigned int all)
@@ -143,6 +147,7 @@ int i, j;
*
* Returns: The number of added elements is returned.
*
+ * Since: 3.0.0
**/
int
gnutls_x509_trust_list_add_cas (gnutls_x509_trust_list_t list,
@@ -203,6 +208,7 @@ uint32_t hash;
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
*
+ * Since: 3.0.0
**/
int
gnutls_x509_trust_list_add_named_crt (gnutls_x509_trust_list_t list,
@@ -257,8 +263,8 @@ uint32_t hash;
*
* Returns: The number of added elements is returned.
*
+ * Since: 3.0.0
**/
-
int
gnutls_x509_trust_list_add_crls (gnutls_x509_trust_list_t list,
const gnutls_x509_crl_t * crl_list, int crl_size, unsigned int flags,
@@ -394,6 +400,8 @@ gnutls_datum_t dn;
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
+ *
+ * Since: 3.0.0
**/
int gnutls_x509_trust_list_get_issuer(gnutls_x509_trust_list_t list,
gnutls_x509_crt_t cert, gnutls_x509_crt_t* issuer, unsigned int flags)
@@ -441,6 +449,8 @@ uint32_t hash;
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
+ *
+ * Since: 3.0.0
**/
int
gnutls_x509_trust_list_verify_crt (
@@ -537,6 +547,8 @@ uint32_t hash;
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
+ *
+ * Since: 3.0.0
**/
int
gnutls_x509_trust_list_verify_named_crt (
diff --git a/lib/x509/x509.c b/lib/x509/x509.c
index 758490100b..3e1ef997ee 100644
--- a/lib/x509/x509.c
+++ b/lib/x509/x509.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free
+ * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free
* Software Foundation, Inc.
* Author: Nikos Mavrogiannopoulos, Simon Josefsson, Howard Chu
*
@@ -3032,6 +3032,8 @@ cleanup:
* CERTIFICATE", or "CERTIFICATE".
*
* Returns: the number of certificates read or a negative error value.
+ *
+ * Since: 3.0.0
**/
int
gnutls_x509_crt_list_import2 (gnutls_x509_crt_t ** certs,