Added documentation for the functions and structs.

Author: hdvanegasm

test_suite/src/bench.rs

@@ -6,16 +6,23 @@ use serde_json::Value;
 
 use crate::constants;
 
+/// Error that may happen in the command execution.
 #[derive(thiserror::Error, Debug)]
 pub enum Error {
     #[error("error executing the gate-count command: {0:?}")]
     CommandOutputError(String),
 }
 
+/// Results of the benchmark.
+///
+/// This results are extracted using the command `bb gates -b <target>`
 #[derive(Deserialize)]
 pub struct BenchResult {
+    /// Number of ACIR opcodes generated by the compiler.
     pub acir_opcodes: u32,
+    /// The number of gates.
     pub circuit_size: u32,
+    /// Number of gates per opcode.
     pub gates_per_opcode: Vec<u32>,
 }
 
@@ -29,6 +36,9 @@ impl Display for BenchResult {
     }
 }
 
+/// Executes the command to count the gate. This command must be executed after
+/// the code is successfully compiled. To count the number of gates, we use the
+/// command `bb gates -b <target>`.
 pub fn execute_count_gate_command() -> anyhow::Result<BenchResult> {
     let output = Command::new("bb")
         .args(["gates", "-b"])