From 33e7642c3d1fb46294d83eea8cb01e4e839ddab3 Mon Sep 17 00:00:00 2001
From: Tobias Frisch <tfrisch@uni-koblenz.de>
Date: Wed, 6 Oct 2021 01:19:46 +0200
Subject: [PATCH] [#96] Completed doxygen file comments
Signed-off-by: Tobias Frisch <tfrisch@uni-koblenz.de>
---
include/vkcv/File.hpp | 8 ++++++++
include/vkcv/Logger.hpp | 2 +-
2 files changed, 9 insertions(+), 1 deletion(-)
diff --git a/include/vkcv/File.hpp b/include/vkcv/File.hpp
index 67e455d6..dc41b169 100644
--- a/include/vkcv/File.hpp
+++ b/include/vkcv/File.hpp
@@ -9,8 +9,16 @@
namespace vkcv {
+ /**
+ * Generate a new temporary file path and return it.
+ * @return A unique path for a temporary file
+ */
std::filesystem::path generateTemporaryFilePath();
+ /**
+ * Generate a new temporary directory path and return it.
+ * @return A unique path for a temporary directory
+ */
std::filesystem::path generateTemporaryDirectoryPath();
}
diff --git a/include/vkcv/Logger.hpp b/include/vkcv/Logger.hpp
index 64b08e54..4ae2f7b9 100644
--- a/include/vkcv/Logger.hpp
+++ b/include/vkcv/Logger.hpp
@@ -1,7 +1,7 @@
#pragma once
/**
* @authors Tobias Frisch
- * @file vkcv/Logging.hpp
+ * @file vkcv/Logger.hpp
* @brief Logging macro function to print line of code specific information.
*/
--
GitLab