From 1c2d345d1f11e51528071c2a34b86fa8bbd71967 Mon Sep 17 00:00:00 2001 From: Tobias Frisch <tfrisch@uni-koblenz.de> Date: Wed, 25 May 2022 01:10:45 +0200 Subject: [PATCH] Adjusted difference between brief and detailed description of classes Signed-off-by: Tobias Frisch <tfrisch@uni-koblenz.de> --- include/vkcv/Context.hpp | 4 +++- include/vkcv/Core.hpp | 6 ++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/include/vkcv/Context.hpp b/include/vkcv/Context.hpp index b756373d..d91855a5 100644 --- a/include/vkcv/Context.hpp +++ b/include/vkcv/Context.hpp @@ -16,7 +16,9 @@ namespace vkcv { /** - * @brief Class to manage the vulkan resources as an instance, + * @brief Class to manage core resources for vulkan callbacks. + * + * The class to manage the vulkan resources as an instance, * a device, a physical device and a memory allocator. Additionally * instances of this class will hold the feature manager and the * queue manager. diff --git a/include/vkcv/Core.hpp b/include/vkcv/Core.hpp index 86c1586d..29fe152f 100644 --- a/include/vkcv/Core.hpp +++ b/include/vkcv/Core.hpp @@ -53,8 +53,10 @@ namespace vkcv }; /** - * @brief The class handles the core functionality of the framework with - * most calls addressing resource management via more simplified abstraction. + * @brief Class to handle the core functionality of the framework. + * + * The class handles the core functionality of the framework with most + * calls addressing resource management via more simplified abstraction. */ class Core final { -- GitLab