Fix documentation

Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
This commit is contained in:
Dave Rodgman 2023-04-24 12:53:29 +01:00
parent bbf881053d
commit 0f16d560aa
2 changed files with 4 additions and 11 deletions

View file

@ -33,16 +33,6 @@
#include "bn_mul.h"
#include "constant_time_internal.h"
/**
* \brief Count leading zeros
*
* \warning The result is undefined if \p a == 0
*
* \param a The value to operate on
*
* \return The number of leading zeros, if \p a != 0. If \p a == 0, the result
* is undefined.
*/
inline size_t mbedtls_mpi_core_clz(mbedtls_mpi_uint a)
{
#if defined(__has_builtin)

View file

@ -101,10 +101,13 @@
(((X)[(i) / ciL] >> (((i) % ciL) * 8)) & 0xff)
/** Count leading zero bits in a given integer.
*
* \warning The result is undefined if \p a == 0
*
* \param a Integer to count leading zero bits.
*
* \return The number of leading zero bits in \p a.
* \return The number of leading zero bits in \p a, if \p a != 0.
* If \p a == 0, the result is undefined.
*/
size_t mbedtls_mpi_core_clz(mbedtls_mpi_uint a);