docs++

dgryski · Dec 15, 2012 · 4fba8f6 · 4fba8f6
1 parent aa4014b
commit 4fba8f6
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/README b/README
@@ -1,3 +1,12 @@
 This library is a collection of "well-known" 32-bit string hashes, implemented in Go.
 
-It includes djb2, ELF-32, Jenkins' One-At-A-Time, Murmur3/32, SuperFastHash, and others.
+It includes:
+    Java string hash
+    ELF-32
+    Jenkins' One-At-A-Time
+    Marvin32
+    Murmur3/32
+    SDBM
+    SQLite3
+    SuperFastHash
+    djb2
diff --git a/marvin.go b/marvin.go
@@ -36,6 +36,7 @@ func marvin_update(lo, hi, v uint32) (uint32, uint32) {
 	return lo, hi
 }
 
+// NewMarvin32 returns a new hash.Hash32 object computing Microsoft's InternalMarvin32HashString seeded hash.
 func NewMarvin32(seed uint64) hash.Hash32 {
 	m := new(marvin)
 	m.seed = seed