[libcamera-devel,17/18] ipa: ipu3: Fix badly documented context variables
diff mbox series

Message ID 20210930095513.76213-18-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 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>
---
 src/ipa/ipu3/ipa_context.cpp | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Patch
diff mbox series 

diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp
index a38e6053..5a4c48f1 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::bdsGrid
@@ -67,7 +67,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
@@ -83,7 +83,7 @@  namespace libcamera::ipa::ipu3 {
  */
 
 /**
- * \struct IPAFrameContext::awb
+ * \var IPAFrameContext::awb
  * \brief Context for the Automatic White Balance algorithm
  *
  * \struct IPAFrameContext::awb::gains
@@ -100,7 +100,7 @@  namespace libcamera::ipa::ipu3 {
  */
 
 /**
- * \struct IPAFrameContext::toneMapping
+ * \var IPAFrameContext::toneMapping
  * \brief Context for ToneMapping and Gamma control
  *
  * \var IPAFrameContext::gamma