add some small doxygen comments

heal-research · Jun 1, 2024 · dbfe0bc · dbfe0bc
1 parent de193cd
commit dbfe0bc
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/include/vstat/bivariate.hpp b/include/vstat/bivariate.hpp
@@ -7,7 +7,9 @@
 #include "combine.hpp"
 
 namespace VSTAT_NAMESPACE {
-
+/*!
+    \brief Bivariate accumulator object
+*/
 template <typename T>
 struct bivariate_accumulator {
     static auto load_state(T sx, T sy, T sw, T sxx, T syy, T sxy) noexcept -> bivariate_accumulator<T> // NOLINT
@@ -102,6 +104,9 @@ struct bivariate_accumulator {
     T sum_xy{0};
 };
 
+/*!
+    \brief Bivariate statistics
+*/
 struct bivariate_statistics {
     double count;
     double sum_x;

diff --git a/include/vstat/univariate.hpp b/include/vstat/univariate.hpp
@@ -78,6 +78,9 @@ struct univariate_accumulator {
     T sum_xx{0};
 };
 
+/*!
+    \brief Univariate statistics
+*/
 struct univariate_statistics {
     double count;
     double sum;