[gnunet] 46/90: -DOC: Documentation cleanup pass through SCALARPRODUCT subsystem

[gnunet]

This is an automated email from the git hooks/post-receive script.

martin-schanzenbach pushed a commit to branch master
in repository gnunet.

commit 8a86448236ad19365734ee3353da449c21f41a28
Author: Willow Liquorice <willow@howhill.com>
AuthorDate: Wed Sep 7 20:49:17 2022 +0100

    -DOC: Documentation cleanup pass through SCALARPRODUCT subsystem
---
 src/include/gnunet_scalarproduct_service.h                 | 2 +-
 src/scalarproduct/gnunet-scalarproduct.c                   | 1 -
 src/scalarproduct/gnunet-service-scalarproduct-ecc_alice.c | 2 +-
 src/scalarproduct/gnunet-service-scalarproduct-ecc_bob.c   | 4 +---
 src/scalarproduct/gnunet-service-scalarproduct_alice.c     | 2 +-
 src/scalarproduct/gnunet-service-scalarproduct_bob.c       | 2 +-
 src/scalarproduct/scalarproduct_api.c                      | 2 +-
 7 files changed, 6 insertions(+), 9 deletions(-)

diff --git a/src/include/gnunet_scalarproduct_service.h 
b/src/include/gnunet_scalarproduct_service.h
index 1d775f659..7f60bb325 100644
--- a/src/include/gnunet_scalarproduct_service.h
+++ b/src/include/gnunet_scalarproduct_service.h
@@ -179,7 +179,7 @@ GNUNET_SCALARPRODUCT_start_computation (
 struct GNUNET_SCALARPRODUCT_ComputationHandle *
 GNUNET_SCALARPRODUCT_accept_computation (
   const struct GNUNET_CONFIGURATION_Handle *cfg,
-  const struct GNUNET_HashCode *key,
+  const struct GNUNET_HashCode *session_key,
   const struct GNUNET_SCALARPRODUCT_Element *elements,
   uint32_t element_count,
   GNUNET_SCALARPRODUCT_ContinuationWithStatus cont,
diff --git a/src/scalarproduct/gnunet-scalarproduct.c 
b/src/scalarproduct/gnunet-scalarproduct.c
index 14495de05..07af916b1 100644
--- a/src/scalarproduct/gnunet-scalarproduct.c
+++ b/src/scalarproduct/gnunet-scalarproduct.c
@@ -190,7 +190,6 @@ requester_callback (void *cls,
  * Task run during shutdown.
  *
  * @param cls unused
- * @param tc unused
  */
 static void
 shutdown_task (void *cls)
diff --git a/src/scalarproduct/gnunet-service-scalarproduct-ecc_alice.c 
b/src/scalarproduct/gnunet-service-scalarproduct-ecc_alice.c
index dc43b5a54..c43a7e854 100644
--- a/src/scalarproduct/gnunet-service-scalarproduct-ecc_alice.c
+++ b/src/scalarproduct/gnunet-service-scalarproduct-ecc_alice.c
@@ -761,7 +761,7 @@ cb_intersection_request_alice (void *cls,
 /**
  * Our client has finished sending us its multipart message.
  *
- * @param session the service session context
+ * @param s the service session context
  */
 static void
 client_request_complete_alice (struct AliceServiceSession *s)
diff --git a/src/scalarproduct/gnunet-service-scalarproduct-ecc_bob.c 
b/src/scalarproduct/gnunet-service-scalarproduct-ecc_bob.c
index 02a62c164..1945f1937 100644
--- a/src/scalarproduct/gnunet-service-scalarproduct-ecc_bob.c
+++ b/src/scalarproduct/gnunet-service-scalarproduct-ecc_bob.c
@@ -208,7 +208,7 @@ free_element_cb (void *cls,
 /**
  * Destroy session state, we are done with it.
  *
- * @param session the session to free elements from
+ * @param s the session to free elements from
  */
 static void
 destroy_service_session (struct BobServiceSession *s)
@@ -297,8 +297,6 @@ prepare_client_end_notification (struct BobServiceSession 
*session)
  *
  * @param cls the `struct BobServiceSession`
  * @param channel connection to the other end (henceforth invalid)
- * @param channel_ctx place where local state associated
- *                   with the channel is stored
  */
 static void
 cb_channel_destruction (void *cls,
diff --git a/src/scalarproduct/gnunet-service-scalarproduct_alice.c 
b/src/scalarproduct/gnunet-service-scalarproduct_alice.c
index 665d2ad7f..59c3c6f6c 100644
--- a/src/scalarproduct/gnunet-service-scalarproduct_alice.c
+++ b/src/scalarproduct/gnunet-service-scalarproduct_alice.c
@@ -672,7 +672,7 @@ handle_bobs_cryptodata_multipart (
  * calculate a scalarproduct with.
  *
  * @param cls our `struct AliceServiceSession`
- * @param message the actual message
+ * @param msg the actual message
  * @return #GNUNET_OK to keep the connection open,
  *         #GNUNET_SYSERR to close it (we are done)
  */
diff --git a/src/scalarproduct/gnunet-service-scalarproduct_bob.c 
b/src/scalarproduct/gnunet-service-scalarproduct_bob.c
index b0299779d..15ad3038e 100644
--- a/src/scalarproduct/gnunet-service-scalarproduct_bob.c
+++ b/src/scalarproduct/gnunet-service-scalarproduct_bob.c
@@ -563,7 +563,7 @@ compute_square_sum (const gcry_mpi_t *vector,
  *      S: $S := E_A(sum (r_i + b_i)^2)$
  *     S': $S' := E_A(sum r_i^2)$
  *
- * @param request the requesting session + bob's requesting peer
+ * @param session the requesting session + bob's requesting peer
  * @return #GNUNET_OK on success
  */
 static int
diff --git a/src/scalarproduct/scalarproduct_api.c 
b/src/scalarproduct/scalarproduct_api.c
index db8748f93..8c667a72e 100644
--- a/src/scalarproduct/scalarproduct_api.c
+++ b/src/scalarproduct/scalarproduct_api.c
@@ -140,7 +140,7 @@ process_status_message (struct 
GNUNET_SCALARPRODUCT_ComputationHandle *h,
  * handles the response to the client which used the API.
  *
  * @param cls Pointer to the Master Context
- * @param msg Pointer to the data received in response
+ * @param message Pointer to the data received in response
  */
 static void
 handle_response (void *cls,

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.