cuberite/polarssl
1
0
Fork 0
mirror of https://github.com/cuberite/polarssl.git synced 2025-11-04 04:32:24 -05:00
Code Issues Packages Projects Releases Wiki Activity

Minor improvements in bignum documentation

Browse Source
This commit is contained in:
Hanno Becker 2018-12-18 23:10:28 +00:00
parent d73101266d
commit d01ff493e5
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
include/mbedtls/bignum.h
View File

@ -688,9 +688,11 @@ int mbedtls_mpi_mul_int( mbedtls_mpi *X, const mbedtls_mpi *A,
* A = Q * B + R
*
* \param Q The destination MPI for the quotient.
* May be \c NULL is the value of the quotient is not needed.
* This may be \c NULL if the value of the
* quotient is not needed.
* \param R The destination MPI for the remainder value.
* May be \c NULL if the value of the remainder is not needed.
* This may be \c NULL if the value of the
* remainder is not needed.
* \param A The divident. This must point to an initialized MPi.
* \param B The divisor. This must point to an initialized MPI.
*
@ -707,9 +709,11 @@ int mbedtls_mpi_div_mpi( mbedtls_mpi *Q, mbedtls_mpi *R, const mbedtls_mpi *A,
* A = Q * b + R
*
* \param Q The destination MPI for the quotient.
* May be \c NULL is the value of the quotient is not needed.
* This may be \c NULL if the value of the
* quotient is not needed.
* \param R The destination MPI for the remainder value.
* May be \c NULL if the value of the remainder is not needed.
* This may be \c NULL if the value of the
* remainder is not needed.
* \param A The divident. This must point to an initialized MPi.
* \param b The divisor.
*
@ -922,7 +926,7 @@ typedef enum {
* \param X The destination MPI to store the generated prime in.
* This must point to an initialized MPi.
* \param nbits The required size of the destination MPI in bits.
* Must be between \c 3 and #MBEDTLS_MPI_MAX_BITS.
* This must be between \c 3 and #MBEDTLS_MPI_MAX_BITS.
* \param flags A mask of flags of type #mbedtls_mpi_gen_prime_flag_t.
* \param f_rng The RNG function to use. This must not be \c NULL.
* \param p_rng The RNG parameter to be passed to \p f_rng.