NekoCWD/libcamera
NekoCWD/libcamera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 7 Wiki Activity Actions

libipa: awb: Follow function names with '()' in doxygen documentation

Browse source 
Function names are followed by parentheses in doxygen documentation
blocks as convention in libcamera. Add missing parentheses in the
AwbAlgorithm documentation.

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 704a3aa5d0
commit 7115b81310
1 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
src/ipa/libipa/awb.cpp
View file

@ -49,7 +49,7 @@ namespace ipa {
*/ */
/** /**
* \fn AwbStats::computeColourError * \fn AwbStats::computeColourError()
* \brief Compute an error value for when the given gains would be applied * \brief Compute an error value for when the given gains would be applied
* \param[in] gains The gains to apply * \param[in] gains The gains to apply
* *
@ -65,7 +65,7 @@ namespace ipa {
*/ */
/** /**
* \fn AwbStats::getRGBMeans * \fn AwbStats::getRGBMeans()
* \brief Get RGB means of the statistics * \brief Get RGB means of the statistics
* *
* Fetch the RGB means from the statistics. The values of each channel are * Fetch the RGB means from the statistics. The values of each channel are
@ -85,7 +85,7 @@ namespace ipa {
*/ */
/** /**
* \fn AwbAlgorithm::init * \fn AwbAlgorithm::init()
* \brief Initialize the algorithm with the given tuning data * \brief Initialize the algorithm with the given tuning data
* \param[in] tuningData The tuning data to use for the algorithm * \param[in] tuningData The tuning data to use for the algorithm
* *
@ -93,7 +93,7 @@ namespace ipa {
*/ */
/** /**
* \fn AwbAlgorithm::calculateAwb * \fn AwbAlgorithm::calculateAwb()
* \brief Calculate AWB data from the given statistics * \brief Calculate AWB data from the given statistics
* \param[in] stats The statistics to use for the calculation * \param[in] stats The statistics to use for the calculation
* \param[in] lux The lux value of the scene * \param[in] lux The lux value of the scene
@ -106,7 +106,7 @@ namespace ipa {
*/ */
/** /**
* \fn AwbAlgorithm::gainsFromColourTemperature * \fn AwbAlgorithm::gainsFromColourTemperature()
* \brief Compute white balance gains from a colour temperature * \brief Compute white balance gains from a colour temperature
* \param[in] colourTemperature The colour temperature in Kelvin * \param[in] colourTemperature The colour temperature in Kelvin
* *
@ -118,14 +118,14 @@ namespace ipa {
*/ */
/** /**
* \fn AwbAlgorithm::controls * \fn AwbAlgorithm::controls()
* \brief Get the controls info map for this algorithm * \brief Get the controls info map for this algorithm
* *
* \return The controls info map * \return The controls info map
*/ */
/** /**
* \fn AwbAlgorithm::handleControls * \fn AwbAlgorithm::handleControls()
* \param[in] controls The controls to handle * \param[in] controls The controls to handle
* \brief Handle the controls supplied in a request * \brief Handle the controls supplied in a request
*/ */