From e69f44ae3d3d71b0c3b6fe2b7a7a3bfdd01de9e4 Mon Sep 17 00:00:00 2001
From: Celine Mercier <celine.mercier@metabarcoding.org>
Date: Thu, 21 Apr 2016 13:53:29 +0200
Subject: [PATCH] Little annotations for the murmur hash function.

---
 src/MurmurHash2.c | 2 +-
 src/murmurhash2.h | 4 ++++
 2 files changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/MurmurHash2.c b/src/MurmurHash2.c
index 32c4c32..6e6a82c 100755
--- a/src/MurmurHash2.c
+++ b/src/MurmurHash2.c
@@ -10,7 +10,7 @@
 
 // 1. It will not work incrementally.
 // 2. It will not produce the same results on little-endian and big-endian
-//    machines.
+//    machines.	->TODO
 
 unsigned int murmurhash2(const void * key, int len, const unsigned int seed)
 {
diff --git a/src/murmurhash2.h b/src/murmurhash2.h
index e607381..094fe93 100755
--- a/src/murmurhash2.h
+++ b/src/murmurhash2.h
@@ -2,6 +2,10 @@
 #ifndef _BLOOM_MURMURHASH2
 #define _BLOOM_MURMURHASH2
 
+
+/**
+ * @brief Generates and returns a hash code from a byte array.
+ */
 unsigned int murmurhash2(const void * key, int len, const unsigned int seed);
 
 #endif