From 6dd52585cb2968a02eba269e61be5311c4834420 Mon Sep 17 00:00:00 2001
From: Tobias Frisch <tfrisch@uni-koblenz.de>
Date: Mon, 6 Jun 2022 01:00:13 +0200
Subject: [PATCH] Adjusting a few pieces of doxygen comments
Signed-off-by: Tobias Frisch <tfrisch@uni-koblenz.de>
---
include/vkcv/DrawcallRecording.hpp | 18 +++++++++++++++---
include/vkcv/QueueManager.hpp | 6 +++---
2 files changed, 18 insertions(+), 6 deletions(-)
diff --git a/include/vkcv/DrawcallRecording.hpp b/include/vkcv/DrawcallRecording.hpp
index 750685f0..abcd8d6f 100644
--- a/include/vkcv/DrawcallRecording.hpp
+++ b/include/vkcv/DrawcallRecording.hpp
@@ -31,7 +31,10 @@ namespace vkcv {
Bit16,
Bit32
};
-
+
+ /**
+ * @brief Structure to configure a descriptor set usage.
+ */
struct DescriptorSetUsage {
inline DescriptorSetUsage(uint32_t setLocation, DescriptorSetHandle descriptorSet,
const std::vector<uint32_t>& dynamicOffsets = {}) noexcept :
@@ -43,7 +46,10 @@ namespace vkcv {
const DescriptorSetHandle descriptorSet;
const std::vector<uint32_t> dynamicOffsets;
};
-
+
+ /**
+ * @brief Structure to store details of a mesh to draw.
+ */
struct Mesh {
inline Mesh() {}
@@ -62,7 +68,10 @@ namespace vkcv {
IndexBitCount indexBitCount;
};
-
+
+ /**
+ * @brief Structure to store details for a drawcall.
+ */
struct DrawcallInfo {
inline DrawcallInfo(const Mesh& mesh,
const std::vector<DescriptorSetUsage>& descriptorSets,
@@ -78,6 +87,9 @@ namespace vkcv {
void InitMeshShaderDrawFunctions(vk::Device device);
+ /**
+ * @brief Structure to store details for a mesh shader drawcall.
+ */
struct MeshShaderDrawcall {
std::vector<DescriptorSetUsage> descriptorSets;
uint32_t taskCount;
diff --git a/include/vkcv/QueueManager.hpp b/include/vkcv/QueueManager.hpp
index 163021e6..04a5d8a0 100644
--- a/include/vkcv/QueueManager.hpp
+++ b/include/vkcv/QueueManager.hpp
@@ -10,7 +10,7 @@
namespace vkcv {
/**
- * Enum class to represent types of queues.
+ * @brief Enum class to represent types of queues.
*/
enum class QueueType {
Compute,
@@ -20,7 +20,7 @@ namespace vkcv {
};
/**
- * Struct to represent a queue, provide its family and its index.
+ * @brief Structure to represent a queue and its details.
*/
struct Queue {
int familyIndex;
@@ -30,7 +30,7 @@ namespace vkcv {
};
/**
- * Class to manage queues of a device.
+ * @brief Class to manage queues of a device.
*/
class QueueManager {
public:
--
GitLab