From 1a2ca2d0919d0c38297982948bfc7547cfdf7b85 Mon Sep 17 00:00:00 2001
From: Lars Hoerttrich <larshoerttrich@uni-koblenz.de>
Date: Sat, 15 May 2021 12:19:01 +0200
Subject: [PATCH] [#22] Minor Correction in documentation
---
include/vkcv/Buffer.hpp | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/include/vkcv/Buffer.hpp b/include/vkcv/Buffer.hpp
index c3e67fa3..67283478 100644
--- a/include/vkcv/Buffer.hpp
+++ b/include/vkcv/Buffer.hpp
@@ -98,10 +98,10 @@ namespace vkcv {
/**
* @brief searches memory type index for buffer allocation, inspired by vulkan tutorial and "https://github.com/KhronosGroup/Vulkan-Hpp/blob/master/samples/utils/utils.hpp"
- * @param memoryProperties
+ * @param physicalMemoryProperties Memory Properties of physical device
* @param typeBits
- * @param requirementsMask
- * @return memory type for Buffer
+ * @param requirements Property flags that are required
+ * @return memory type index for Buffer
*/
uint32_t searchMemoryType(vk::PhysicalDeviceMemoryProperties const& physicalMemoryProperties, uint32_t typeBits, vk::MemoryPropertyFlags requirements) {
uint32_t memoryTypeIndex = uint32_t(0);
@@ -119,8 +119,7 @@ namespace vkcv {
};
/**
- * * Constructor of #Buffer requires a @p device, a @p physicalDevice, a @p buffer type and a @p size.
- *
+ * * Constructor of #Buffer requires a @p device, a @p physicalDevice, a @p buffer type and a @p size. *
* @param device Vulkan-Device
* @param physicalDevice Vulkan-PhysicalDevice
* @param type Enum type of possible vkcv::BufferType
--
GitLab