From 53fe26c5adc616beebb2f8c7eb478ace5f0b72d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20P=C3=A9gouri=C3=A9-Gonnard?= Date: Fri, 24 Jan 2025 09:38:29 +0100 Subject: [PATCH] Update a function's doxygen MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit There was two versions of this function with different arguments. Update the documentation to match the signature of the function we kept. Signed-off-by: Manuel Pégourié-Gonnard --- library/ssl_misc.h | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/library/ssl_misc.h b/library/ssl_misc.h index 3d2fc01577..2085e2d822 100644 --- a/library/ssl_misc.h +++ b/library/ssl_misc.h @@ -2867,12 +2867,9 @@ int mbedtls_ssl_tls13_finalize_client_hello(mbedtls_ssl_context *ssl); * max_data_len. In particular, this function always reads exactly \p * max_data_len bytes from \p data. * - * \param ctx The HMAC context. It must have keys configured - * with mbedtls_md_hmac_starts() and use one of the - * following hashes: SHA-384, SHA-256, SHA-1 or MD-5. - * It is reset using mbedtls_md_hmac_reset() after - * the computation is complete to prepare for the - * next computation. + * \param key The HMAC key. + * \param mac_alg The hash algorithm. + * Must be one of SHA-384, SHA-256, SHA-1 or MD-5. * \param add_data The first part of the message whose HMAC is being * calculated. This must point to a readable buffer * of \p add_data_len bytes.