summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@gnutls.org>2010-12-19 05:41:30 +0100
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2010-12-19 05:41:30 +0100
commit559ee10884f68f4a10488c803d6ec127c1070535 (patch)
tree02b99f2dbc3d1e7eda4ed7c97a55af922cbbdcfe
parent6cdde2dedcd67cf2a8de5972ffd5f21401d9de64 (diff)
downloadgnutls-559ee10884f68f4a10488c803d6ec127c1070535.tar.gz
Do not include deprecated functions to library documentation.
-rw-r--r--doc/cha-auth.texi6
-rw-r--r--lib/gnutls_cert.c12
-rw-r--r--lib/gnutls_extensions.c6
-rw-r--r--lib/gnutls_psk_netconf.c5
-rw-r--r--lib/gnutls_state.c23
-rw-r--r--lib/includes/gnutls/compat.h6
-rw-r--r--lib/x509/privkey.c4
7 files changed, 40 insertions, 22 deletions
diff --git a/doc/cha-auth.texi b/doc/cha-auth.texi
index 42fe4ec2c6..6149b49e80 100644
--- a/doc/cha-auth.texi
+++ b/doc/cha-auth.texi
@@ -342,10 +342,10 @@ the hint, for example in the callback function, using
@ref{gnutls_psk_client_get_hint}.
There is no standard mechanism to derive a PSK key from a password
-specified by the TLS PSK document. GnuTLS provides
-@ref{gnutls_psk_netconf_derive_key} which follows the algorithm
+specified by the TLS PSK document@footnote{GnuTLS used to provide
+@code{gnutls_psk_netconf_derive_key} which follows the algorithm
specified in @file{draft-ietf-netconf-tls-02.txt}. This method
-is deprecated and might be removed in later versions of GnuTLS.
+is deprecated and might be removed in later versions of GnuTLS.}.
Some helper functions such as:
diff --git a/lib/gnutls_cert.c b/lib/gnutls_cert.c
index 8b27b631f8..ab6831f216 100644
--- a/lib/gnutls_cert.c
+++ b/lib/gnutls_cert.c
@@ -984,7 +984,7 @@ _gnutls_gcert_deinit (gnutls_cert * cert)
_gnutls_free_datum (&cert->raw);
}
-/**
+/*-
* gnutls_sign_callback_set:
* @session: is a gnutls session
* @sign_func: function pointer to application's sign callback.
@@ -1002,7 +1002,9 @@ _gnutls_gcert_deinit (gnutls_cert * cert)
* The @userdata parameter is passed to the @sign_func verbatim, and
* can be used to store application-specific data needed in the
* callback function. See also gnutls_sign_callback_get().
- **/
+ *
+ * Deprecated in: 2.11.0
+ -*/
void
gnutls_sign_callback_set (gnutls_session_t session,
gnutls_sign_func sign_func, void *userdata)
@@ -1011,7 +1013,7 @@ gnutls_sign_callback_set (gnutls_session_t session,
session->internals.sign_func_userdata = userdata;
}
-/**
+/*-
* gnutls_sign_callback_get:
* @session: is a gnutls session
* @userdata: if non-%NULL, will be set to abstract callback pointer.
@@ -1020,7 +1022,9 @@ gnutls_sign_callback_set (gnutls_session_t session,
*
* Returns: The function pointer set by gnutls_sign_callback_set(), or
* if not set, %NULL.
- **/
+ *
+ * Deprecated in: 2.11.0
+ -*/
gnutls_sign_func
gnutls_sign_callback_get (gnutls_session_t session, void **userdata)
{
diff --git a/lib/gnutls_extensions.c b/lib/gnutls_extensions.c
index a3b3c0f749..05ca7e2e2e 100644
--- a/lib/gnutls_extensions.c
+++ b/lib/gnutls_extensions.c
@@ -396,7 +396,7 @@ _gnutls_ext_register (extension_entry_st * mod)
return GNUTLS_E_SUCCESS;
}
-/**
+/*-
* gnutls_ext_register:
* @type: the 16-bit integer referring to the extension type
* @name: human printable name of the extension used for debugging
@@ -408,8 +408,8 @@ _gnutls_ext_register (extension_entry_st * mod)
*
* Returns: %GNUTLS_E_SUCCESS on success, or an error code.
*
- * Since: 2.6.0
- **/
+ * Deprecated in: 2.11.0
+ -*/
int
gnutls_ext_register (int type,
const char *name,
diff --git a/lib/gnutls_psk_netconf.c b/lib/gnutls_psk_netconf.c
index 3c24ba0497..1df072bcf9 100644
--- a/lib/gnutls_psk_netconf.c
+++ b/lib/gnutls_psk_netconf.c
@@ -31,7 +31,7 @@
#ifdef ENABLE_PSK
-/**
+/*-
* gnutls_psk_netconf_derive_key:
* @password: zero terminated string containing password.
* @psk_identity: zero terminated string with PSK identity.
@@ -44,7 +44,8 @@
* Returns: %GNUTLS_E_SUCCESS on success, or an error code.
*
* Since: 2.4.0
- **/
+ * Deprecated in: 2.11.0
+ -*/
int
gnutls_psk_netconf_derive_key (const char *password,
const char *psk_identity,
diff --git a/lib/gnutls_state.c b/lib/gnutls_state.c
index 2d9d79c544..5f0a1ce439 100644
--- a/lib/gnutls_state.c
+++ b/lib/gnutls_state.c
@@ -1062,7 +1062,7 @@ gnutls_prf (gnutls_session_t session,
return ret;
}
-/**
+/*-
* gnutls_session_get_client_random:
* @session: is a #gnutls_session_t structure.
*
@@ -1074,14 +1074,16 @@ gnutls_prf (gnutls_session_t session,
* expected.
*
* Returns: pointer to client random data.
- **/
+ *
+ * Deprecated in: 2.11.0
+ -*/
const void *
gnutls_session_get_client_random (gnutls_session_t session)
{
return (char *) session->security_parameters.client_random;
}
-/**
+/*-
* gnutls_session_get_server_random:
* @session: is a #gnutls_session_t structure.
*
@@ -1093,14 +1095,16 @@ gnutls_session_get_client_random (gnutls_session_t session)
* expected.
*
* Returns: pointer to server random data.
- **/
+ *
+ * Deprecated in: 2.11.0
+ -*/
const void *
gnutls_session_get_server_random (gnutls_session_t session)
{
return (char *) session->security_parameters.server_random;
}
-/**
+/*-
* gnutls_session_get_master_secret:
* @session: is a #gnutls_session_t structure.
*
@@ -1115,14 +1119,16 @@ gnutls_session_get_server_random (gnutls_session_t session)
* secret and use it to derive further data.
*
* Returns: pointer to master secret data.
- **/
+ *
+ * Deprecated in: 2.11.0
+ -*/
const void *
gnutls_session_get_master_secret (gnutls_session_t session)
{
return (char *) session->security_parameters.master_secret;
}
-/**
+/*-
* gnutls_session_set_finished_function:
* @session: is a #gnutls_session_t structure.
* @func: a #gnutls_finished_callback_func callback.
@@ -1146,7 +1152,8 @@ gnutls_session_get_master_secret (gnutls_session_t session)
* finished message for later use.
*
* Since: 2.6.0
- **/
+ * Deprecated in: 2.11.0
+ -*/
void
gnutls_session_set_finished_function (gnutls_session_t session,
gnutls_finished_callback_func func)
diff --git a/lib/includes/gnutls/compat.h b/lib/includes/gnutls/compat.h
index 0053c5f535..2f05bbecbe 100644
--- a/lib/includes/gnutls/compat.h
+++ b/lib/includes/gnutls/compat.h
@@ -172,10 +172,12 @@ gnutls_sign_callback_set (gnutls_session_t session,
gnutls_sign_func sign_func, void *userdata)
_GNUTLS_GCC_ATTR_DEPRECATED;
gnutls_sign_func
-gnutls_sign_callback_get (gnutls_session_t session, void **userdata);
+gnutls_sign_callback_get (gnutls_session_t session, void **userdata)
+ _GNUTLS_GCC_ATTR_DEPRECATED;
/* Extension API is no longer exported because a lot of internal
- * structures are used.
+ * structures are used. Currently it works due to a compatibility
+ * layer, but will be removed in later versions.
*/
int gnutls_ext_register (int type,
const char *name,
diff --git a/lib/x509/privkey.c b/lib/x509/privkey.c
index 1ab6b28c31..9ddb2e808d 100644
--- a/lib/x509/privkey.c
+++ b/lib/x509/privkey.c
@@ -1725,6 +1725,8 @@ cleanup:
*
* Returns: On success, %GNUTLS_E_SUCCESS is returned, otherwise a
* negative error value.
+ *
+ * Deprecated in: 2.11.0
-*/
int
gnutls_x509_privkey_sign_hash (gnutls_x509_privkey_t key,
@@ -1891,6 +1893,8 @@ gnutls_x509_privkey_sign_data (gnutls_x509_privkey_t key,
*
* Returns: In case of a verification failure %GNUTLS_E_PK_SIG_VERIFY_FAILED
* is returned, and a positive code on success.
+ *
+ * Deprecated in: 2.11.0
-*/
int
gnutls_x509_privkey_verify_data (gnutls_x509_privkey_t key,