From f50ded346b7b3b7be3f1e18b65ac41aa03c6be1d Mon Sep 17 00:00:00 2001
From: elliVM <126466762+elliVM@users.noreply.github.com>
Date: Mon, 4 Nov 2024 18:20:53 +0200
Subject: [PATCH] update javadoc of finish method (#44)

---
 .../teragrep/functions/dpf_03/BloomFilterAggregator.scala  | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/src/main/scala/com/teragrep/functions/dpf_03/BloomFilterAggregator.scala b/src/main/scala/com/teragrep/functions/dpf_03/BloomFilterAggregator.scala
index 805f845..e735fc0 100644
--- a/src/main/scala/com/teragrep/functions/dpf_03/BloomFilterAggregator.scala
+++ b/src/main/scala/com/teragrep/functions/dpf_03/BloomFilterAggregator.scala
@@ -95,9 +95,10 @@ class BloomFilterAggregator(final val columnName: String,
   }
 
   /**
-   * Find best BloomFilter candidate for return
-   * @param buffer BloomFilterBuffer returned by reduce step
-   * @return best candidate by fpp being smaller than requested
+   * Write the final buffer filter into a byte array
+   *
+   * @param buffer resulting final bloom filter after aggregation process
+   * @return byte array of the final bloom filter
    */
   override def finish(buffer: BloomFilter): Array[Byte] = {
     val baos = new ByteArrayOutputStream()