mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-03-10 04:13:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

crypto.h: fix documentation for some functions

Browse Source 
Some functions has input parameters which are erroneously
reported as "param[out]" in the documentation. This commit
fixes them.

Signed-off-by: Valerio Setti <valerio.setti@nordicsemi.no>
This commit is contained in:
Valerio Setti 2024-06-03 07:05:23 +02:00
parent cddcd7ac0b
commit 1cb31cc5bf
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/psa/crypto.h
View File

@ -871,7 +871,7 @@ psa_status_t psa_hash_compute(psa_algorithm_t alg,
* such that #PSA_ALG_IS_HASH(\p alg) is true). * such that #PSA_ALG_IS_HASH(\p alg) is true).
* \param[in] input Buffer containing the message to hash. * \param[in] input Buffer containing the message to hash.
* \param input_length Size of the \p input buffer in bytes. * \param input_length Size of the \p input buffer in bytes.
* \param[out] hash Buffer containing the expected hash value. * \param[in] hash Buffer containing the expected hash value.
* \param hash_length Size of the \p hash buffer in bytes. * \param hash_length Size of the \p hash buffer in bytes.
* *
* \retval #PSA_SUCCESS * \retval #PSA_SUCCESS
@ -1224,7 +1224,7 @@ psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
* such that #PSA_ALG_IS_MAC(\p alg) is true). * such that #PSA_ALG_IS_MAC(\p alg) is true).
* \param[in] input Buffer containing the input message. * \param[in] input Buffer containing the input message.
* \param input_length Size of the \p input buffer in bytes. * \param input_length Size of the \p input buffer in bytes.
* \param[out] mac Buffer containing the expected MAC value. * \param[in] mac Buffer containing the expected MAC value.
* \param mac_length Size of the \p mac buffer in bytes. * \param mac_length Size of the \p mac buffer in bytes.
* *
* \retval #PSA_SUCCESS * \retval #PSA_SUCCESS
@ -2910,7 +2910,7 @@ psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
* \p key. * \p key.
* \param[in] input The message whose signature is to be verified. * \param[in] input The message whose signature is to be verified.
* \param[in] input_length Size of the \p input buffer in bytes. * \param[in] input_length Size of the \p input buffer in bytes.
* \param[out] signature Buffer containing the signature to verify. * \param[in] signature Buffer containing the signature to verify.
* \param[in] signature_length Size of the \p signature buffer in bytes. * \param[in] signature_length Size of the \p signature buffer in bytes.
* *
* \retval #PSA_SUCCESS \emptydescription * \retval #PSA_SUCCESS \emptydescription