summaryrefslogtreecommitdiff
path: root/src/mediactl.h
diff options
context:
space:
mode:
authorSakari Ailus <sakari.ailus@iki.fi>2012-01-14 21:33:36 +0200
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2012-05-05 14:34:18 +0200
commit888b03b281397f2569af50b33d3a7de3c93e0fd9 (patch)
tree84a27ef024b9cb0cacb31d8454e66e32aa6ad4b8 /src/mediactl.h
parentedad96b36f85dad7f681a7938b50b4619d11ed50 (diff)
libmediactl: Implement MEDIA_ENT_ID_FLAG_NEXT in media_get_entity_by_id()
Signed-off-by: Sakari Ailus <sakari.ailus@iki.fi> [laurent.pinchart@ideasonboard Clarify documentation] Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Diffstat (limited to 'src/mediactl.h')
-rw-r--r--src/mediactl.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/mediactl.h b/src/mediactl.h
index 1b47b7e..2296fe2 100644
--- a/src/mediactl.h
+++ b/src/mediactl.h
@@ -164,7 +164,11 @@ struct media_entity *media_get_entity_by_name(struct media_device *media,
* @param media - media device.
* @param id - entity ID.
*
- * Search for an entity with an ID equal to @a id.
+ * This function searches for an entity based on its ID using an exact match or
+ * next ID method based on the given @a id. If @a id is ORed with
+ * MEDIA_ENT_ID_FLAG_NEXT, the function will return the entity with the smallest
+ * ID larger than @a id. Otherwise it will return the entity with an ID equal to
+ * @a id.
*
* @return A pointer to the entity if found, or NULL otherwise.
*/