sha: fix description for starts functions

Signed-off-by: Valerio Setti <vsetti@baylibre.com>
This commit is contained in:
Valerio Setti 2022-12-23 14:29:54 +01:00
parent 77b1452784
commit e269750f0d
2 changed files with 7 additions and 6 deletions

View file

@ -96,6 +96,10 @@ void mbedtls_sha256_clone( mbedtls_sha256_context *dst,
* \param is224 This determines which function to use. This must be * \param is224 This determines which function to use. This must be
* either \c 0 for SHA-256, or \c 1 for SHA-224. * either \c 0 for SHA-256, or \c 1 for SHA-224.
* *
* \note is224 must be defined accordingly to the enabled
* MBEDTLS_SHA224_C/MBEDTLS_SHA256_C symbols otherwise the
* function will return #MBEDTLS_ERR_SHA512_BAD_INPUT_DATA.
*
* \return \c 0 on success. * \return \c 0 on success.
* \return A negative error code on failure. * \return A negative error code on failure.
*/ */

View file

@ -99,12 +99,9 @@ void mbedtls_sha512_clone( mbedtls_sha512_context *dst,
* \param is384 Determines which function to use. This must be * \param is384 Determines which function to use. This must be
* either \c 0 for SHA-512, or \c 1 for SHA-384. * either \c 0 for SHA-512, or \c 1 for SHA-384.
* *
* \note is384 must be defined accordingly with the supported * \note is384 must be defined accordingly to the enabled
* symbols in the config file. If: * MBEDTLS_SHA384_C/MBEDTLS_SHA512_C symbols otherwise the
* - is384 is 0, but \c MBEDTLS_SHA384_C is not defined, or * function will return #MBEDTLS_ERR_SHA512_BAD_INPUT_DATA.
* - is384 is 1, but \c MBEDTLS_SHA512_C is not defined
* then the function will return
* #MBEDTLS_ERR_SHA512_BAD_INPUT_DATA.
* *
* \return \c 0 on success. * \return \c 0 on success.
* \return A negative error code on failure. * \return A negative error code on failure.