[libcamera-devel] [PATCH v2 07/11] ipa: ipu3: Document AWB Algorithm overriden functions

[Jean-Michel Hautbois]

Now that Algorithm is defined in libipa, we miss documentation for the
functions implemented in IPU3::Awb. Fix it.

Signed-off-by: Jean-Michel Hautbois <jeanmichel.hautbois at ideasonboard.com>
---
 src/ipa/ipu3/algorithms/awb.cpp | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/ipa/ipu3/algorithms/awb.cpp b/src/ipa/ipu3/algorithms/awb.cpp
index c7bcb20e..85205333 100644
--- a/src/ipa/ipu3/algorithms/awb.cpp
+++ b/src/ipa/ipu3/algorithms/awb.cpp
@@ -193,6 +193,9 @@ Awb::Awb()
 
 Awb::~Awb() = default;
 
+/**
+ * \brief Configure the AWB given a configInfo
+ */
 int Awb::configure(IPAContext &context,
 		   [[maybe_unused]] const IPAConfigInfo &configInfo)
 {
@@ -373,6 +376,9 @@ void Awb::calculateWBGains(const ipu3_uapi_stats_3a *stats)
 	}
 }
 
+/**
+ * \brief Process IPU3 statistics, and run algorithm operations
+ */
 void Awb::process(IPAContext &context, const ipu3_uapi_stats_3a *stats)
 {
 	calculateWBGains(stats);
@@ -394,6 +400,9 @@ constexpr uint16_t Awb::threshold(float value)
 	return value * 8191;
 }
 
+/**
+ * \brief Fill the \a params buffer with IPU3 processing parameters for a frame
+ */
 void Awb::prepare(IPAContext &context, ipu3_uapi_params *params)
 {
 	/*
-- 
2.32.0