Improve documents

Signed-off-by: Jerry Yu <jerry.h.yu@arm.com>
This commit is contained in:
Jerry Yu 2023-11-09 10:38:17 +08:00
parent 2c46ca3474
commit 53c4a0da07

View File

@ -3781,11 +3781,12 @@ void MBEDTLS_DEPRECATED mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
* *
* \param conf The SSL configuration to use. * \param conf The SSL configuration to use.
* \param sig_algs List of allowed IANA values for TLS 1.3 signature algorithms, * \param sig_algs List of allowed IANA values for TLS 1.3 signature algorithms,
* terminated by \c MBEDTLS_TLS1_3_SIG_NONE. The list must remain * terminated by #MBEDTLS_TLS1_3_SIG_NONE. The list must remain
* available throughout the lifetime of the conf object. Supported * available throughout the lifetime of the conf object.
* values are available as \c MBEDTLS_TLS1_3_SIG_XXXX . Using * - For TLS 1.3, values of \c MBEDTLS_TLS1_3_SIG_XXXX should be
* this for TLS 1.2, items in this parameter should be * used.
* "(HashAlgorithm << 8) | SignatureAlgorithm". * - For TLS 1.2, values should be given as
* "(HashAlgorithm << 8) | SignatureAlgorithm".
*/ */
void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf, void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
const uint16_t *sig_algs); const uint16_t *sig_algs);