From a24fd06451a9c18afa037e09dd93605f78b4a871 Mon Sep 17 00:00:00 2001 From: Gabor Mezei Date: Mon, 23 Jan 2023 19:10:26 +0100 Subject: [PATCH] Update documentation Signed-off-by: Gabor Mezei --- library/bignum_mod_raw_invasive.h | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/library/bignum_mod_raw_invasive.h b/library/bignum_mod_raw_invasive.h index 3550eaff1..ead83942c 100644 --- a/library/bignum_mod_raw_invasive.h +++ b/library/bignum_mod_raw_invasive.h @@ -30,17 +30,12 @@ #if defined(MBEDTLS_TEST_HOOKS) -/** Convert an MPI to its canonical representative. - * - * \note Currently handles the case when `N->int_rep` is - * MBEDTLS_MPI_MOD_REP_MONTGOMERY. +/** Convert the result of a quasi-reduction to its canonical representative. * * \param[in,out] X The address of the MPI to be converted. Must have the - * same number of limbs as \p N. + * same number of limbs as \p N. The input value must + * be in range 0 <= X < 2N. * \param[in] N The address of the modulus. - * - * \return \c 0 if successful. - * \return #MBEDTLS_ERR_MPI_BAD_INPUT_DATA if \p N is invalid. */ MBEDTLS_STATIC_TESTABLE void mbedtls_mpi_mod_raw_fix_quasi_reduction(mbedtls_mpi_uint *X,