diff options
| author |   Hans Verkuil <hverkuil-cisco@xs4all.nl> | 2020-04-23 13:42:32 +0200 |
|---|---|---|
| committer |   Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-04-29 12:04:58 +0200 |
| commit | e51759f56d314d28c25be7606b03791f048e44c7 (patch) | |
| tree | 7e9b68398e3f840e201981cf70719aef7fa539c4 /include/media/v4l2-ctrls.h | |
| parent | media: cec-gpio: handle gpiod_get_value errors correctly (diff) | |
| download | wireguard-linux-e51759f56d314d28c25be7606b03791f048e44c7.tar.xz wireguard-linux-e51759f56d314d28c25be7606b03791f048e44c7.zip | |
media: v4l2-ctrls.h: clarify the p_def argument of v4l2_ctrl_new_std_compound
It was not sufficiently clear how to create and use p_def.
Improve the documentation.
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Diffstat (limited to 'include/media/v4l2-ctrls.h')
| -rw-r--r-- | include/media/v4l2-ctrls.h | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/include/media/v4l2-ctrls.h b/include/media/v4l2-ctrls.h index 75a8daacb4c4..757a713bad41 100644 --- a/include/media/v4l2-ctrls.h +++ b/include/media/v4l2-ctrls.h @@ -685,7 +685,9 @@ struct v4l2_ctrl *v4l2_ctrl_new_std_menu_items(struct v4l2_ctrl_handler *hdl, * @p_def: The control's default value. * * Sames as v4l2_ctrl_new_std(), but with support to compound controls, thanks - * to the @p_def field. + * to the @p_def field. Use v4l2_ctrl_ptr_create() to create @p_def from a + * pointer. Use v4l2_ctrl_ptr_create(NULL) if the default value of the + * compound control should be all zeroes. * */ struct v4l2_ctrl *v4l2_ctrl_new_std_compound(struct v4l2_ctrl_handler *hdl, |