[libcamera-devel] [PATCH] libcamera: delayed_controls: Add missing documentation for ControlParams

[Laurent Pinchart]

Hi Naush,

Thank you for the patch.

On Sat, Mar 13, 2021 at 10:02:18AM +0000, Naushir Patuck wrote:
> Document struct DelayedControls::ControlParams and its associated
> fields.
> 
> Signed-off-by: Naushir Patuck <naush at raspberrypi.com>
> ---
>  src/libcamera/delayed_controls.cpp | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
> 
> diff --git a/src/libcamera/delayed_controls.cpp b/src/libcamera/delayed_controls.cpp
> index a3917fd99e7a..0f70d087b22c 100644
> --- a/src/libcamera/delayed_controls.cpp
> +++ b/src/libcamera/delayed_controls.cpp
> @@ -37,6 +37,23 @@ LOG_DEFINE_CATEGORY(DelayedControls)
>   * delay.
>   */
>  
> +/**
> + * \struct DelayedControls::ControlParams
> + * \brief Parameters associated with controls handled by the \a DelayedControls
> + * helper class
> + *
> + * \var ControlParams::delay
> + * \brief Frame delay from setting the control on a sensor device to when it is
> + * consumed during framing.
> + *
> + * \var ControlParams::priorityWrite
> + * \brief Flag to indicate that this control must be applied
> + * ahead of, and separately from the other controls. Typically set for the \a
> + * V4L2_CID_VBLANK control so that the device driver does not reject \a
> + * V4L2_CID_EXPOSURE control values that may be outside of the existing vertical
> + * blanking specified bounds, but are within the new blanking bounds.

I'll add a blank line after the first sentence, otherwise the brief
isn't really a brief :-)

Reviewed-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>

> + */
> +
>  /**
>   * \brief Construct a DelayedControls instance
>   * \param[in] device The V4L2 device the controls have to be applied to

-- 
Regards,

Laurent Pinchart