Documenting also private bucket functions.

In particular that inserting the same fingerprint multiple times is
allowed.

Author: panmari

bucket.go

@@ -8,6 +8,7 @@ import (
 // fingerprint represents a single entry in a bucket.
 type fingerprint uint16
 
+// bucket keeps track of fingerprints hashing to the same index.
 type bucket [bucketSize]fingerprint
 
 const (
@@ -17,6 +18,8 @@ const (
 	maxFingerprint      = (1 << fingerprintSizeBits) - 1
 )
 
+// insert a fingerprint into a bucket. Returns true if there was enough space and insertion succeeded.
+// Note it allows inserting the same fingerprint multiple times.
 func (b *bucket) insert(fp fingerprint) bool {
 	for i, tfp := range b {
 		if tfp == nullFp {
@@ -27,6 +30,8 @@ func (b *bucket) insert(fp fingerprint) bool {
 	return false
 }
 
+// delete a fingerprint from a bucket.
+// Returns true if the fingerprint was present and successfully removed.
 func (b *bucket) delete(fp fingerprint) bool {
 	for i, tfp := range b {
 		if tfp == fp {
@@ -46,6 +51,7 @@ func (b *bucket) contains(needle fingerprint) bool {
 	return false
 }
 
+// reset deletes all fingerprints in the bucket.
 func (b *bucket) reset() {
 	for i := range b {
 		b[i] = nullFp