Improve documentation of record expansion API
Signed-off-by: Hanno Becker <hanno.becker@arm.com>
diff --git a/include/mbedtls/ssl.h b/include/mbedtls/ssl.h
index 83df117..02cb6da 100644
--- a/include/mbedtls/ssl.h
+++ b/include/mbedtls/ssl.h
@@ -3647,10 +3647,13 @@
/**
* \brief Return the current maximum outgoing record payload in bytes.
- * This takes into account various factors, such as the config.h
- * setting \c MBEDTLS_SSL_OUT_CONTENT_LEN, extensions such as the
- * max fragment length or record size limit extension if used, and
- * for DTLS the path MTU as configured and current record expansion.
+ *
+ * \note The logic to determine the maximum outgoing record payload is
+ * version-specific. It takes into account various factors, such as
+ * the config.h setting \c MBEDTLS_SSL_OUT_CONTENT_LEN, extensions
+ * such as the max fragment length or record size limit extension if
+ * used, and for DTLS the path MTU as configured and current
+ * record expansion.
*
* \note With DTLS, \c mbedtls_ssl_write() will return an error if
* called with a larger length value.
@@ -3671,8 +3674,10 @@
/**
* \brief Return the current maximum incoming record payload in bytes.
- * This takes into account various factors, such as the
- * config.h setting \c MBEDTLS_SSL_IN_CONTENT_LEN, extensions
+ *
+ * \note The logic to determine the maximum outgoing record payload is
+ * version-specific. It takes into account various factors, such as
+ * the config.h setting \c MBEDTLS_SSL_IN_CONTENT_LEN, extensions
* such as the max fragment length extension or record size limit
* extension if used, and the current record expansion.
*