From bcd2f676245e14c28f8e6c4af9a0ddfc454815d2 Mon Sep 17 00:00:00 2001 From: Tom Cosgrove Date: Mon, 22 Nov 2021 15:02:29 +0000 Subject: [PATCH] doc improvements in aes and sha256 includes - Add return value description to the docs of mbedtls_sha256 - Remove description of non-existing "mode" parameter from the docs of mbedtls_aes_crypt_ctr Backport of #5105 Signed-off-by: Tom Cosgrove --- include/mbedtls/aes.h | 4 ---- include/mbedtls/sha256.h | 3 +++ 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/include/mbedtls/aes.h b/include/mbedtls/aes.h index 94ee58a83..e280dbb1c 100644 --- a/include/mbedtls/aes.h +++ b/include/mbedtls/aes.h @@ -522,10 +522,6 @@ int mbedtls_aes_crypt_ofb( mbedtls_aes_context *ctx, * \brief This function performs an AES-CTR encryption or decryption * operation. * - * This function performs the operation defined in the \p mode - * parameter (encrypt/decrypt), on the input data buffer - * defined in the \p input parameter. - * * Due to the nature of CTR, you must use the same key schedule * for both encryption and decryption operations. Therefore, you * must use the context initialized with mbedtls_aes_setkey_enc() diff --git a/include/mbedtls/sha256.h b/include/mbedtls/sha256.h index cccd5c452..d01f2ebd7 100644 --- a/include/mbedtls/sha256.h +++ b/include/mbedtls/sha256.h @@ -269,6 +269,9 @@ int mbedtls_sha256_ret( const unsigned char *input, * 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. */ MBEDTLS_DEPRECATED void mbedtls_sha256( const unsigned char *input, size_t ilen,