[libcamera-devel,v5,16/19] ipa: ipu3: Fix badly documented context variables
diff mbox series

Message ID 20211026112340.110169-17-jeanmichel.hautbois@ideasonboard.com
State Accepted
Commit 9b5f9e648788d15b562d7999e04935ece07da256
Headers show
Series
  • Document IPU3 IPA
Related show

Commit Message

Jean-Michel Hautbois Oct. 26, 2021, 11:23 a.m. UTC 
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@ideasonboard.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
 src/ipa/ipu3/ipa_context.cpp | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

Patch
diff mbox series 

diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp
index 94a5f7f6..e73ec248 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