From ae2b37a20c0874d91f73fe1c63ba9c23a836082a Mon Sep 17 00:00:00 2001
From: Tobias Frisch <tfrisch@uni-koblenz.de>
Date: Wed, 6 Oct 2021 01:03:11 +0200
Subject: [PATCH] [#96] Added some descriptions to header files
Signed-off-by: Tobias Frisch <tfrisch@uni-koblenz.de>
---
include/vkcv/Buffer.hpp | 3 ++-
include/vkcv/Event.hpp | 5 +++++
include/vkcv/Features.hpp | 5 +++++
include/vkcv/File.hpp | 5 +++++
include/vkcv/Handles.hpp | 4 ++--
include/vkcv/Image.hpp | 5 +++--
include/vkcv/Logger.hpp | 5 +++++
include/vkcv/QueueManager.hpp | 34 +++++++++++++++++++++++++++-------
8 files changed, 54 insertions(+), 12 deletions(-)
diff --git a/include/vkcv/Buffer.hpp b/include/vkcv/Buffer.hpp
index d2ea7047..13a6b24d 100644
--- a/include/vkcv/Buffer.hpp
+++ b/include/vkcv/Buffer.hpp
@@ -2,8 +2,9 @@
/**
* @authors Lars Hoerttrich, Tobias Frisch
* @file vkcv/Buffer.hpp
- * @brief template buffer class, template for type security, implemented here because template classes can't be written in .cpp
+ * @brief Template buffer class for type security with buffers.
*/
+
#include "Handles.hpp"
#include "BufferManager.hpp"
diff --git a/include/vkcv/Event.hpp b/include/vkcv/Event.hpp
index 0a5cc1f0..0d30a4ac 100644
--- a/include/vkcv/Event.hpp
+++ b/include/vkcv/Event.hpp
@@ -1,4 +1,9 @@
#pragma once
+/**
+ * @authors Tobias Frisch
+ * @file vkcv/Event.hpp
+ * @brief Template event struct to synchronize callbacks.
+ */
#include <functional>
diff --git a/include/vkcv/Features.hpp b/include/vkcv/Features.hpp
index 540827d8..2e841aa6 100644
--- a/include/vkcv/Features.hpp
+++ b/include/vkcv/Features.hpp
@@ -1,4 +1,9 @@
#pragma once
+/**
+ * @authors Tobias Frisch
+ * @file vkcv/Features.hpp
+ * @brief Class to manage feature requests.
+ */
#include <functional>
#include <vector>
diff --git a/include/vkcv/File.hpp b/include/vkcv/File.hpp
index 06f1c485..67e455d6 100644
--- a/include/vkcv/File.hpp
+++ b/include/vkcv/File.hpp
@@ -1,4 +1,9 @@
#pragma once
+/**
+ * @authors Tobias Frisch
+ * @file vkcv/File.hpp
+ * @brief Functions to handle generating temporary file paths.
+ */
#include <filesystem>
diff --git a/include/vkcv/Handles.hpp b/include/vkcv/Handles.hpp
index 1e6091c9..802b559b 100644
--- a/include/vkcv/Handles.hpp
+++ b/include/vkcv/Handles.hpp
@@ -1,7 +1,7 @@
#pragma once
/**
- * @authors Artur Wasmut
- * @file src/vkcv/Handles.cpp
+ * @authors Artur Wasmut, Tobias Frisch
+ * @file vkcv/Handles.hpp
* @brief Central header file for all possible handles that the framework will hand out.
*/
diff --git a/include/vkcv/Image.hpp b/include/vkcv/Image.hpp
index a21c4f5b..cac4a466 100644
--- a/include/vkcv/Image.hpp
+++ b/include/vkcv/Image.hpp
@@ -1,9 +1,10 @@
#pragma once
/**
* @authors Lars Hoerttrich
- * @file vkcv/Buffer.hpp
- * @brief class for image handles
+ * @file vkcv/Image.hpp
+ * @brief Class for image handling
*/
+
#include "vulkan/vulkan.hpp"
#include "Handles.hpp"
diff --git a/include/vkcv/Logger.hpp b/include/vkcv/Logger.hpp
index 45a397a0..64b08e54 100644
--- a/include/vkcv/Logger.hpp
+++ b/include/vkcv/Logger.hpp
@@ -1,4 +1,9 @@
#pragma once
+/**
+ * @authors Tobias Frisch
+ * @file vkcv/Logging.hpp
+ * @brief Logging macro function to print line of code specific information.
+ */
#include <stdio.h>
diff --git a/include/vkcv/QueueManager.hpp b/include/vkcv/QueueManager.hpp
index b2114371..3e302495 100644
--- a/include/vkcv/QueueManager.hpp
+++ b/include/vkcv/QueueManager.hpp
@@ -1,10 +1,27 @@
#pragma once
+/**
+ * @authors Tobias Frisch
+ * @file vkcv/QueueManager.hpp
+ * @brief Types to manage queues of a device.
+ */
+
#include <vulkan/vulkan.hpp>
namespace vkcv {
- enum class QueueType { Compute, Transfer, Graphics, Present };
+ /**
+ * Enum class to represent types of queues.
+ */
+ enum class QueueType {
+ Compute,
+ Transfer,
+ Graphics,
+ Present
+ };
+ /**
+ * Struct to represent a queue, provide its family and its index.
+ */
struct Queue {
int familyIndex;
int queueIndex;
@@ -12,10 +29,13 @@ namespace vkcv {
vk::Queue handle;
};
+ /**
+ * Class to manage queues of a device.
+ */
class QueueManager {
public:
/**
- * creates a QueueManager with the given queue pairs
+ * Creates a QueueManager with the given queue pairs
* @param device device that holds the queues that are specified in the queue pairs
* @param queuePairsGraphics graphic queue pairs of queueFamily and queueIndex
* @param queuePairsCompute compute queue pairs of queueFamily and queueIndex
@@ -27,28 +47,28 @@ namespace vkcv {
std::vector<std::pair<int, int>> &queuePairsCompute,
std::vector<std::pair<int, int>> &queuePairsTransfer);
/**
- * returns the default presentQueue. Recommended to use the presentQueue in the Swapchain
+ * Returns the default presentQueue. Recommended to use the presentQueue in the Swapchain
* @return a default presentQueue
*/
[[nodiscard]]
const Queue &getPresentQueue() const;
/**
- * returns all queues with the graphics flag
+ * Returns all queues with the graphics flag
* @return vector of graphic queues
*/
[[nodiscard]]
const std::vector<Queue> &getGraphicsQueues() const;
/**
- * returns all queues with the compute flag
+ * Returns all queues with the compute flag
* @return vector of compute queues
*/
[[nodiscard]]
const std::vector<Queue> &getComputeQueues() const;
/**
- * returns all queues with the transfer flag
+ * Returns all queues with the transfer flag
* @return vector of transfer queues
*/
[[nodiscard]]
@@ -81,7 +101,7 @@ namespace vkcv {
std::vector<std::pair<int, int>> &queuePairsTransfer);
/**
- * checks for surface support in the queues
+ * Checks for surface support in the queues
* @param physicalDevice to get the Queues
* @param surface that needs to checked
* @return
--
GitLab