From eee7d0d84dc7731df2359b243aa5e75d85f6eaef Mon Sep 17 00:00:00 2001
From: JP Aumasson <jp@taurusgroup.ch>
Date: Sat, 22 Oct 2022 07:14:59 +0200
Subject: comments

---
 halfsiphash.c | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'halfsiphash.c')

diff --git a/halfsiphash.c b/halfsiphash.c
index 18ebadd..455c27c 100644
--- a/halfsiphash.c
+++ b/halfsiphash.c
@@ -71,6 +71,14 @@
 #define TRACE
 #endif
 
+/*
+    Computes a SipHash value
+    *in: pointer to input data (read-only)
+    inlen: input data length in bytes (any size_t value)
+    *k: pointer to the key data (read-only), must be 8 bytes 
+    *out: pointer to output data (write-only), outlen bytes must be allocated
+    outlen: length of the output in bytes, must be 4 or 8
+*/
 int halfsiphash(const void *in, const size_t inlen, const void *k, uint8_t *out,
                 const size_t outlen) {
 
-- 
cgit v1.2.3