From c893eb9c5fc55a66e55ff65ce6da9374e1241e97 Mon Sep 17 00:00:00 2001
From: psippl <philsippl@gmail.com>
Date: Tue, 8 Feb 2022 16:05:22 -1000
Subject: [PATCH] fix comments

---
 src/lib.rs | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/src/lib.rs b/src/lib.rs
index c7e44a0..14ed9bd 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -68,7 +68,7 @@ pub unsafe extern "C" fn generate_nullifier_hash(
     .into_raw()
 }
 
-/// Generates nullifier hash based on identity and external nullifier
+/// Initializes new poseidon tree of given depth
 #[no_mangle]
 #[allow(clippy::missing_safety_doc)]
 pub unsafe extern "C" fn create_poseidon_tree(depth: c_int) -> *mut PoseidonTree {
@@ -82,7 +82,7 @@ pub unsafe extern "C" fn create_poseidon_tree(depth: c_int) -> *mut PoseidonTree
     Box::into_raw(boxed)
 }
 
-/// Generates nullifier hash based on identity and external nullifier
+/// Insert leaf into given poseidon tree
 #[no_mangle]
 #[allow(clippy::missing_safety_doc)]
 pub unsafe extern "C" fn insert_leaf(tree: *mut PoseidonTree, identity: *mut identity::Identity) {
@@ -96,7 +96,7 @@ pub unsafe extern "C" fn insert_leaf(tree: *mut PoseidonTree, identity: *mut ide
     tree.set(0, leaf.into());
 }
 
-/// Generates nullifier hash based on identity and external nullifier
+/// Returns root for given tree
 #[no_mangle]
 #[allow(clippy::missing_safety_doc)]
 pub unsafe extern "C" fn get_root(tree: *mut PoseidonTree) -> *mut c_char {
@@ -109,7 +109,7 @@ pub unsafe extern "C" fn get_root(tree: *mut PoseidonTree) -> *mut c_char {
     CString::new(root.to_str_radix(10)).unwrap().into_raw()
 }
 
-/// Generates nullifier hash based on identity and external nullifier
+/// Generates merkle proof for given leaf index
 #[no_mangle]
 #[allow(clippy::missing_safety_doc)]
 pub unsafe extern "C" fn get_merkle_proof(
@@ -127,7 +127,7 @@ pub unsafe extern "C" fn get_merkle_proof(
     Box::into_raw(boxed)
 }
 
-/// Generates nullifier hash based on identity and external nullifier
+/// Generates semaphore proof
 #[no_mangle]
 #[allow(clippy::missing_safety_doc)]
 pub unsafe extern "C" fn generate_proof(
@@ -182,6 +182,7 @@ pub unsafe extern "C" fn generate_proof(
     Box::into_raw(boxed)
 }
 
+/// Verifies semaphore proof
 #[no_mangle]
 #[allow(clippy::missing_safety_doc)]
 pub unsafe extern "C" fn verify_proof(