yuzu-emu/mbedtls
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Improve documentation

Browse source 
Co-authored-by: Tom Cosgrove <81633263+tom-cosgrove-arm@users.noreply.github.com>
Co-authored-by: Werner Lewis <werner.wmlewis@gmail.com>
Co-authored-by: Minos Galanakis <minos.galanakis@arm.com>

Signed-off-by: Janos Follath <janos.follath@arm.com>
This commit is contained in:
Janos Follath 2022-08-19 12:09:17 +01:00
parent ca5688e10c
commit a95f204cd3
6 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
library/bignum_core.c
View file

@ -1,5 +1,5 @@
/* /*
* Multi-precision integer library * Core bignum functions
* *
* Copyright The Mbed TLS Contributors * Copyright The Mbed TLS Contributors
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0

2
library/bignum_core.h
View file

@ -39,7 +39,7 @@
*/ */
size_t mbedtls_mpi_core_clz( const mbedtls_mpi_uint a ); size_t mbedtls_mpi_core_clz( const mbedtls_mpi_uint a );
/** Return the the minimum number of bits required to represent the value held /** Return the minimum number of bits required to represent the value held
* in the MPI. * in the MPI.
* *
* \note This function returns 0 if all the limbs of \p A are 0. * \note This function returns 0 if all the limbs of \p A are 0.

2
library/bignum_mod.c
View file

@ -1,5 +1,5 @@
/** /**
* Internal bignum functions * Modular bignum functions
* *
* Copyright The Mbed TLS Contributors * Copyright The Mbed TLS Contributors
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0

4
library/bignum_mod.h
View file

@ -101,7 +101,7 @@ void mbedtls_mpi_mod_residue_release( mbedtls_mpi_mod_residue *r );
/** Initialize a modulus structure. /** Initialize a modulus structure.
* *
* \param[out] m The address of a modulus. * \param[out] m The address of the modulus structure to initialize.
*/ */
void mbedtls_mpi_mod_modulus_init( mbedtls_mpi_mod_modulus *m ); void mbedtls_mpi_mod_modulus_init( mbedtls_mpi_mod_modulus *m );
@ -136,7 +136,7 @@ int mbedtls_mpi_mod_modulus_setup( mbedtls_mpi_mod_modulus *m,
* mbedtls_mpi_mod_modulus_setup() only removes the reference to it, * mbedtls_mpi_mod_modulus_setup() only removes the reference to it,
* making it safe to free or to use it again. * making it safe to free or to use it again.
* *
* \param[in,out] m The address of a modulus. * \param[in,out] m The address of the modulus structure to free.
*/ */
void mbedtls_mpi_mod_modulus_free( mbedtls_mpi_mod_modulus *m ); void mbedtls_mpi_mod_modulus_free( mbedtls_mpi_mod_modulus *m );

2
library/bignum_mod_raw.c
View file

@ -1,5 +1,5 @@
/* /*
* Multi-precision integer library * Low-level modular bignum functions
* *
* Copyright The Mbed TLS Contributors * Copyright The Mbed TLS Contributors
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0

2
library/bignum_mod_raw.h
View file

@ -1,5 +1,5 @@
/** /**
* Low level modular bignum functions * Low-level modular bignum functions
* *
* This interface only should be used by the higher level modular bignum * This interface only should be used by the higher level modular bignum
* module (bignum_mod.c) and the ECP module (ecp.c, ecp_curves.c). All other * module (bignum_mod.c) and the ECP module (ecp.c, ecp_curves.c). All other