Cleanup: use doxy sections, remove outdated comment

3 files changed, 99 insertions, 49 deletions

diff --git a/source/blender/compositor/realtime_compositor/COM_conversion_operation.hh b/source/blender/compositor/realtime_compositor/COM_conversion_operation.hh
index 15e1d0722ea..310333aea5a 100644
--- a/source/blender/compositor/realtime_compositor/COM_conversion_operation.hh
+++ b/source/blender/compositor/realtime_compositor/COM_conversion_operation.hh
@@ -11,11 +11,13 @@
 
 namespace blender::realtime_compositor {
 
-/* -------------------------------------------------------------------------------------------------
- * Conversion Operation
+/* -------------------------------------------------------------------- */
+/** \name Conversion Operation
  *
  * A simple operation that converts a result from a certain type to another. See the derived
- * classes for more details. */
+ * classes for more details.
+ * \{ */
+
 class ConversionOperation : public SimpleOperation {
  public:
   using SimpleOperation::SimpleOperation;
@@ -37,13 +39,18 @@ class ConversionOperation : public SimpleOperation {
 
   /* Get the shader the will be used for conversion. */
   virtual GPUShader *get_conversion_shader() const = 0;
-};
 
-/* -------------------------------------------------------------------------------------------------
- * Convert Float To Vector Operation
+  /** \} */
+
+};  // namespace blender::realtime_compositorclassConversionOperation:publicSimpleOperation
+
+/* -------------------------------------------------------------------- */
+/** \name Convert Float to Vector Operation
  *
  * Takes a float result and outputs a vector result. All three components of the output are filled
- * with the input float. */
+ * with the input float.
+ * \{ */
+
 class ConvertFloatToVectorOperation : public ConversionOperation {
  public:
   ConvertFloatToVectorOperation(Context &context);
@@ -53,11 +60,15 @@ class ConvertFloatToVectorOperation : public ConversionOperation {
   GPUShader *get_conversion_shader() const override;
 };
 
-/* -------------------------------------------------------------------------------------------------
- * Convert Float To Color Operation
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Convert Float to Color Operation
  *
  * Takes a float result and outputs a color result. All three color channels of the output are
- * filled with the input float and the alpha channel is set to 1. */
+ * filled with the input float and the alpha channel is set to 1.
+ * \{ */
+
 class ConvertFloatToColorOperation : public ConversionOperation {
  public:
   ConvertFloatToColorOperation(Context &context);
@@ -67,11 +78,15 @@ class ConvertFloatToColorOperation : public ConversionOperation {
   GPUShader *get_conversion_shader() const override;
 };
 
-/* -------------------------------------------------------------------------------------------------
- * Convert Color To Float Operation
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Convert Color to Float Operation
  *
  * Takes a color result and outputs a float result. The output is the average of the three color
- * channels, the alpha channel is ignored. */
+ * channels, the alpha channel is ignored.
+ * \{ */
+
 class ConvertColorToFloatOperation : public ConversionOperation {
  public:
   ConvertColorToFloatOperation(Context &context);
@@ -81,11 +96,15 @@ class ConvertColorToFloatOperation : public ConversionOperation {
   GPUShader *get_conversion_shader() const override;
 };
 
-/* -------------------------------------------------------------------------------------------------
- * Convert Color To Vector Operation
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Convert Color to Vector Operation
  *
  * Takes a color result and outputs a vector result. The output is a copy of the three color
- * channels to the three vector components. */
+ * channels to the three vector components.
+ * \{ */
+
 class ConvertColorToVectorOperation : public ConversionOperation {
  public:
   ConvertColorToVectorOperation(Context &context);
@@ -95,11 +114,18 @@ class ConvertColorToVectorOperation : public ConversionOperation {
   GPUShader *get_conversion_shader() const override;
 };
 
-/* -------------------------------------------------------------------------------------------------
- * Convert Vector To Float Operation
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Convert Vector to Float Operation
  *
  * Takes a vector result and outputs a float result. The output is the average of the three
- * components. */
+ * components.
+ * \{ */
+
+/*
+ *
+ * */
 class ConvertVectorToFloatOperation : public ConversionOperation {
  public:
   ConvertVectorToFloatOperation(Context &context);
@@ -109,11 +135,15 @@ class ConvertVectorToFloatOperation : public ConversionOperation {
   GPUShader *get_conversion_shader() const override;
 };
 
-/* -------------------------------------------------------------------------------------------------
- * Convert Vector To Color Operation
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Convert Vector to Color Operation
  *
  * Takes a vector result and outputs a color result. The output is a copy of the three vector
- * components to the three color channels with the alpha channel set to 1. */
+ * components to the three color channels with the alpha channel set to 1.
+ * \{ */
+
 class ConvertVectorToColorOperation : public ConversionOperation {
  public:
   ConvertVectorToColorOperation(Context &context);
@@ -123,4 +153,6 @@ class ConvertVectorToColorOperation : public ConversionOperation {
   GPUShader *get_conversion_shader() const override;
 };
 
+/** \} */
+
 }  // namespace blender::realtime_compositor
diff --git a/source/blender/compositor/realtime_compositor/intern/conversion_operation.cc b/source/blender/compositor/realtime_compositor/intern/conversion_operation.cc
index d6bf74ffbee..3743b9bba87 100644
--- a/source/blender/compositor/realtime_compositor/intern/conversion_operation.cc
+++ b/source/blender/compositor/realtime_compositor/intern/conversion_operation.cc
@@ -12,9 +12,9 @@
 
 namespace blender::realtime_compositor {
 
-/* -------------------------------------------------------------------------------------------------
- *  Conversion Operation.
- */
+/* -------------------------------------------------------------------- */
+/** \name Conversion Operation
+ * \{ */
 
 void ConversionOperation::execute()
 {
@@ -79,9 +79,11 @@ SimpleOperation *ConversionOperation::construct_if_needed(Context &context,
   return nullptr;
 }
 
-/* -------------------------------------------------------------------------------------------------
- *  Convert Float To Vector Operation.
- */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Convert Float to Vector Operation
+ * \{ */
 
 ConvertFloatToVectorOperation::ConvertFloatToVectorOperation(Context &context)
     : ConversionOperation(context)
@@ -102,9 +104,11 @@ GPUShader *ConvertFloatToVectorOperation::get_conversion_shader() const
   return shader_manager().get("compositor_convert_float_to_vector");
 }
 
-/* -------------------------------------------------------------------------------------------------
- *  Convert Float To Color Operation.
- */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Convert Float to Color Operation
+ * \{ */
 
 ConvertFloatToColorOperation::ConvertFloatToColorOperation(Context &context)
     : ConversionOperation(context)
@@ -127,9 +131,11 @@ GPUShader *ConvertFloatToColorOperation::get_conversion_shader() const
   return shader_manager().get("compositor_convert_float_to_color");
 }
 
-/* -------------------------------------------------------------------------------------------------
- *  Convert Color To Float Operation.
- */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Convert Color to Float Operation
+ * \{ */
 
 ConvertColorToFloatOperation::ConvertColorToFloatOperation(Context &context)
     : ConversionOperation(context)
@@ -151,9 +157,11 @@ GPUShader *ConvertColorToFloatOperation::get_conversion_shader() const
   return shader_manager().get("compositor_convert_color_to_float");
 }
 
-/* -------------------------------------------------------------------------------------------------
- *  Convert Color To Vector Operation.
- */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Convert Color to Vector Operation
+ * \{ */
 
 ConvertColorToVectorOperation::ConvertColorToVectorOperation(Context &context)
     : ConversionOperation(context)
@@ -175,9 +183,11 @@ GPUShader *ConvertColorToVectorOperation::get_conversion_shader() const
   return shader_manager().get("compositor_convert_color_to_vector");
 }
 
-/* -------------------------------------------------------------------------------------------------
- *  Convert Vector To Float Operation.
- */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Convert Vector to Float Operation
+ * \{ */
 
 ConvertVectorToFloatOperation::ConvertVectorToFloatOperation(Context &context)
     : ConversionOperation(context)
@@ -199,9 +209,11 @@ GPUShader *ConvertVectorToFloatOperation::get_conversion_shader() const
   return shader_manager().get("compositor_convert_vector_to_float");
 }
 
-/* -------------------------------------------------------------------------------------------------
- *  Convert Vector To Color Operation.
- */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Convert Vector to Color Operation
+ * \{ */
 
 ConvertVectorToColorOperation::ConvertVectorToColorOperation(Context &context)
     : ConversionOperation(context)
@@ -222,4 +234,6 @@ GPUShader *ConvertVectorToColorOperation::get_conversion_shader() const
   return shader_manager().get("compositor_convert_vector_to_color");
 }
 
+/** \} */
+
 }  // namespace blender::realtime_compositor
diff --git a/source/blender/compositor/realtime_compositor/intern/texture_pool.cc b/source/blender/compositor/realtime_compositor/intern/texture_pool.cc
index 1568970a030..6bf2041e6ba 100644
--- a/source/blender/compositor/realtime_compositor/intern/texture_pool.cc
+++ b/source/blender/compositor/realtime_compositor/intern/texture_pool.cc
@@ -13,9 +13,9 @@
 
 namespace blender::realtime_compositor {
 
-/* --------------------------------------------------------------------
- * Texture Pool Key.
- */
+/* -------------------------------------------------------------------- */
+/** \name Texture Pool Key
+ * \{ */
 
 TexturePoolKey::TexturePoolKey(int2 size, eGPUTextureFormat format) : size(size), format(format)
 {
@@ -37,9 +37,11 @@ bool operator==(const TexturePoolKey &a, const TexturePoolKey &b)
   return a.size == b.size && a.format == b.format;
 }
 
-/* --------------------------------------------------------------------
- * Texture Pool.
- */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Texture Pool
+ * \{ */
 
 GPUTexture *TexturePool::acquire(int2 size, eGPUTextureFormat format)
 {
@@ -81,4 +83,6 @@ void TexturePool::reset()
   textures_.clear();
 }
 
+/** \} */
+
 }  // namespace blender::realtime_compositor