Doxygen comments improvement

This commit is contained in:
k-stachowiak 2018-12-13 14:48:30 +01:00
parent 5fccb3edf3
commit 2ae7ae5301

View file

@ -143,7 +143,7 @@ int mbedtls_gcm_setkey( mbedtls_gcm_context *ctx,
* \param iv_len The length of the IV. * \param iv_len The length of the IV.
* \param add The buffer holding the additional data. If \p add_len is * \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 * 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 add_len The length of the additional data.
* \param input The buffer holding the input data. If \p length is greater * \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 * 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 iv_len The length of the IV.
* \param add The buffer holding the additional data. If \p add_len is * \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 * 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 add_len The length of the additional data.
* \param tag The buffer holding the tag to verify. This must be a * \param tag The buffer holding the tag to verify. This must be a
* readable buffer of at least \p tag_len Bytes. * 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 * \param iv The initialization vector. This must be a readable buffer of
* at least \p iv_len Bytes. * at least \p iv_len Bytes.
* \param iv_len The length of the IV. * \param iv_len The length of the IV.
* \param add The buffer holding the additional data, or NULL * \param add The buffer holding the additional data, or \c NULL
* if \p add_len is 0. * if \p add_len is \c 0.
* \param add_len The length of the additional data. If 0, * \param add_len The length of the additional data. If \c 0,
* \p add may be NULL. * \p add may be \c NULL.
* *
* \return \c 0 on success. * \return \c 0 on success.
*/ */