From 2ae7ae5301e21188b455b5b39475b8043ca30217 Mon Sep 17 00:00:00 2001 From: k-stachowiak Date: Thu, 13 Dec 2018 14:48:30 +0100 Subject: [PATCH] Doxygen comments improvement --- include/mbedtls/gcm.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/include/mbedtls/gcm.h b/include/mbedtls/gcm.h index f68643d10..6a49c39c4 100644 --- a/include/mbedtls/gcm.h +++ b/include/mbedtls/gcm.h @@ -143,7 +143,7 @@ int mbedtls_gcm_setkey( mbedtls_gcm_context *ctx, * \param iv_len The length of the IV. * \param add The buffer holding the additional data. If \p add_len is * greater than zero, this must be of at least that size in - * Bytes. + * Bytes. If `add_len == 0`, this may be \c NULL. * \param add_len The length of the additional data. * \param input The buffer holding the input data. If \p length is greater * than zero, this must be a readable buffer of at least that @@ -190,7 +190,7 @@ int mbedtls_gcm_crypt_and_tag( mbedtls_gcm_context *ctx, * \param iv_len The length of the IV. * \param add The buffer holding the additional data. If \p add_len is * greater than zero, this must be of at least that size in - * Bytes. + * Bytes. If `add_len == 0`, this may be \c NULL. * \param add_len The length of the additional data. * \param tag The buffer holding the tag to verify. This must be a * readable buffer of at least \p tag_len Bytes. @@ -229,10 +229,10 @@ int mbedtls_gcm_auth_decrypt( mbedtls_gcm_context *ctx, * \param iv The initialization vector. This must be a readable buffer of * at least \p iv_len Bytes. * \param iv_len The length of the IV. - * \param add The buffer holding the additional data, or NULL - * if \p add_len is 0. - * \param add_len The length of the additional data. If 0, - * \p add may be NULL. + * \param add The buffer holding the additional data, or \c NULL + * if \p add_len is \c 0. + * \param add_len The length of the additional data. If \c 0, + * \p add may be \c NULL. * * \return \c 0 on success. */