From 8620f73cdc5e8febf6a9cae5c460d37c699190c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20P=C3=A9gouri=C3=A9-Gonnard?= Date: Wed, 6 May 2015 14:42:06 +0100 Subject: [PATCH] Documentation tune-ups --- include/mbedtls/ssl.h | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/include/mbedtls/ssl.h b/include/mbedtls/ssl.h index 7d660bc67..803f6160c 100644 --- a/include/mbedtls/ssl.h +++ b/include/mbedtls/ssl.h @@ -1176,9 +1176,6 @@ int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl ); * * \param conf SSL configuration * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER - * - * \note This function should be called right after mbedtls_ssl_init() since - * some other ssl_set_foo() functions depend on it. */ void mbedtls_ssl_set_endpoint( mbedtls_ssl_config *conf, int endpoint ); @@ -1192,9 +1189,6 @@ void mbedtls_ssl_set_endpoint( mbedtls_ssl_config *conf, int endpoint ); * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS. * \return 0 on success or MBEDTLS_ERR_SSL_BAD_INPUT_DATA * - * \note If DTLS is selected and max and/or min version are less - * than TLS 1.1 (DTLS 1.0) they are upped to that value. - * * \note For DTLS, you must either provide a recv callback that * doesn't block, or one that handles timeouts, see * mbedtls_ssl_set_bio_timeout() @@ -2255,6 +2249,8 @@ void mbedtls_ssl_config_init( mbedtls_ssl_config *conf ); * * \param conf SSL configuration context * + * \note See \c mbedtls_ssl_set_transport() for notes on DTLS. + * * \return 0 if successful, or * MBEDTLS_ERR_XXX_ALLOC_FAILED on memorr allocation error. */