ARMmbed/mbedtls
1
0
Fork 0
mirror of https://github.com/ARMmbed/mbedtls.git synced 2025-05-10 00:49:04 +08:00
Code Issues Releases Wiki Activity

Update a function's doxygen

Browse Source 
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 <manuel.pegourie-gonnard@arm.com>
This commit is contained in:
Manuel Pégourié-Gonnard 2025-01-24 09:38:29 +01:00
parent 28905b76fa
commit 53fe26c5ad
1 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
library/ssl_misc.h
View File

@ -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. In particular, this function always reads exactly \p
* max_data_len bytes from \p data. * max_data_len bytes from \p data.
* *
* \param ctx The HMAC context. It must have keys configured * \param key The HMAC key.
* with mbedtls_md_hmac_starts() and use one of the * \param mac_alg The hash algorithm.
* following hashes: SHA-384, SHA-256, SHA-1 or MD-5. * Must be one of 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 add_data The first part of the message whose HMAC is being * \param add_data The first part of the message whose HMAC is being
* calculated. This must point to a readable buffer * calculated. This must point to a readable buffer
* of \p add_data_len bytes. * of \p add_data_len bytes.