Address code review comments to improve docstrings

1 files changed, 12 insertions, 12 deletions

diff --git a/p224_32.c b/p224_32.c
index 438ad8c55..2cae5b631 100644
--- a/p224_32.c
+++ b/p224_32.c
@@ -17,7 +17,7 @@ typedef signed char fiat_p224_int1;
 
 
 /*
- * The function fiat_p224_addcarryx_u32 is an add with carry.
+ * The function fiat_p224_addcarryx_u32 is an addition with carry.
  * out1 = (arg1 + arg2 + arg3) mod 2^32
  * ∧ out2 = ⌊(arg1 + arg2 + arg3) / 2^32⌋
  * Input Bounds:
@@ -37,7 +37,7 @@ static void fiat_p224_addcarryx_u32(uint32_t* out1, fiat_p224_uint1* out2, fiat_
 }
 
 /*
- * The function fiat_p224_subborrowx_u32 is a sub with borrow.
+ * The function fiat_p224_subborrowx_u32 is a subtraction with borrow.
  * out1 = (-arg1 + arg2 + -arg3) mod 2^32
  * ∧ out2 = -⌊(-arg1 + arg2 + -arg3) / 2^32⌋
  * Input Bounds:
@@ -93,7 +93,7 @@ static void fiat_p224_cmovznz_u32(uint32_t* out1, fiat_p224_uint1 arg1, uint32_t
 }
 
 /*
- * The function fiat_p224_mul does stuff.
+ * The function fiat_p224_mul multiplies two field elements in the Montgomery domain.
  * arg1 = map (λ x, ⌊eval arg1 mod 2^(32 * (x + 1)) / 2^(32 * x)⌋) [0..6] ∧ 0 ≤ eval arg1 < m →
  * arg2 = map (λ x, ⌊eval arg2 mod 2^(32 * (x + 1)) / 2^(32 * x)⌋) [0..6] ∧ 0 ≤ eval arg2 < m →
  * eval (fiat_p224_from_montgomery out1) mod m = (eval (fiat_p224_from_montgomery arg1) * eval (fiat_p224_from_montgomery arg2)) mod m
@@ -977,7 +977,7 @@ static void fiat_p224_mul(uint32_t out1[7], const uint32_t arg1[7], const uint32
 }
 
 /*
- * The function fiat_p224_square does stuff.
+ * The function fiat_p224_square squares a field element in the Montgomery domain.
  * arg1 = map (λ x, ⌊eval arg1 mod 2^(32 * (x + 1)) / 2^(32 * x)⌋) [0..6] ∧ 0 ≤ eval arg1 < m →
  * eval (fiat_p224_from_montgomery out1) mod m = (eval (fiat_p224_from_montgomery arg1) * eval (fiat_p224_from_montgomery arg1)) mod m
  * ∧ out1 = map (λ x, ⌊eval out1 mod 2^(32 * (x + 1)) / 2^(32 * x)⌋) [0..6]
@@ -1859,7 +1859,7 @@ static void fiat_p224_square(uint32_t out1[7], const uint32_t arg1[7]) {
 }
 
 /*
- * The function fiat_p224_add does stuff.
+ * The function fiat_p224_add adds two field elements in the Montgomery domain.
  * arg1 = map (λ x, ⌊eval arg1 mod 2^(32 * (x + 1)) / 2^(32 * x)⌋) [0..6] ∧ 0 ≤ eval arg1 < m →
  * arg2 = map (λ x, ⌊eval arg2 mod 2^(32 * (x + 1)) / 2^(32 * x)⌋) [0..6] ∧ 0 ≤ eval arg2 < m →
  * eval (fiat_p224_from_montgomery out1) mod m = (eval (fiat_p224_from_montgomery arg1) + eval (fiat_p224_from_montgomery arg2)) mod m
@@ -1941,7 +1941,7 @@ static void fiat_p224_add(uint32_t out1[7], const uint32_t arg1[7], const uint32
 }
 
 /*
- * The function fiat_p224_sub does stuff.
+ * The function fiat_p224_sub subtracts two field elements in the Montgomery domain.
  * arg1 = map (λ x, ⌊eval arg1 mod 2^(32 * (x + 1)) / 2^(32 * x)⌋) [0..6] ∧ 0 ≤ eval arg1 < m →
  * arg2 = map (λ x, ⌊eval arg2 mod 2^(32 * (x + 1)) / 2^(32 * x)⌋) [0..6] ∧ 0 ≤ eval arg2 < m →
  * eval (fiat_p224_from_montgomery out1) mod m = (eval (fiat_p224_from_montgomery arg1) - eval (fiat_p224_from_montgomery arg2)) mod m
@@ -2008,7 +2008,7 @@ static void fiat_p224_sub(uint32_t out1[7], const uint32_t arg1[7], const uint32
 }
 
 /*
- * The function fiat_p224_opp does stuff.
+ * The function fiat_p224_opp negates a field element in the Montgomery domain.
  * arg1 = map (λ x, ⌊eval arg1 mod 2^(32 * (x + 1)) / 2^(32 * x)⌋) [0..6] ∧ 0 ≤ eval arg1 < m →
  * eval (fiat_p224_from_montgomery out1) mod m = -eval (fiat_p224_from_montgomery arg1) mod m
  * ∧ out1 = map (λ x, ⌊eval out1 mod 2^(32 * (x + 1)) / 2^(32 * x)⌋) [0..6]
@@ -2073,9 +2073,9 @@ static void fiat_p224_opp(uint32_t out1[7], const uint32_t arg1[7]) {
 }
 
 /*
- * The function fiat_p224_from_montgomery does stuff.
+ * The function fiat_p224_from_montgomery translates a field element out of the Montgomery domain.
  * arg1 = map (λ x, ⌊eval arg1 mod 2^(32 * (x + 1)) / 2^(32 * x)⌋) [0..6] ∧ 0 ≤ eval arg1 < m →
- * eval out1 mod m = (eval arg1 * 26959946660873538059280334323183841250350249843942399443119741337601^7) mod m
+ * eval out1 mod m = (eval arg1 * ((2^32)⁻¹ mod m)^7) mod m
  * ∧ out1 = map (λ x, ⌊eval out1 mod 2^(32 * (x + 1)) / 2^(32 * x)⌋) [0..6]
  * ∧ 0 ≤ eval out1 < m
  * Input Bounds:
@@ -2613,7 +2613,7 @@ static void fiat_p224_from_montgomery(uint32_t out1[7], const uint32_t arg1[7])
 }
 
 /*
- * The function fiat_p224_nonzero does stuff.
+ * The function fiat_p224_nonzero outputs a single non-zero word if the input is non-zero and zero otherwise.
  * arg1 = map (λ x, ⌊eval arg1 mod 2^(32 * (x + 1)) / 2^(32 * x)⌋) [0..6] ∧ 0 ≤ eval arg1 < m →
  * out1 = 0 ↔ eval (fiat_p224_from_montgomery arg1) mod m = 0
  * Input Bounds:
@@ -2661,7 +2661,7 @@ static void fiat_p224_selectznz(uint32_t out1[7], fiat_p224_uint1 arg1, const ui
 }
 
 /*
- * The function fiat_p224_to_bytes does stuff.
+ * The function fiat_p224_to_bytes serializes a field element in the Montgomery domain to bytes in little-endian order.
  * arg1 = map (λ x, ⌊eval arg1 mod 2^(32 * (x + 1)) / 2^(32 * x)⌋) [0..6] ∧ 0 ≤ eval arg1 < m →
  * out1 = map (λ x, ⌊(eval arg1 mod m) mod 2^(8 * (x + 1)) / 2^(8 * x)⌋) [0..27]
  * Input Bounds:
@@ -2756,7 +2756,7 @@ static void fiat_p224_to_bytes(uint8_t out1[28], const uint32_t arg1[7]) {
 }
 
 /*
- * The function fiat_p224_from_bytes does stuff.
+ * The function fiat_p224_from_bytes deserializes a field element in the Montgomery domain from bytes in little-endian order.
  * arg1 = map (λ x, ⌊bytes_eval arg1 mod 2^(8 * (x + 1)) / 2^(8 * x)⌋) [0..27] ∧ 0 ≤ bytes_eval arg1 < m →
  * eval out1 mod m = bytes_eval arg1 mod m
  * ∧ out1 = map (λ x, ⌊eval out1 mod 2^(32 * (x + 1)) / 2^(32 * x)⌋) [0..6]