From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date: Thu, 28 Sep 2017 13:34:54 +0000 (-0400)
Subject: media: v4l2-dev.h: add kernel-doc to two macros
X-Git-Tag: v4.16-rc1~57^2~190
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=69b925c5fc36d8f15377fb14a00803b017371d04;p=thirdparty%2Fkernel%2Fstable.git

media: v4l2-dev.h: add kernel-doc to two macros

There are two macros at v4l2-dev.h that aren't documented.

Document them, for completeness.

Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---

diff --git a/include/media/v4l2-dev.h b/include/media/v4l2-dev.h
index 28a686eb7d090..82b93e91e2eb6 100644
--- a/include/media/v4l2-dev.h
+++ b/include/media/v4l2-dev.h
@@ -261,9 +261,21 @@ struct video_device
 	struct mutex *lock;
 };
 
-#define media_entity_to_video_device(__e) \
-	container_of(__e, struct video_device, entity)
-/* dev to video-device */
+/**
+ * media_entity_to_video_device - Returns a &struct video_device from
+ *	the &struct media_entity embedded on it.
+ *
+ * @entity: pointer to &struct media_entity
+ */
+#define media_entity_to_video_device(entity) \
+	container_of(entity, struct video_device, entity)
+
+/**
+ * to_video_device - Returns a &struct video_device from the
+ *	&struct device embedded on it.
+ *
+ * @cd: pointer to &struct device
+ */
 #define to_video_device(cd) container_of(cd, struct video_device, dev)
 
 /**