[libcamera-devel] [PATCH v4 16/19] ipa: ipu3: Fix badly documented context variables

Jean-Michel Hautbois jeanmichel.hautbois at ideasonboard.com
Tue Oct 26 11:55:31 CEST 2021


Doxygen warns us because the structures are referenced as \struct while
they should be \var. Fix it.

Signed-off-by: Jean-Michel Hautbois <jeanmichel.hautbois at ideasonboard.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
Reviewed-by: Kieran Bingham <kieran.bingham at ideasonboard.com>
---
 src/ipa/ipu3/ipa_context.cpp | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp
index 3e154e60..8917ba54 100644
--- a/src/ipa/ipu3/ipa_context.cpp
+++ b/src/ipa/ipu3/ipa_context.cpp
@@ -56,7 +56,7 @@ namespace libcamera::ipa::ipu3 {
  */
 
 /**
- * \struct IPASessionConfiguration::grid
+ * \var IPASessionConfiguration::grid
  * \brief Grid configuration of the IPA
  *
  * \var IPASessionConfiguration::grid::bdsGrid
@@ -70,7 +70,7 @@ namespace libcamera::ipa::ipu3 {
  */
 
 /**
- * \struct IPASessionConfiguration::agc
+ * \var IPASessionConfiguration::agc
  * \brief AGC parameters configuration of the IPA
  *
  * \var IPASessionConfiguration::agc::minShutterSpeed
@@ -87,7 +87,7 @@ namespace libcamera::ipa::ipu3 {
  */
 
 /**
- * \struct IPAFrameContext::agc
+ * \var IPAFrameContext::agc
  * \brief Context for the Automatic Gain Control algorithm
  *
  * The exposure and gain determined are expected to be applied to the sensor
@@ -103,7 +103,7 @@ namespace libcamera::ipa::ipu3 {
  */
 
 /**
- * \struct IPAFrameContext::awb
+ * \var IPAFrameContext::awb
  * \brief Context for the Automatic White Balance algorithm
  *
  * \struct IPAFrameContext::awb::gains
@@ -120,7 +120,7 @@ namespace libcamera::ipa::ipu3 {
  */
 
 /**
- * \struct IPAFrameContext::toneMapping
+ * \var IPAFrameContext::toneMapping
  * \brief Context for ToneMapping and Gamma control
  *
  * \var IPAFrameContext::toneMapping::gamma
-- 
2.32.0



More information about the libcamera-devel mailing list