[libcamera-devel,16/18] ipa: ipu3: awb: Document the Accumulator::sum variable
diff mbox series

Message ID 20210930095513.76213-17-jeanmichel.hautbois@ideasonboard.com
State Changes Requested
Headers show
Series
  • Document IPU3 IPA
Related show

Commit Message

Jean-Michel Hautbois Sept. 30, 2021, 9:55 a.m. UTC
Doxygen warns about the undocumented variable sum. Fix it by adding a
small brief.

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

Patch
diff mbox series

diff --git a/src/ipa/ipu3/algorithms/awb.cpp b/src/ipa/ipu3/algorithms/awb.cpp
index 59bc6900..af1edd11 100644
--- a/src/ipa/ipu3/algorithms/awb.cpp
+++ b/src/ipa/ipu3/algorithms/awb.cpp
@@ -86,6 +86,9 @@  static constexpr uint32_t kMinGreenLevelInZone = 32;
  *
  * \var Accumulator::blue
  * \brief Sum of the average blue values of each unsaturated cell in the zone
+ *
+ * \var Accumulator::sum
+ * \brief A structure containing the average red, green and blue sums
  */
 
 /**