📝 Update documentation comments.

mpc-algebra/src/r1cs_helper.rs

@@ -1,3 +1,5 @@
+//! This module contains helper functions for creating R1CS constraints for MPC protocols.
+
 pub mod mpc_boolean;
 pub use mpc_boolean::*;
 pub mod mpc_eq;

mpc-algebra/src/wire/field.rs

@@ -576,6 +576,14 @@ impl<F: Field, S: FieldShare<F>> Zero for MpcField<F, S> {
 
 impl<F: PrimeField + SquareRootField, S: FieldShare<F>> EqualityZero for MpcField<F, S> {
     type Output = MpcBooleanField<F, S>;
+
+    /// Check if the MPC field element is zero in MPC.
+    ///
+    /// # Arguments
+    /// `self` - A MPC field element.
+    ///
+    /// # Returns
+    /// A MPC boolean field element.
     fn is_zero_shared(&self) -> Self::Output {
         let res = match self {
             MpcField::Public(_) => {
@@ -626,6 +634,14 @@ impl<F: PrimeField + SquareRootField, S: FieldShare<F>> EqualityZero for MpcFiel
 
 impl<F: PrimeField + SquareRootField, S: FieldShare<F>> BitDecomposition for MpcField<F, S> {
     type BooleanField = MpcBooleanField<F, S>;
+
+    /// Bit decomposition of a field element.
+    ///
+    /// # Arguments
+    /// `self` - A Mpc field element.
+    ///
+    /// # Returns
+    /// A vector of bits of the Mpc field element(Little-Endian).
     fn bit_decomposition(&self) -> Vec<Self::BooleanField> {
         match self.is_shared() {
             true => {

src/circuits/smaller_than.rs

@@ -13,6 +13,7 @@ use mpc_algebra::{MpcBoolean, MpcEqGadget, MpcFpVar};
 type Fr = ark_bls12_377::Fr;
 type MFr = MpcField<Fr>;
 
+/// This circuit checks if a value is smaller than another value.
 pub struct SmallerThanCircuit<F: PrimeField> {
     pub a: F,
     pub b: F,

src/groth16.rs

@@ -1,3 +1,7 @@
+//! # Groth16: zk-SNARKs
+//!
+//! This module provides functions for setting up, proving, and verifying MPC (Multi-Party Computation) circuits using the Groth16 zkSNARK.
+
 #[cfg(test)]
 mod tests {
     use ark_bls12_377::{Bls12_377, Fr};

src/marlin.rs

@@ -1,3 +1,7 @@
+//! # Marlin: zk-SNARKs
+//!
+//! This module provides functions for setting up, proving, and verifying MPC (Multi-Party Computation) circuits using the Marlin zkSNARK.
+
 use ark_ff::{BigInteger, PrimeField};
 use ark_marlin::{ahp::prover::*, *};
 use ark_poly::univariate::DensePolynomial;