Add doxygen group comments

Signed-off-by: Tobias Frisch <tfrisch@uni-koblenz.de>

modules/effects/include/vkcv/effects/BloomAndFlaresEffect.hpp

@@ -7,6 +7,11 @@
 
 namespace vkcv::effects {
 	
+	/**
+     * @addtogroup vkcv_effects
+     * @{
+     */
+	
 	class BloomAndFlaresEffect : public Effect {
 	private:
 		bool m_advanced;
@@ -57,8 +62,8 @@ namespace vkcv::effects {
 							   const ImageHandle &output);
 		
 	public:
-		BloomAndFlaresEffect(Core& core,
-							 bool advanced = false);
+		explicit BloomAndFlaresEffect(Core& core,
+									  bool advanced = false);
 		
 		void recordEffect(const CommandStreamHandle &cmdStream,
 						  const ImageHandle &input,
@@ -70,4 +75,6 @@ namespace vkcv::effects {
 		
 	};
 	
+	/** @} */
+	
 }

modules/effects/include/vkcv/effects/Effect.hpp

@@ -5,6 +5,12 @@
 
 namespace vkcv::effects {
 	
+	/**
+     * @defgroup vkcv_effects Effects Module
+     * A module to apply certain post-processing effects to an image in realtime.
+     * @{
+     */
+	
 	class Effect {
 	protected:
 		Core& m_core;
@@ -20,4 +26,6 @@ namespace vkcv::effects {
 		
 	};
 	
+	/** @} */
+	
 }

modules/effects/include/vkcv/effects/GammaCorrectionEffect.hpp

@@ -4,6 +4,11 @@
 
 namespace vkcv::effects {
 	
+	/**
+     * @addtogroup vkcv_effects
+     * @{
+     */
+	
 	class GammaCorrectionEffect : public Effect {
 	private:
 		float m_gamma;
@@ -15,7 +20,7 @@ namespace vkcv::effects {
 		DescriptorSetHandle m_descriptorSet;
 	
 	public:
-		GammaCorrectionEffect(Core& core);
+		explicit GammaCorrectionEffect(Core& core);
 		
 		void recordEffect(const CommandStreamHandle& cmdStream,
 						  const ImageHandle& input,
@@ -23,8 +28,11 @@ namespace vkcv::effects {
 		
 		void setGamma(float gamma);
 		
+		[[nodiscard]]
 		float getGamma() const;
 		
 	};
 	
+	/** @} */
+	
 }

modules/tone_mapping/include/vkcv/tone/ACESToneMapping.hpp

@@ -4,6 +4,11 @@
 
 namespace vkcv::tone {
 	
+	/**
+     * @addtogroup vkcv_tone
+     * @{
+     */
+	
 	class ACESToneMapping : public ToneMapping {
 	private:
 		void initToneMapping() override;
@@ -13,4 +18,6 @@ namespace vkcv::tone {
 		
 	};
 	
+	/** @} */
+	
 }

modules/tone_mapping/include/vkcv/tone/FilmicToneMapping.hpp

@@ -4,6 +4,11 @@
 
 namespace vkcv::tone {
 	
+	/**
+     * @addtogroup vkcv_tone
+     * @{
+     */
+	
 	class FilmicToneMapping : public ToneMapping {
 	private:
 		void initToneMapping() override;
@@ -13,4 +18,6 @@ namespace vkcv::tone {
 		
 	};
 	
+	/** @} */
+	
 }

modules/tone_mapping/include/vkcv/tone/LottesToneMapping.hpp

@@ -4,6 +4,11 @@
 
 namespace vkcv::tone {
 	
+	/**
+     * @addtogroup vkcv_tone
+     * @{
+     */
+	
 	class LottesToneMapping : public ToneMapping {
 	private:
 		void initToneMapping() override;
@@ -13,4 +18,6 @@ namespace vkcv::tone {
 		
 	};
 	
+	/** @} */
+	
 }

modules/tone_mapping/include/vkcv/tone/Reinhard2ToneMapping.hpp

@@ -4,6 +4,11 @@
 
 namespace vkcv::tone {
 	
+	/**
+     * @addtogroup vkcv_tone
+     * @{
+     */
+	
 	class Reinhard2ToneMapping : public ToneMapping {
 	private:
 		void initToneMapping() override;
@@ -13,4 +18,6 @@ namespace vkcv::tone {
 		
 	};
 	
+	/** @} */
+	
 }

modules/tone_mapping/include/vkcv/tone/ReinhardToneMapping.hpp

@@ -4,6 +4,11 @@
 
 namespace vkcv::tone {
 	
+	/**
+     * @addtogroup vkcv_tone
+     * @{
+     */
+	
 	class ReinhardToneMapping : public ToneMapping {
 	private:
 		void initToneMapping() override;
@@ -13,4 +18,6 @@ namespace vkcv::tone {
 		
 	};
 	
+	/** @} */
+	
 }

modules/tone_mapping/include/vkcv/tone/ToneMapping.hpp

@@ -4,6 +4,12 @@
 
 namespace vkcv::tone {
 	
+	/**
+     * @defgroup vkcv_tone Tone Mapping Module
+     * A module to apply tone mapping to an image in realtime.
+     * @{
+     */
+	
 	class ToneMapping {
 	private:
 		/**
@@ -11,9 +17,19 @@ namespace vkcv::tone {
          */
 		Core& m_core;
 		
+		/**
+		 * The name of the tone mapping instance.
+		 */
 		std::string m_name;
+		
+		/**
+		 * Flag whether tone mapping should normalize before mapping.
+		 */
 		bool m_normalize;
 		
+		/**
+		 * The compute pipeline of the tone mapping instance.
+		 */
 		ComputePipelineHandle m_pipeline;
 		
 		/**
@@ -41,7 +57,7 @@ namespace vkcv::tone {
          *
          * @param[in,out] core Reference to a Core instance
          * @param[in] name Name of the tone mapping function
-         * @param[in] normalize Normalize color values
+         * @param[in] normalize (Optional) Flag to normalize color values
          */
 		explicit ToneMapping(Core& core,
 							 const std::string& name,
@@ -49,6 +65,11 @@ namespace vkcv::tone {
 	
 		~ToneMapping() = default;
 		
+		/**
+		 * Return name of the tone mapping instance.
+		 *
+		 * @return Name of the tone mapping
+		 */
 		[[nodiscard]]
 		const std::string& getName() const;
 		
@@ -67,4 +88,6 @@ namespace vkcv::tone {
 		
 	};
 	
+	/** @} */
+	
 }

modules/tone_mapping/include/vkcv/tone/UchimuraToneMapping.hpp

@@ -4,6 +4,11 @@
 
 namespace vkcv::tone {
 	
+	/**
+     * @addtogroup vkcv_tone
+     * @{
+     */
+	
 	class UchimuraToneMapping : public ToneMapping {
 	private:
 		void initToneMapping() override;
@@ -13,4 +18,6 @@ namespace vkcv::tone {
 		
 	};
 	
+	/** @} */
+	
 }

modules/tone_mapping/include/vkcv/tone/Uncharted2ToneMapping.hpp

@@ -4,6 +4,11 @@
 
 namespace vkcv::tone {
 	
+	/**
+     * @addtogroup vkcv_tone
+     * @{
+     */
+	
 	class Uncharted2ToneMapping : public ToneMapping {
 	private:
 		void initToneMapping() override;
@@ -13,4 +18,6 @@ namespace vkcv::tone {
 		
 	};
 	
+	/** @} */
+	
 }

modules/tone_mapping/include/vkcv/tone/UnrealToneMapping.hpp

@@ -4,6 +4,11 @@
 
 namespace vkcv::tone {
 	
+	/**
+     * @addtogroup vkcv_tone
+     * @{
+     */
+	
 	class UnrealToneMapping : public ToneMapping {
 	private:
 		void initToneMapping() override;
@@ -13,4 +18,6 @@ namespace vkcv::tone {
 		
 	};
 	
+	/** @} */
+	
 }