From 5abd98b4fc3da9945c1bf97914f12f7b931a5a74 Mon Sep 17 00:00:00 2001
From: Tobias Frisch <tfrisch@uni-koblenz.de>
Date: Sun, 22 May 2022 22:02:44 +0200
Subject: [PATCH] Adjusted the doxygen comments of the handles
Signed-off-by: Tobias Frisch <tfrisch@uni-koblenz.de>
---
include/vkcv/Handles.hpp | 14 +++++++++++---
1 file changed, 11 insertions(+), 3 deletions(-)
diff --git a/include/vkcv/Handles.hpp b/include/vkcv/Handles.hpp
index 42b13679..f5eddb2e 100644
--- a/include/vkcv/Handles.hpp
+++ b/include/vkcv/Handles.hpp
@@ -33,8 +33,8 @@ namespace vkcv
* @brief Constructor of a valid handle with an
* unique id and an optional destroy callback.
*
- * @param id Unique handle id
- * @param destroy Destroy callback (optional)
+ * @param[in] id Unique handle id
+ * @param[in] destroy Destroy callback (optional)
*/
explicit Handle(uint64_t id, const HandleDestroyFunction& destroy = nullptr);
@@ -79,6 +79,14 @@ namespace vkcv
};
+ /**
+ * @brief Stream operator to print a handle into an output
+ * stream.
+ *
+ * @param[out] out Output stream
+ * @param[in] handle
+ * @return Output stream after printing
+ */
std::ostream& operator << (std::ostream& out, const Handle& handle);
// Handle returned for any buffer created with the core/context objects
@@ -141,7 +149,7 @@ namespace vkcv
* @brief Creates a valid image handle to represent a swapchain image
* using an optional destroy callback.
*
- * @param destroy Destroy callback (optional)
+ * @param[in] destroy Destroy callback (optional)
* @return New swapchain image handle
*/
static ImageHandle createSwapchainImageHandle(const HandleDestroyFunction& destroy = nullptr);
--
GitLab