[media] v4l2-flash-led-class.h: document v4l2_flash_ops
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Thu, 8 Sep 2016 21:23:35 +0000 (18:23 -0300)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Fri, 9 Sep 2016 13:19:35 +0000 (10:19 -0300)
Fix this warning:
./include/media/v4l2-flash-led-class.h:103: WARNING: c:type reference target not found: v4l2_flash_ops

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
include/media/v4l2-flash-led-class.h

index 3d184ab5227497fa50cffbd07d5f03936c103a28..b0fe4d6f4a5f713d5bbd7651a9f49ccca80cde4f 100644 (file)
@@ -20,7 +20,7 @@ struct led_classdev;
 struct v4l2_flash;
 enum led_brightness;
 
-/*
+/**
  * struct v4l2_flash_ctrl_data - flash control initialization data, filled
  *                             basing on the features declared by the LED flash
  *                             class driver in the v4l2_flash_config
@@ -33,14 +33,21 @@ struct v4l2_flash_ctrl_data {
        u32 cid;
 };
 
+/**
+ * struct v4l2_flash_ops - V4L2 flash operations
+ *
+ * @external_strobe_set: Setup strobing the flash by hardware pin state
+ *     assertion.
+ * @intensity_to_led_brightness: Convert intensity to brightness in a device
+ *     specific manner
+ * @led_brightness_to_intensity: convert brightness to intensity in a device
+ *     specific manner.
+ */
 struct v4l2_flash_ops {
-       /* setup strobing the flash by hardware pin state assertion */
        int (*external_strobe_set)(struct v4l2_flash *v4l2_flash,
                                        bool enable);
-       /* convert intensity to brightness in a device specific manner */
        enum led_brightness (*intensity_to_led_brightness)
                (struct v4l2_flash *v4l2_flash, s32 intensity);
-       /* convert brightness to intensity in a device specific manner */
        s32 (*led_brightness_to_intensity)
                (struct v4l2_flash *v4l2_flash, enum led_brightness);
 };