[libcamera-devel] [PATCH] libcamera: controls: Extend docs how to identify controls from ControlList

[Marian Cichy]

Informations how to identify Controls from a ControlList is quite
scattered around the documentation and not clear if one reads about the
ControlList. Referring to ControlId and ControlIdMap right in the
detailed description is probably very helpful.

Signed-off-by: Marian Cichy <m.cichy at pengutronix.de>
---
 src/libcamera/controls.cpp | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp
index c58ed394..b5253f83 100644
--- a/src/libcamera/controls.cpp
+++ b/src/libcamera/controls.cpp
@@ -805,6 +805,10 @@ ControlList::ControlList()
  * For ControlList containing libcamera controls, a global map of all libcamera
  * controls is provided by controls::controls and can be used as the \a idmap
  * argument.
+ *
+ * To identify a Control from the ControlList, one needs to find the ControlId
+ * from the numerical control id saved in this list. A global ControlIdMap
+ * of all libcamera controls is provided by controls::controls.
  */
 ControlList::ControlList(const ControlIdMap &idmap, ControlValidator *validator)
 	: validator_(validator), idmap_(&idmap), infoMap_(nullptr)
-- 
2.29.2