Add return info to sha256 docs

Signed-off-by: Aaron Erhardt <aaron.erhardt@t-online.de>
2021-10-22 22:05:10 +02:00 · 2021-10-22 22:05:10 +02:00 · 9bb56dc6be
commit 9bb56dc6be
parent a5a2399cb0
1 changed files with 3 additions and 0 deletions
--- a/include/mbedtls/sha256.h
+++ b/include/mbedtls/sha256.h
@ -167,6 +167,9 @@ int mbedtls_internal_sha256_process( mbedtls_sha256_context *ctx,
 *                 for SHA-256, \c 28 bytes for SHA-224.
 * \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( const unsigned char *input,
                    size_t ilen,