From 412b860f3fc4e0cc02a48e252d28bf90a458a845 Mon Sep 17 00:00:00 2001
From: Tobias Frisch <tfrisch@uni-koblenz.de>
Date: Mon, 13 Jun 2022 13:36:17 +0200
Subject: [PATCH] Adjusted some parts of the documentation
Signed-off-by: Tobias Frisch <tfrisch@uni-koblenz.de>
---
CMakeLists.txt | 2 +-
Doxyfile | 22 +++++++++----------
include/vkcv/BlitDownsampler.hpp | 20 +++++++++++++++++
include/vkcv/Downsampler.hpp | 6 ++---
.../vkcv/algorithm/SinglePassDownsampler.hpp | 6 ++---
5 files changed, 38 insertions(+), 18 deletions(-)
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 9166150f..2b74cee6 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -4,7 +4,7 @@ project(vkcv)
# cmake options
option(BUILD_MODULES "Enables building VkCV as shared libraries" ON)
option(BUILD_PROJECTS "Enables building the VkCV projects" ON)
-option(BUILD_CLANG_FORMAT "Enables formatting the source code" ON)
+option(BUILD_CLANG_FORMAT "Enables formatting the source code" OFF)
option(BUILD_DOXYGEN_DOCS "Enables building the VkCV doxygen documentation" OFF)
option(BUILD_SHARED "Enables building VkCV as shared libraries" OFF)
option(BUILD_VMA_VULKAN_VERSION "Enforce a specific Vulkan version for VMA" OFF)
diff --git a/Doxyfile b/Doxyfile
index 2be91661..706626db 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -363,7 +363,7 @@ BUILTIN_STL_SUPPORT = YES
# enable parsing support.
# The default value is: NO.
-CPP_CLI_SUPPORT = NO
+CPP_CLI_SUPPORT = YES
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
@@ -396,7 +396,7 @@ DISTRIBUTE_GROUP_DOC = NO
# is disabled and one has to add nested compounds explicitly via \ingroup.
# The default value is: NO.
-GROUP_NESTED_COMPOUNDS = NO
+GROUP_NESTED_COMPOUNDS = YES
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
# (for instance a group of public functions) to be put as a subgroup of that
@@ -426,7 +426,7 @@ INLINE_GROUPED_CLASSES = NO
# Man pages) or section (for LaTeX and RTF).
# The default value is: NO.
-INLINE_SIMPLE_STRUCTS = NO
+INLINE_SIMPLE_STRUCTS = YES
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
# enum is documented as struct, union, or enum with the name of the typedef. So
@@ -556,7 +556,7 @@ HIDE_UNDOC_CLASSES = NO
# documentation.
# The default value is: NO.
-HIDE_FRIEND_COMPOUNDS = NO
+HIDE_FRIEND_COMPOUNDS = YES
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
# documentation blocks found inside the body of a function. If set to NO, these
@@ -665,7 +665,7 @@ SORT_MEMBERS_CTORS_1ST = NO
# appear in their defined order.
# The default value is: NO.
-SORT_GROUP_NAMES = NO
+SORT_GROUP_NAMES = YES
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
# fully-qualified names, including namespaces. If set to NO, the class list will
@@ -675,7 +675,7 @@ SORT_GROUP_NAMES = NO
# list.
# The default value is: NO.
-SORT_BY_SCOPE_NAME = NO
+SORT_BY_SCOPE_NAME = YES
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
# type resolution of all parameters of a function it will reject a match between
@@ -741,7 +741,7 @@ SHOW_USED_FILES = YES
# (if specified).
# The default value is: YES.
-SHOW_FILES = YES
+SHOW_FILES = NO
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
# page. This will remove the Namespaces entry from the Quick Index and from the
@@ -834,7 +834,7 @@ WARN_IF_INCOMPLETE_DOC = YES
# WARN_IF_INCOMPLETE_DOC
# The default value is: NO.
-WARN_NO_PARAMDOC = NO
+WARN_NO_PARAMDOC = YES
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
@@ -1086,7 +1086,7 @@ USE_MDFILE_AS_MAINPAGE =
# also VERBATIM_HEADERS is set to NO.
# The default value is: NO.
-SOURCE_BROWSER = YES
+SOURCE_BROWSER = NO
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
# classes and enums directly into the documentation.
@@ -1105,13 +1105,13 @@ STRIP_CODE_COMMENTS = YES
# entity all documented functions referencing it will be listed.
# The default value is: NO.
-REFERENCED_BY_RELATION = YES
+REFERENCED_BY_RELATION = NO
# If the REFERENCES_RELATION tag is set to YES then for each documented function
# all documented entities called/used by that function will be listed.
# The default value is: NO.
-REFERENCES_RELATION = YES
+REFERENCES_RELATION = NO
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
diff --git a/include/vkcv/BlitDownsampler.hpp b/include/vkcv/BlitDownsampler.hpp
index ed14d37c..380e16e5 100644
--- a/include/vkcv/BlitDownsampler.hpp
+++ b/include/vkcv/BlitDownsampler.hpp
@@ -6,15 +6,35 @@ namespace vkcv {
class ImageManager;
+ /**
+ * @brief A class to handle downsampling via blit from a graphics queue.
+ */
class BlitDownsampler : public Downsampler {
friend class Core;
private:
+ /**
+ * Reference to the image manager.
+ */
ImageManager& m_imageManager;
+ /**
+ * @brief Constructor to create a blit downsampler instance.
+ *
+ * @param[in,out] core Reference to a Core instance
+ * @param[in,out] imageManager Reference to an image manager
+ */
BlitDownsampler(Core& core,
ImageManager& imageManager);
public:
+ /**
+ * @brief Record the commands of the downsampling instance to
+ * generate all mip levels of an input image via a
+ * command stream.
+ *
+ * @param[in] cmdStream Command stream handle
+ * @param[in] image Image handle
+ */
void recordDownsampling(const CommandStreamHandle& cmdStream,
const ImageHandle& image) override;
};
diff --git a/include/vkcv/Downsampler.hpp b/include/vkcv/Downsampler.hpp
index b288f358..e2ee75ea 100644
--- a/include/vkcv/Downsampler.hpp
+++ b/include/vkcv/Downsampler.hpp
@@ -7,7 +7,7 @@ namespace vkcv {
class Core;
/**
- * An abstract class to handle downsampling of images for mip generation.
+ * @brief An abstract class to handle downsampling of images for mip generation.
*/
class Downsampler {
protected:
@@ -18,7 +18,7 @@ namespace vkcv {
public:
/**
- * Constructor to create a downsampler instance.
+ * @brief Constructor to create a downsampler instance.
*
* @param[in,out] core Reference to a Core instance
*/
@@ -27,7 +27,7 @@ namespace vkcv {
~Downsampler() = default;
/**
- * Record the commands of the given downsampler instance to
+ * @brief Record the commands of the given downsampler instance to
* scale the image down on its own mip levels.
*
* @param[in] cmdStream Command stream handle
diff --git a/modules/algorithm/include/vkcv/algorithm/SinglePassDownsampler.hpp b/modules/algorithm/include/vkcv/algorithm/SinglePassDownsampler.hpp
index 02d2f8d6..c2d9721d 100644
--- a/modules/algorithm/include/vkcv/algorithm/SinglePassDownsampler.hpp
+++ b/modules/algorithm/include/vkcv/algorithm/SinglePassDownsampler.hpp
@@ -15,7 +15,7 @@ namespace vkcv::algorithm {
*/
/**
- * A class to handle downsampling via FidelityFX Single Pass Downsampler.
+ * @brief A class to handle downsampling via FidelityFX Single Pass Downsampler.
* https://github.com/GPUOpen-Effects/FidelityFX-SPD
*/
class SinglePassDownsampler : public vkcv::Downsampler {
@@ -47,7 +47,7 @@ namespace vkcv::algorithm {
public:
/**
- * Constructor to create instance for single pass downsampling.
+ * @brief Constructor to create instance for single pass downsampling.
*
* @param[in,out] core Reference to a Core instance
* @param[in] sampler Sampler handle
@@ -56,7 +56,7 @@ namespace vkcv::algorithm {
const SamplerHandle &sampler = SamplerHandle());
/**
- * Record the comands of the downsampling instance to
+ * @brief Record the commands of the downsampling instance to
* generate all mip levels of an input image via a
* command stream.
*
--
GitLab