From 078e5d81ecd3e7ddc9cb66c93a133066169079d6 Mon Sep 17 00:00:00 2001
From: froejdh_e <erik.frojdh@psi.ch>
Date: Wed, 15 Jan 2025 16:40:34 +0100
Subject: [PATCH] docs

---
 include/aare/ClusterVector.hpp | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/include/aare/ClusterVector.hpp b/include/aare/ClusterVector.hpp
index 60ecd88..73257ce 100644
--- a/include/aare/ClusterVector.hpp
+++ b/include/aare/ClusterVector.hpp
@@ -149,6 +149,12 @@ template <typename T, typename CoordType = int16_t> class ClusterVector {
         return sums;
     }
 
+    /**
+     * @brief Return the maximum sum of the 2x2 subclusters in each cluster
+     * @return std::vector<T> vector of sums for each cluster
+     * @throws std::runtime_error if the cluster size is not 3x3
+     * @warning Only 3x3 clusters are supported for the 2x2 sum.
+     */
     std::vector<T> sum_2x2() {
         std::vector<T> sums(m_size);
         const size_t stride = item_size();