media: v4l2-ctrls: document nested members of structs
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Wed, 27 Sep 2017 16:25:21 +0000 (12:25 -0400)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Mon, 18 Dec 2017 15:21:16 +0000 (10:21 -0500)
There are a few nested members at v4l2-ctrls.h. Now that
kernel-doc supports, document them.

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

index dacfe54057f8f1f185bc49c1fe25fea8ea07d59f..5ccf5019408ade15711ca40f2d3fcb55e42fa3e2 100644 (file)
@@ -166,8 +166,15 @@ typedef void (*v4l2_ctrl_notify_fnc)(struct v4l2_ctrl *ctrl, void *priv);
  *             empty strings ("") correspond to non-existing menu items (this
  *             is in addition to the menu_skip_mask above). The last entry
  *             must be NULL.
+ *             Used only if the @type is %V4L2_CTRL_TYPE_MENU.
+ * @qmenu_int: A 64-bit integer array for with integer menu items.
+ *             The size of array must be equal to the menu size, e. g.:
+ *             :math:`ceil(\frac{maximum - minimum}{step}) + 1`.
+ *             Used only if the @type is %V4L2_CTRL_TYPE_INTEGER_MENU.
  * @flags:     The control's flags.
- * @cur:       The control's current value.
+ * @cur:       Structure to store the current value.
+ * @cur.val:   The control's current value, if the @type is represented via
+ *             a u32 integer (see &enum v4l2_ctrl_type).
  * @val:       The control's new s32 value.
  * @priv:      The control's private pointer. For use by the driver. It is
  *             untouched by the control framework. Note that this pointer is