yuzu-emu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2024-11-23 04:55:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

Minor SHA-256 documentation improvement

Browse Source
This commit is contained in:
Hanno Becker 2018-12-18 16:31:48 +00:00
parent 596e014a06
commit fc2a0b2e67
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
include/mbedtls/sha256.h
View File

@ -115,7 +115,7 @@ int mbedtls_sha256_starts_ret( mbedtls_sha256_context *ctx, int is224 );
* and have a hash operation started. * and have a hash operation started.
* \param input The buffer holding the data. This must be a readable * \param input The buffer holding the data. This must be a readable
* buffer of length \p ilen Bytes. * buffer of length \p ilen Bytes.
* \param ilen The length of the input data \p input in Bytes. * \param ilen The length of the input data in Bytes.
* *
* \return \c 0 on success. * \return \c 0 on success.
* \return A negative error code on failure. * \return A negative error code on failure.
@ -184,7 +184,7 @@ MBEDTLS_DEPRECATED void mbedtls_sha256_starts( mbedtls_sha256_context *ctx,
* initialized and have a hash operation started. * initialized and have a hash operation started.
* \param input The buffer holding the data. This must be a readable * \param input The buffer holding the data. This must be a readable
* buffer of length \p ilen Bytes. * buffer of length \p ilen Bytes.
* \param ilen The length of the input data \p input in Bytes. * \param ilen The length of the input data in Bytes.
*/ */
MBEDTLS_DEPRECATED void mbedtls_sha256_update( mbedtls_sha256_context *ctx, MBEDTLS_DEPRECATED void mbedtls_sha256_update( mbedtls_sha256_context *ctx,
const unsigned char *input, const unsigned char *input,
@ -197,7 +197,7 @@ MBEDTLS_DEPRECATED void mbedtls_sha256_update( mbedtls_sha256_context *ctx,
* \deprecated Superseded by mbedtls_sha256_finish_ret() in 2.7.0. * \deprecated Superseded by mbedtls_sha256_finish_ret() in 2.7.0.
* *
* \param ctx The SHA-256 context. This must be initialized and * \param ctx The SHA-256 context. This must be initialized and
* have a has hoperation started. * have a hash operation started.
* \param output The SHA-224 or SHA-256 checksum result. This must be * \param output The SHA-224 or SHA-256 checksum result. This must be
* a writable buffer of length \c 32 Bytes. * a writable buffer of length \c 32 Bytes.
*/ */
@ -234,7 +234,7 @@ MBEDTLS_DEPRECATED void mbedtls_sha256_process( mbedtls_sha256_context *ctx,
* *
* \param input The buffer holding the data. This must be a readable * \param input The buffer holding the data. This must be a readable
* buffer of length \p ilen Bytes. * buffer of length \p ilen Bytes.
* \param ilen The length of the input data \p input in Bytes. * \param ilen The length of the input data in Bytes.
* \param output The SHA-224 or SHA-256 checksum result. This must * \param output The SHA-224 or SHA-256 checksum result. This must
* be a writable buffer of length \c 32 Bytes. * be a writable buffer of length \c 32 Bytes.
* \param is224 Determines which function to use. This must be * \param is224 Determines which function to use. This must be
@ -266,10 +266,10 @@ int mbedtls_sha256_ret( const unsigned char *input,
* *
* \param input The buffer holding the data. This must be a readable * \param input The buffer holding the data. This must be a readable
* buffer of length \p ilen Bytes. * buffer of length \p ilen Bytes.
* \param ilen The length of the input data \p input in Bytes. * \param ilen The length of the input data in Bytes.
* \param output The SHA-224 or SHA-256 checksum result. This must be * \param output The SHA-224 or SHA-256 checksum result. This must be
* a writable buffer of length \c 32 Bytes. * a writable buffer of length \c 32 Bytes.
* \param is224 Determines which function to use. This must be eithern * \param is224 Determines which function to use. This must be either
* \c 0 for SHA-256, or \c 1 for SHA-224. * \c 0 for SHA-256, or \c 1 for SHA-224.
*/ */
MBEDTLS_DEPRECATED void mbedtls_sha256( const unsigned char *input, MBEDTLS_DEPRECATED void mbedtls_sha256( const unsigned char *input,