From 3a3b5c782741e0b661e842340fbeafdf5dee4b08 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20P=C3=A9gouri=C3=A9-Gonnard?= Date: Fri, 24 Jan 2020 10:57:25 +0100 Subject: [PATCH] Improve doxygen formatting --- include/mbedtls/sha512.h | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/include/mbedtls/sha512.h b/include/mbedtls/sha512.h index b6bee9a82..8e54ce01a 100644 --- a/include/mbedtls/sha512.h +++ b/include/mbedtls/sha512.h @@ -105,9 +105,9 @@ void mbedtls_sha512_clone( mbedtls_sha512_context *dst, * \param is384 Determines which function to use. This must be * either \c 0 for SHA-512, or \c 1 for SHA-384. * - * \note When MBEDTLS_SHA512_NO_SHA384 is defined, \p is384 must be - * 0, or the function will return - * MBEDTLS_ERR_SHA512_BAD_INPUT_DATA. + * \note When \c MBEDTLS_SHA512_NO_SHA384 is defined, \p is384 must + * be \c 0, or the function will return + * #MBEDTLS_ERR_SHA512_BAD_INPUT_DATA. * * \return \c 0 on success. * \return A negative error code on failure. @@ -176,8 +176,8 @@ int mbedtls_internal_sha512_process( mbedtls_sha512_context *ctx, * \param is384 Determines which function to use. This must be either * \c 0 for SHA-512 or \c 1 for SHA-384. * - * \note When MBEDTLS_SHA512_NO_SHA384 is defined, \p is384 must be - * 0, or the function will fail to work. + * \note When \c MBEDTLS_SHA512_NO_SHA384 is defined, \p is384 must + * be \c 0, or the function will fail to work. */ MBEDTLS_DEPRECATED void mbedtls_sha512_starts( mbedtls_sha512_context *ctx, int is384 ); @@ -248,9 +248,9 @@ MBEDTLS_DEPRECATED void mbedtls_sha512_process( * \param is384 Determines which function to use. This must be either * \c 0 for SHA-512, or \c 1 for SHA-384. * - * \note When MBEDTLS_SHA512_NO_SHA384 is defined, \p is384 must be - * 0, or the function will return - * MBEDTLS_ERR_SHA512_BAD_INPUT_DATA. + * \note When \c MBEDTLS_SHA512_NO_SHA384 is defined, \p is384 must + * be \c 0, or the function will return + * #MBEDTLS_ERR_SHA512_BAD_INPUT_DATA. * * \return \c 0 on success. * \return A negative error code on failure. @@ -287,8 +287,8 @@ int mbedtls_sha512_ret( const unsigned char *input, * \param is384 Determines which function to use. This must be either * \c 0 for SHA-512, or \c 1 for SHA-384. * - * \note When MBEDTLS_SHA512_NO_SHA384 is defined, \p is384 must be - * 0, or the function will fail to work. + * \note When \c MBEDTLS_SHA512_NO_SHA384 is defined, \p is384 must + * be \c 0, or the function will fail to work. */ MBEDTLS_DEPRECATED void mbedtls_sha512( const unsigned char *input, size_t ilen,