Ensure we explicitly document the modulus for fixed-width arithmetic
Signed-off-by: Tom Cosgrove <tom.cosgrove@arm.com>
diff --git a/library/bignum_core.h b/library/bignum_core.h
index 2b3b8b6..cbeab24 100644
--- a/library/bignum_core.h
+++ b/library/bignum_core.h
@@ -167,6 +167,8 @@
* return carry;
* ```
*
+ * This function operates modulo `2^(biL*limbs)`.
+ *
* \param[in,out] X The pointer to the (little-endian) array
* representing the bignum to accumulate onto.
* \param[in] A The pointer to the (little-endian) array
@@ -217,6 +219,8 @@
* \p X may be aliased to \p A (when \p X_limbs == \p A_limbs), but may not
* otherwise overlap.
*
+ * This function operates modulo `2^(biL*X_limbs)`.
+ *
* \param[in,out] X The pointer to the (little-endian) array
* representing the bignum to accumulate onto.
* \param X_limbs The number of limbs of \p X. This must be