From f283e689a18f6d7d7e457bc2d8f1504a6c81445f Mon Sep 17 00:00:00 2001
From: Alexis Placet <alexis.placet@quantstack.net>
Date: Thu, 5 Sep 2024 14:09:45 +0200
Subject: [PATCH] Add documentation

---
 include/sparrow/arrow_interface/arrow_flag_utils.hpp | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/include/sparrow/arrow_interface/arrow_flag_utils.hpp b/include/sparrow/arrow_interface/arrow_flag_utils.hpp
index a5f528af..f0840ceb 100644
--- a/include/sparrow/arrow_interface/arrow_flag_utils.hpp
+++ b/include/sparrow/arrow_interface/arrow_flag_utils.hpp
@@ -16,6 +16,7 @@
 
 namespace sparrow
 {
+    /// Check that the given value is a valid ArrowFlag value.
     constexpr bool is_valid_ArrowFlag_value(int64_t value) noexcept
     {
         constexpr std::array<ArrowFlag, 3> valid_values = {
@@ -32,6 +33,7 @@ namespace sparrow
         );
     }
 
+    /// Convert a bitfield of ArrowFlag values to a vector of ArrowFlag values.
     constexpr std::vector<ArrowFlag> to_vector_of_ArrowFlags(int64_t flag_values)
     {
         constexpr size_t n_bits = sizeof(flag_values) * 8;
@@ -52,6 +54,7 @@ namespace sparrow
         return flags;
     }
 
+    /// Convert a vector of ArrowFlag values to a bitfield of ArrowFlag values.
     constexpr int64_t to_ArrowFlag_value(const std::vector<ArrowFlag>& flags)
     {
         int64_t flag_values = 0;