commit a5f85c860be0396af44d6c0c0b72cddab8877cad
author Tom Cosgrove <tom.cosgrove@arm.com> Mon Nov 22 15:35:27 2021 +0000
committer Tom Cosgrove <tom.cosgrove@arm.com> Mon Nov 22 15:35:27 2021 +0000
tree b02183f87c1827f0beb6da80aa5bb47a8b6bb95f
parent f4307d55daa8bb2f16b01cc86790a676ce909b76

further improvements to sha256 docs

Signed-off-by: Tom Cosgrove <tom.cosgrove@arm.com>

include/mbedtls/sha256.h

diff --git a/include/mbedtls/sha256.h b/include/mbedtls/sha256.h
index c55177d..68386a5 100644
--- a/include/mbedtls/sha256.h
+++ b/include/mbedtls/sha256.h
@@ -264,6 +264,9 @@
  *                 be a writable buffer of length \c 32 Bytes.
  * \param is224    Determines which function to use. This must be
  *                 either \c 0 for SHA-256, or \c 1 for SHA-224.
+ *
+ * \return         \c 0 on success.
+ * \return         A negative error code on failure.
  */
 int mbedtls_sha256_ret( const unsigned char *input,
                         size_t ilen,