add description to rabin modules

hash/rabin-gf2-polynomial.js

@@ -1,3 +1,14 @@
+/**
+ * The idea of the Rabin fingerprint algorithm is to represent the binary as a polynomial in a
+ * finite field (Galois Field G(2)). The polynomial will then be taken "modulo" by an irreducible
+ * polynomial of the desired size.
+ *
+ * This implementation is inefficient and is solely used to verify the actually performant
+ * implementation in `./rabin.js`.
+ *
+ * @module rabin-gf2-polynomial
+ */
+
 import * as math from '../math.js'
 import * as webcrypto from 'lib0/webcrypto'
 import * as array from '../array.js'

hash/rabin-uncached.js

@@ -1,3 +1,10 @@
+/**
+ * It is not recommended to use this package. This is the uncached implementation of the rabin
+ * fingerprint algorithm. However, it can be used to verify the `rabin.js` implementation.
+ *
+ * @module rabin-uncached
+ */
+
 import * as math from '../math.js'
 import * as buffer from '../buffer.js'
 

hash/rabin.js

@@ -1,3 +1,10 @@
+/**
+ * @module rabin
+ *
+ * Very efficient & versatile fingerprint/hashing algorithm. However, it is not cryptographically
+ * secure.
+ */
+
 import * as buffer from '../buffer.js'
 import * as map from '../map.js'