Improve documentation of MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL

Signed-off-by: Hanno Becker <hanno.becker@arm.com>
This commit is contained in:
Hanno Becker 2020-05-20 13:54:41 +01:00
parent e41606001b
commit 3c358d4e12

View file

@ -1709,13 +1709,16 @@
/** /**
* \def MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL * \def MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
* *
* This is an experimental macro used to selectively enable parts * This macro is used to selectively enable experimental parts
* of the code that solely contribute to the ongoing development of * of the code that contribute to the ongoing development of
* a prototype implementation for TLS 1.3 and DTLS 1.3 but aren't * the prototype TLS 1.3 and DTLS 1.3 implementation, and provide
* used otherwise. * no other purpose.
* *
* \warning Features under the control of this macro are experimental * \warning TLS 1.3 and DTLS 1.3 aren't yet supported in Mbed TLS,
* and don't come with any stability guarantees. * and no feature exposed through this macro is part of the
* public API. In particular, features under the control
* of this macro are experimental and don't come with any
* stability guarantees.
* *
* Uncomment this macro to enable experimental and partial * Uncomment this macro to enable experimental and partial
* functionality specific to TLS 1.3. * functionality specific to TLS 1.3.