media: v4l2-flash-led-class.h: add kernel-doc to two helper funcs
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Thu, 28 Sep 2017 13:41:48 +0000 (09:41 -0400)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Mon, 18 Dec 2017 15:40:41 +0000 (10:40 -0500)
There are two helper functions at v4l2-flash-led-class.h
that aren't documented.

Document them.

Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
include/media/v4l2-flash-led-class.h

index 5c1d50f..0a5e451 100644 (file)
@@ -91,12 +91,24 @@ struct v4l2_flash {
        struct v4l2_ctrl **ctrls;
 };
 
+/**
+ * v4l2_subdev_to_v4l2_flash - Returns a &struct v4l2_flash from the
+ * &struct v4l2_subdev embedded on it.
+ *
+ * @sd: pointer to &struct v4l2_subdev
+ */
 static inline struct v4l2_flash *v4l2_subdev_to_v4l2_flash(
                                                        struct v4l2_subdev *sd)
 {
        return container_of(sd, struct v4l2_flash, sd);
 }
 
+/**
+ * v4l2_ctrl_to_v4l2_flash - Returns a &struct v4l2_flash from the
+ * &struct v4l2_ctrl embedded on it.
+ *
+ * @c: pointer to &struct v4l2_ctrl
+ */
 static inline struct v4l2_flash *v4l2_ctrl_to_v4l2_flash(struct v4l2_ctrl *c)
 {
        return container_of(c->handler, struct v4l2_flash, hdl);