Hi Mauro,
Thank you for the patch.
On Thursday, 28 September 2017 00:46:58 EEST Mauro Carvalho Chehab wrote:
> There are a few nested members at v4l2-ctrls.h. Now that
> kernel-doc supports, document them.
>
> Signed-off-by: Mauro Carvalho Chehab <mche...@s-opensource.com>
> ---
> include/media/v4l2-ctrls.h | 11 +++++++++--
> 1 file changed, 9 insertions(+), 2 deletions(-)
>
> diff --git a/include/media/v4l2-ctrls.h b/include/media/v4l2-ctrls.h
> index dacfe54057f8..ca05f0f49bc5 100644
> --- a/include/media/v4l2-ctrls.h
> +++ b/include/media/v4l2-ctrls.h
> @@ -147,7 +147,7 @@ typedef void (*v4l2_ctrl_notify_fnc)(struct v4l2_ctrl
> *ctrl, void *priv); * @type_ops: The control type ops.
> * @id: The control ID.
> * @name: The control name.
> - * @type: The control type.
> + * @type: The control type, as defined by &enum v4l2_ctrl_type.
Why do you need this ? The field is an enum v4l2_ctrl_type, Sphinx should
generate the proper link already.
> * @minimum: The control's minimum value.
> * @maximum: The control's maximum value.
> * @default_value: The control's default value.
> @@ -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: Struct to store data about the current value.
s/Struct/Structure/
s/data about the current value/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
--
Regards,
Laurent Pinchart
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
