From a95f204cd33ae62a1f3f1d98e36efae85b50fa16 Mon Sep 17 00:00:00 2001 From: Janos Follath Date: Fri, 19 Aug 2022 12:09:17 +0100 Subject: [PATCH] Improve documentation Co-authored-by: Tom Cosgrove <81633263+tom-cosgrove-arm@users.noreply.github.com> Co-authored-by: Werner Lewis Co-authored-by: Minos Galanakis Signed-off-by: Janos Follath --- library/bignum_core.c | 2 +- library/bignum_core.h | 2 +- library/bignum_mod.c | 2 +- library/bignum_mod.h | 4 ++-- library/bignum_mod_raw.c | 2 +- library/bignum_mod_raw.h | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/library/bignum_core.c b/library/bignum_core.c index 41be49616..9d1e29c23 100644 --- a/library/bignum_core.c +++ b/library/bignum_core.c @@ -1,5 +1,5 @@ /* - * Multi-precision integer library + * Core bignum functions * * Copyright The Mbed TLS Contributors * SPDX-License-Identifier: Apache-2.0 diff --git a/library/bignum_core.h b/library/bignum_core.h index 221bb1afe..c75be260c 100644 --- a/library/bignum_core.h +++ b/library/bignum_core.h @@ -39,7 +39,7 @@ */ 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. * * \note This function returns 0 if all the limbs of \p A are 0. diff --git a/library/bignum_mod.c b/library/bignum_mod.c index c2c3aecf8..de2809372 100644 --- a/library/bignum_mod.c +++ b/library/bignum_mod.c @@ -1,5 +1,5 @@ /** - * Internal bignum functions + * Modular bignum functions * * Copyright The Mbed TLS Contributors * SPDX-License-Identifier: Apache-2.0 diff --git a/library/bignum_mod.h b/library/bignum_mod.h index efbacb436..9d28bc7e4 100644 --- a/library/bignum_mod.h +++ b/library/bignum_mod.h @@ -101,7 +101,7 @@ void mbedtls_mpi_mod_residue_release( mbedtls_mpi_mod_residue *r ); /** 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 ); @@ -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, * 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 ); diff --git a/library/bignum_mod_raw.c b/library/bignum_mod_raw.c index 0a3f3a031..88311dd7b 100644 --- a/library/bignum_mod_raw.c +++ b/library/bignum_mod_raw.c @@ -1,5 +1,5 @@ /* - * Multi-precision integer library + * Low-level modular bignum functions * * Copyright The Mbed TLS Contributors * SPDX-License-Identifier: Apache-2.0 diff --git a/library/bignum_mod_raw.h b/library/bignum_mod_raw.h index 5e1418bd6..4b2a51f88 100644 --- a/library/bignum_mod_raw.h +++ b/library/bignum_mod_raw.h @@ -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 * module (bignum_mod.c) and the ECP module (ecp.c, ecp_curves.c). All other