Skip to content

Commit 3a3b5c7

Browse files
committed
Improve doxygen formatting
1 parent 1e6fb01 commit 3a3b5c7

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

include/mbedtls/sha512.h

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ void mbedtls_sha512_clone( mbedtls_sha512_context *dst,
105105
* \param is384 Determines which function to use. This must be
106106
* either \c 0 for SHA-512, or \c 1 for SHA-384.
107107
*
108-
* \note When MBEDTLS_SHA512_NO_SHA384 is defined, \p is384 must be
109-
* 0, or the function will return
110-
* MBEDTLS_ERR_SHA512_BAD_INPUT_DATA.
108+
* \note When \c MBEDTLS_SHA512_NO_SHA384 is defined, \p is384 must
109+
* be \c 0, or the function will return
110+
* #MBEDTLS_ERR_SHA512_BAD_INPUT_DATA.
111111
*
112112
* \return \c 0 on success.
113113
* \return A negative error code on failure.
@@ -176,8 +176,8 @@ int mbedtls_internal_sha512_process( mbedtls_sha512_context *ctx,
176176
* \param is384 Determines which function to use. This must be either
177177
* \c 0 for SHA-512 or \c 1 for SHA-384.
178178
*
179-
* \note When MBEDTLS_SHA512_NO_SHA384 is defined, \p is384 must be
180-
* 0, or the function will fail to work.
179+
* \note When \c MBEDTLS_SHA512_NO_SHA384 is defined, \p is384 must
180+
* be \c 0, or the function will fail to work.
181181
*/
182182
MBEDTLS_DEPRECATED void mbedtls_sha512_starts( mbedtls_sha512_context *ctx,
183183
int is384 );
@@ -248,9 +248,9 @@ MBEDTLS_DEPRECATED void mbedtls_sha512_process(
248248
* \param is384 Determines which function to use. This must be either
249249
* \c 0 for SHA-512, or \c 1 for SHA-384.
250250
*
251-
* \note When MBEDTLS_SHA512_NO_SHA384 is defined, \p is384 must be
252-
* 0, or the function will return
253-
* MBEDTLS_ERR_SHA512_BAD_INPUT_DATA.
251+
* \note When \c MBEDTLS_SHA512_NO_SHA384 is defined, \p is384 must
252+
* be \c 0, or the function will return
253+
* #MBEDTLS_ERR_SHA512_BAD_INPUT_DATA.
254254
*
255255
* \return \c 0 on success.
256256
* \return A negative error code on failure.
@@ -287,8 +287,8 @@ int mbedtls_sha512_ret( const unsigned char *input,
287287
* \param is384 Determines which function to use. This must be either
288288
* \c 0 for SHA-512, or \c 1 for SHA-384.
289289
*
290-
* \note When MBEDTLS_SHA512_NO_SHA384 is defined, \p is384 must be
291-
* 0, or the function will fail to work.
290+
* \note When \c MBEDTLS_SHA512_NO_SHA384 is defined, \p is384 must
291+
* be \c 0, or the function will fail to work.
292292
*/
293293
MBEDTLS_DEPRECATED void mbedtls_sha512( const unsigned char *input,
294294
size_t ilen,

0 commit comments

Comments
 (0)