commit e269750f0d5bf2fe765dff50764cb4c440c68a0b
author Valerio Setti <vsetti@baylibre.com> Fri Dec 23 14:29:54 2022 +0100
committer Valerio Setti <vsetti@baylibre.com> Fri Dec 23 14:29:54 2022 +0100
tree 45ed5944e1e294c77f415f560a5fd9bdd164d76a
parent 77b1452784b7ad5fac04ed3b78c7400e623e7603

sha: fix description for starts functions

Signed-off-by: Valerio Setti <vsetti@baylibre.com>

include/mbedtls/sha256.h

diff --git a/include/mbedtls/sha256.h b/include/mbedtls/sha256.h
index 3d3e3fc..d256352 100644
--- a/include/mbedtls/sha256.h
+++ b/include/mbedtls/sha256.h
@@ -96,6 +96,10 @@
  * \param is224    This determines which function to use. This must be
  *                 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         A negative error code on failure.
  */