From 3d26ebba945891f6ae96d44267bac2be156275a2 Mon Sep 17 00:00:00 2001
From: Alexander Gauggel <agauggel@uni-koblenz.de>
Date: Wed, 29 Sep 2021 16:09:53 +0200
Subject: [PATCH] [#96] Add function documentation to BufferManager

---
 include/vkcv/BufferManager.hpp | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/include/vkcv/BufferManager.hpp b/include/vkcv/BufferManager.hpp
index 7bec33d8..69385600 100644
--- a/include/vkcv/BufferManager.hpp
+++ b/include/vkcv/BufferManager.hpp
@@ -132,6 +132,12 @@ namespace vkcv
 		 */
 		void unmapBuffer(const BufferHandle& handle);
 		
+		/**
+		 * Record a memory barrier for a buffer, synchronizing subsequent accesses to buffer data
+		 *
+		 * @param handle #BufferHandle of the buffer
+		 * @param cmdBuffer Vulkan command buffer to record the barrier into
+		*/
 		void recordBufferMemoryBarrier(
 			const BufferHandle& handle,
 			vk::CommandBuffer cmdBuffer);
-- 
GitLab