Fix outdated documentation of effect of hardcoded timer cb's on API
diff --git a/include/mbedtls/ssl.h b/include/mbedtls/ssl.h
index bef6341..ad60e82 100644
--- a/include/mbedtls/ssl.h
+++ b/include/mbedtls/ssl.h
@@ -1785,36 +1785,35 @@
#if !defined(MBEDTLS_SSL_CONF_SET_TIMER) && \
!defined(MBEDTLS_SSL_CONF_GET_TIMER)
/**
- * \brief Set the timer callbacks (Mandatory for DTLS.)
+ * \brief Set the timer callbacks (Mandatory for DTLS.)
*
- * \param ssl SSL context
- * \param p_timer parameter (context) shared by timer callbacks
+ * \param ssl SSL context
+ * \param p_timer parameter (context) shared by timer callbacks
* \param f_set_timer set timer callback
* \param f_get_timer get timer callback. Must return:
*
- * \note See the documentation of \c mbedtls_ssl_set_timer_t and
- * \c mbedtls_ssl_get_timer_t for the conventions this pair of
- * callbacks must follow.
+ * \note See the documentation of \c mbedtls_ssl_set_timer_t and
+ * \c mbedtls_ssl_get_timer_t for the conventions this pair of
+ * callbacks must follow.
*
- * \note On some platforms, timing.c provides
- * \c mbedtls_timing_set_delay() and
- * \c mbedtls_timing_get_delay() that are suitable for using
- * here, except if using an event-driven style.
+ * \note On some platforms, timing.c provides
+ * \c mbedtls_timing_set_delay() and
+ * \c mbedtls_timing_get_delay() that are suitable for using
+ * here, except if using an event-driven style.
*
- * \note On constrained systems, the timer callbacks \p f_set_timer
- * and \p f_get_timer may also be configured at compile-time
- * via MBEDTLS_SSL_CONF_GET_TIMER and MBEDTLS_SSL_CONF_SET_TIMER.
- * In this case, the corresponding arguments to this function
- * are ignored.
+ * \note On constrained systems, the timer callbacks \p f_set_timer
+ * and \p f_get_timer may also be configured at compile-time
+ * via MBEDTLS_SSL_CONF_GET_TIMER and MBEDTLS_SSL_CONF_SET_TIMER.
*
- * \note See also the "DTLS tutorial" article in our knowledge base.
- * https://tls.mbed.org/kb/how-to/dtls-tutorial
+ * \note See also the "DTLS tutorial" article in our knowledge base.
+ * https://tls.mbed.org/kb/how-to/dtls-tutorial
*/
void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
void *p_timer,
mbedtls_ssl_set_timer_t *f_set_timer,
mbedtls_ssl_get_timer_t *f_get_timer );
-#else
+#else /* !( MBEDTLS_SSL_CONF_SET_TIMER &&
+ MBEDTLS_SSL_CONF_GET_TIMER ) */
/**
* \brief Set the context to be passed to the timer callbacks
* (Mandatory for DTLS.)
@@ -1825,7 +1824,8 @@
*/
void mbedtls_ssl_set_timer_cb_ctx( mbedtls_ssl_context *ssl,
void *p_timer );
-#endif
+#endif /* MBEDTLS_SSL_CONF_SET_TIMER &&
+ MBEDTLS_SSL_CONF_GET_TIMER */
/**
* \brief Callback type: generate and write session ticket