Fix Doxygen for mbedtls_mpi_core_mla()

Signed-off-by: Hanno Becker <hanno.becker@arm.com>
This commit is contained in:
Hanno Becker 2022-04-11 13:44:15 +01:00
parent 99ba4cc6d5
commit dfcb2d084b

View file

@ -26,19 +26,20 @@
#include "mbedtls/bignum.h" #include "mbedtls/bignum.h"
#endif #endif
/** Helper for mbedtls_mpi multiplication. /** Perform a known-size multiply accumulate operation
* *
* Add \p b * \p s to \p d. * Add \p b * \p s to \p d.
* *
* \param[in,out] d The bignum to add to. * \param[in,out] d The pointer to the (little-endian) array
* representing the bignum to accumulate onto.
* \param d_len The number of limbs of \p d. This must be * \param d_len The number of limbs of \p d. This must be
* at least \p s_len. * at least \p s_len.
* \param[in] s The pointer to the (little-endian) array
* representing the bignum to multiply with.
* This may be the same as \p d. Otherwise,
* it must be disjoint from \p d.
* \param s_len The number of limbs of \p s. * \param s_len The number of limbs of \p s.
* \param[in] s A bignum to multiply, of size \p i. * \param b A scalar to multiply with.
* It may overlap with \p d, but only if
* \p d <= \p s.
* Its leading limb must not be \c 0.
* \param b A scalar to multiply.
* *
* \return c The carry at the end of the operation. * \return c The carry at the end of the operation.
*/ */