lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-10-24 13:32:59 +03:00
Code Activity

Clarify parameter documentation

Browse Source 
Signed-off-by: Felix Conway <felix.conway@arm.com>
This commit is contained in:
Felix Conway
2025-07-28 16:31:44 +01:00
parent 9646537e94
commit 1527b69c7f
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
include/mbedtls/bignum.h
View File

@@ -993,8 +993,9 @@ int mbedtls_mpi_gcd(mbedtls_mpi *G, const mbedtls_mpi *A,
* to an initialized MPI. This value can be negative, in which
* case a positive answer will still be returned in \p X.
* \param N The base of the modular inversion. This must point to an
* initialized MPI. If this points to the same MPI as \p X,
* then the value returned in \p X will be incorrect.
* initialized MPI and be greater than one. If this points to
* the same MPI as \p X, then the value returned in \p X will
* be incorrect.
*
* \return \c 0 if successful.
* \return #MBEDTLS_ERR_MPI_ALLOC_FAILED if a memory allocation failed.