| Message ID | f6ac7366e711649241bb77aff997d6815d6c063e.1502409182.git.mchehab@s-opensource.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
On 11/08/17 02:16, Mauro Carvalho Chehab wrote: > The arguments for this function are pointers. Make it clear at > its documentation. > > Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> > --- > include/media/v4l2-ctrls.h | 18 +++++++++--------- > 1 file changed, 9 insertions(+), 9 deletions(-) > > diff --git a/include/media/v4l2-ctrls.h b/include/media/v4l2-ctrls.h > index 2d2aed56922f..6ba30acf06aa 100644 > --- a/include/media/v4l2-ctrls.h > +++ b/include/media/v4l2-ctrls.h > @@ -339,18 +339,18 @@ struct v4l2_ctrl_config { > /** > * v4l2_ctrl_fill - Fill in the control fields based on the control ID. > * > - * @id: ID of the control > - * @name: name of the control > - * @type: type of the control > - * @min: minimum value for the control > - * @max: maximum value for the control > - * @step: control step > - * @def: default value for the control > - * @flags: flags to be used on the control > + * @id: pointer for storing the ID of the control id isn't a pointer, all other arguments are. > + * @name: pointer for storing the name of the control This is a pointer to a pointer. > + * @type: pointer for storing the type of the control > + * @min: pointer for storing the minimum value for the control > + * @max: pointer for storing the maximum value for the control > + * @step: pointer for storing the control step > + * @def: pointer for storing the default value for the control > + * @flags: pointer for storing the flags to be used on the control > * > * This works for all standard V4L2 controls. > * For non-standard controls it will only fill in the given arguments > - * and @name will be %NULL. > + * and @name content will be filled with %NULL. I'd say: 'set to %NULL'. > * > * This function will overwrite the contents of @name, @type and @flags. > * The contents of @min, @max, @step and @def may be modified depending on > Regards, Hans
diff --git a/include/media/v4l2-ctrls.h b/include/media/v4l2-ctrls.h index 2d2aed56922f..6ba30acf06aa 100644 --- a/include/media/v4l2-ctrls.h +++ b/include/media/v4l2-ctrls.h @@ -339,18 +339,18 @@ struct v4l2_ctrl_config { /** * v4l2_ctrl_fill - Fill in the control fields based on the control ID. * - * @id: ID of the control - * @name: name of the control - * @type: type of the control - * @min: minimum value for the control - * @max: maximum value for the control - * @step: control step - * @def: default value for the control - * @flags: flags to be used on the control + * @id: pointer for storing the ID of the control + * @name: pointer for storing the name of the control + * @type: pointer for storing the type of the control + * @min: pointer for storing the minimum value for the control + * @max: pointer for storing the maximum value for the control + * @step: pointer for storing the control step + * @def: pointer for storing the default value for the control + * @flags: pointer for storing the flags to be used on the control * * This works for all standard V4L2 controls. * For non-standard controls it will only fill in the given arguments - * and @name will be %NULL. + * and @name content will be filled with %NULL. * * This function will overwrite the contents of @name, @type and @flags. * The contents of @min, @max, @step and @def may be modified depending on
The arguments for this function are pointers. Make it clear at its documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> --- include/media/v4l2-ctrls.h | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-)