libipa: awb_grey: Minor comment fixes

Fix the top-level file description to mention the file contains an AWB
grey world implementation, not a base class, and fix a grammar mistake
in a documentation block.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Stefan Klug <stefan.klug@ideasonboard.com>
This commit is contained in:
Laurent Pinchart 2025-02-23 23:12:40 +02:00
parent 643af7f2e7
commit 127bc20965

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2024 Ideas on Board Oy
*
* Base class for grey world AWB algorithm
* Implementation of grey world AWB algorithm
*/
#include "awb_grey.h"
@ -61,10 +61,10 @@ int AwbGrey::init(const YamlObject &tuningData)
* \param[in] stats The statistics to use for the calculation
* \param[in] lux The lux value of the scene
*
* Estimates the colour temperature based on the colours::estimateCCT function.
* The gains are calculated purely based on the RGB means provided by the \a
* stats. The colour temperature is not taken into account when calculating the
* gains.
* The colour temperature is estimated based on the colours::estimateCCT()
* function. The gains are calculated purely based on the RGB means provided by
* the \a stats. The colour temperature is not taken into account when
* calculating the gains.
*
* The \a lux parameter is not used in this algorithm.
*