[01/15] libipa: awb: Sort class member documentation according to header order
diff mbox series

Message ID 20250223230403.1226-2-laurent.pinchart@ideasonboard.com
State Accepted
Headers show
Series
  • libipa: awb: Drive-by fixes
Related show

Commit Message

Laurent Pinchart Feb. 23, 2025, 11:03 p.m. UTC
Sort the documentation of the class members in the same order as the
member declaration in the class definition, as is customary in
libcamera.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 src/ipa/libipa/awb.cpp | 58 +++++++++++++++++++++---------------------
 1 file changed, 29 insertions(+), 29 deletions(-)

Comments

Stefan Klug Feb. 24, 2025, 8:58 a.m. UTC | #1
Hi Laurent,

Thank you for the patch.

On Mon, Feb 24, 2025 at 01:03:49AM +0200, Laurent Pinchart wrote:
> Sort the documentation of the class members in the same order as the
> member declaration in the class definition, as is customary in
> libcamera.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Reviewed-by: Stefan Klug <stefan.klug@ideasonboard.com>

> ---
>  src/ipa/libipa/awb.cpp | 58 +++++++++++++++++++++---------------------
>  1 file changed, 29 insertions(+), 29 deletions(-)
> 
> diff --git a/src/ipa/libipa/awb.cpp b/src/ipa/libipa/awb.cpp
> index 6157bd436183..2e78a4665509 100644
> --- a/src/ipa/libipa/awb.cpp
> +++ b/src/ipa/libipa/awb.cpp
> @@ -130,35 +130,6 @@ namespace ipa {
>   * \brief Handle the controls supplied in a request
>   */
>  
> -/**
> - * \var AwbAlgorithm::controls_
> - * \brief Controls info map for the controls provided by the algorithm
> - */
> -
> -/**
> - * \var AwbAlgorithm::modes_
> - * \brief Map of all configured modes
> - * \sa AwbAlgorithm::parseModeConfigs
> - */
> -
> -/**
> - * \class AwbAlgorithm::ModeConfig
> - * \brief Holds the configuration of a single AWB mode
> - *
> - * Awb modes limit the regulation of the AWB algorithm to a specific range of
> - * colour temperatures.
> - */
> -
> -/**
> - * \var AwbAlgorithm::ModeConfig::ctLo
> - * \brief The lowest valid colour temperature of that mode
> - */
> -
> -/**
> - * \var AwbAlgorithm::ModeConfig::ctHi
> - * \brief The highest valid colour temperature of that mode
> - */
> -
>  /**
>   * \brief Parse the mode configurations from the tuning data
>   * \param[in] tuningData the YamlObject representing the tuning data
> @@ -260,6 +231,35 @@ int AwbAlgorithm::parseModeConfigs(const YamlObject &tuningData,
>  	return 0;
>  }
>  
> +/**
> + * \class AwbAlgorithm::ModeConfig
> + * \brief Holds the configuration of a single AWB mode
> + *
> + * Awb modes limit the regulation of the AWB algorithm to a specific range of
> + * colour temperatures.
> + */
> +
> +/**
> + * \var AwbAlgorithm::ModeConfig::ctLo
> + * \brief The lowest valid colour temperature of that mode
> + */
> +
> +/**
> + * \var AwbAlgorithm::ModeConfig::ctHi
> + * \brief The highest valid colour temperature of that mode
> + */
> +
> +/**
> + * \var AwbAlgorithm::controls_
> + * \brief Controls info map for the controls provided by the algorithm
> + */
> +
> +/**
> + * \var AwbAlgorithm::modes_
> + * \brief Map of all configured modes
> + * \sa AwbAlgorithm::parseModeConfigs
> + */
> +
>  } /* namespace ipa */
>  
>  } /* namespace libcamera */
> -- 
> Regards,
> 
> Laurent Pinchart
>

Patch
diff mbox series

diff --git a/src/ipa/libipa/awb.cpp b/src/ipa/libipa/awb.cpp
index 6157bd436183..2e78a4665509 100644
--- a/src/ipa/libipa/awb.cpp
+++ b/src/ipa/libipa/awb.cpp
@@ -130,35 +130,6 @@  namespace ipa {
  * \brief Handle the controls supplied in a request
  */
 
-/**
- * \var AwbAlgorithm::controls_
- * \brief Controls info map for the controls provided by the algorithm
- */
-
-/**
- * \var AwbAlgorithm::modes_
- * \brief Map of all configured modes
- * \sa AwbAlgorithm::parseModeConfigs
- */
-
-/**
- * \class AwbAlgorithm::ModeConfig
- * \brief Holds the configuration of a single AWB mode
- *
- * Awb modes limit the regulation of the AWB algorithm to a specific range of
- * colour temperatures.
- */
-
-/**
- * \var AwbAlgorithm::ModeConfig::ctLo
- * \brief The lowest valid colour temperature of that mode
- */
-
-/**
- * \var AwbAlgorithm::ModeConfig::ctHi
- * \brief The highest valid colour temperature of that mode
- */
-
 /**
  * \brief Parse the mode configurations from the tuning data
  * \param[in] tuningData the YamlObject representing the tuning data
@@ -260,6 +231,35 @@  int AwbAlgorithm::parseModeConfigs(const YamlObject &tuningData,
 	return 0;
 }
 
+/**
+ * \class AwbAlgorithm::ModeConfig
+ * \brief Holds the configuration of a single AWB mode
+ *
+ * Awb modes limit the regulation of the AWB algorithm to a specific range of
+ * colour temperatures.
+ */
+
+/**
+ * \var AwbAlgorithm::ModeConfig::ctLo
+ * \brief The lowest valid colour temperature of that mode
+ */
+
+/**
+ * \var AwbAlgorithm::ModeConfig::ctHi
+ * \brief The highest valid colour temperature of that mode
+ */
+
+/**
+ * \var AwbAlgorithm::controls_
+ * \brief Controls info map for the controls provided by the algorithm
+ */
+
+/**
+ * \var AwbAlgorithm::modes_
+ * \brief Map of all configured modes
+ * \sa AwbAlgorithm::parseModeConfigs
+ */
+
 } /* namespace ipa */
 
 } /* namespace libcamera */