[libcamera-devel] [PATCH] libcamera: device_enumerator: extend documentation of DeviceMatch

[Niklas Söderlund]

Extend the document of the intended usage of DeviceMatch need for
information to correctly function to find a uniquely identifiable media
device.

Signed-off-by: Niklas Söderlund <niklas.soderlund at ragnatech.se>
---
 src/libcamera/device_enumerator.cpp | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/libcamera/device_enumerator.cpp b/src/libcamera/device_enumerator.cpp
index 55c510e3b79a415b..e0b19313552f6aa5 100644
--- a/src/libcamera/device_enumerator.cpp
+++ b/src/libcamera/device_enumerator.cpp
@@ -52,6 +52,15 @@ namespace libcamera {
  *
  * The description is meant to be filled by pipeline managers and passed to a
  * device enumerator to find matching media devices.
+ *
+ * A DeviceMatch is created with a specific Linux device driver in mind, therefor
+ * the name of the driver is a required property. One or more Entity names can
+ * be added the matching with \a add().
+ *
+ * A pipeline handler should add as many entities to a DeviceMatch so that the
+ * media device can be uniquely identified in case a Linux device driver is
+ * capable of producing different media graphs as a result of different hardware
+ * versions or other circumstances.
  */
 
 /**
-- 
2.20.1