bloom: Add some source documentation.

[adu.git] / bloom.h

diff --git a/bloom.h b/bloom.h
index afb22980d504e9a1d70cc3622ea8d647ea2566a5..e7f3cd33dc2018d03f410064731c0a8be97b6e59 100644 (file)
--- a/bloom.h
+++ b/bloom.h
@@ -1,8 +1,22 @@
+/*
+ * Copyright (C) 2008 Andre Noll <maan@systemlinux.org>
+ *
+ * Licensed under the GPL v2. For licencing details see COPYING.
+ */
+
+/** \file bloom.h Struct bloom and bloom filter functions. */
+
+/** Describes one instance of a bloom filter. */
 struct bloom {
+       /** The bloom filter is of size 2^order bits. */
        unsigned order;
+       /** Set that many bits in the filter per entry. */
        unsigned num_hash_functions;
+       /** How many entries have been inserted so far. */
        uint64_t num_entries;
+       /** Number of bits currently set. */
        uint64_t num_set_bits;
+       /** The bit array. */
        uint8_t *filter;
 };