[libcamera-devel] [PATCH v2 2/7] libcamera: controls: Document control_ids.h

[Jacopo Mondi]

The control identifiers documentation was not generated as they're not
part of the controls.h file documented in controls.cpp.

Move documentation for control id to the end of the controls.cpp and
document the control_ids.h file to have documentation for controls
properly generated.

Signed-off-by: Jacopo Mondi <jacopo at jmondi.org>
---
 src/libcamera/controls.cpp | 100 ++++++++++++++++++++-----------------
 1 file changed, 53 insertions(+), 47 deletions(-)

diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp
index 727fdbd9450d..9adc3badc254 100644
--- a/src/libcamera/controls.cpp
+++ b/src/libcamera/controls.cpp
@@ -181,53 +181,6 @@ std::string ControlValue::toString() const
 	return "<ValueType Error>";
 }
 
-/**
- * \enum ControlId
- * \brief Numerical control ID
- */
-
-/**
- * \var AwbEnable
- * ControlType: Bool
- *
- * Enables or disables the AWB. See also \a libcamera::ControlId::ManualGain
- */
-
-/**
- * \var Brightness
- * ControlType: Integer
- *
- * Specify a fixed brightness parameter.
- */
-
-/**
- * \var Contrast
- * ControlType: Integer
- *
- * Specify a fixed contrast parameter.
- */
-
-/**
- * \var Saturation
- * ControlType: Integer
- *
- * Specify a fixed saturation parameter.
- */
-
-/**
- * \var ManualExposure
- * ControlType: Integer
- *
- * Specify a fixed exposure time in milli-seconds
- */
-
-/**
- * \var ManualGain
- * ControlType: Integer
- *
- * Specify a fixed gain parameter
- */
-
 /**
  * \struct ControlIdentifier
  * \brief Describe a ControlId with control specific constant meta-data
@@ -549,4 +502,57 @@ void ControlList::update(const ControlList &other)
 	}
 }
 
+/**
+ * \file control_ids.h
+ * \brief Definition of numerical identifiers for libcamera control and
+ * properties
+ */
+
+/**
+ * \enum ControlId
+ * \brief Numerical control ID
+ */
+
+/**
+ * \var AwbEnable
+ * ControlType: Bool
+ *
+ * Enables or disables the AWB. See also \a libcamera::ControlId::ManualGain
+ */
+
+/**
+ * \var Brightness
+ * ControlType: Integer
+ *
+ * Specify a fixed brightness parameter.
+ */
+
+/**
+ * \var Contrast
+ * ControlType: Integer
+ *
+ * Specify a fixed contrast parameter.
+ */
+
+/**
+ * \var Saturation
+ * ControlType: Integer
+ *
+ * Specify a fixed saturation parameter.
+ */
+
+/**
+ * \var ManualExposure
+ * ControlType: Integer
+ *
+ * Specify a fixed exposure time in milli-seconds
+ */
+
+/**
+ * \var ManualGain
+ * ControlType: Integer
+ *
+ * Specify a fixed gain parameter
+ */
+
 } /* namespace libcamera */
-- 
2.23.0