📝 Add docstrings to `cleanup3`

Docstrings generation was requested by @mtl1979.

* https://github.com/zlib-ng/zlib-ng/pull/1978#issuecomment-3373304629

The following files were modified:

* `test/benchmarks/benchmark_slidehash.cc`

diff --git a/test/benchmarks/benchmark_slidehash.cc b/test/benchmarks/benchmark_slidehash.cc
index 4313450ae19965fd1315620f1cb83c46d8c54ecc..6f3b1221fc6081fa80a8ce0d724ebf0d867a6ebd 100644 (file)
--- a/test/benchmarks/benchmark_slidehash.cc
+++ b/test/benchmarks/benchmark_slidehash.cc
@@ -24,6 +24,15 @@ private:
     deflate_state *s_g;
 
 public:
+    /**
+     * @brief Prepare the benchmark fixture by allocating and initializing working data.
+     *
+     * Allocates two 64-byte-aligned arrays of `uint16_t` (one of size HASH_SIZE, one of size MAX_RANDOM_INTS),
+     * fills them with pseudorandom `uint16_t` values, allocates a `deflate_state` structure, and sets
+     * its `head` and `prev` pointers to the allocated arrays.
+     *
+     * @param state Benchmark-provided state object from Google Benchmark (supplied by the framework).
+     */
     void SetUp(const ::benchmark::State& state) {
         l0 = (uint16_t *)zng_alloc_aligned(HASH_SIZE * sizeof(uint16_t), 64);
 
@@ -102,4 +111,4 @@ BENCHMARK_SLIDEHASH(lsx, slide_hash_lsx, test_cpu_features.loongarch.has_lsx);
 BENCHMARK_SLIDEHASH(lasx, slide_hash_lasx, test_cpu_features.loongarch.has_lasx);
 #endif
 
-#endif
+#endif
\ No newline at end of file