On 09/27/17 23:46, Mauro Carvalho Chehab wrote:
> The can_reduce_fps() is already documented, but it is not
> using the kernel-doc markup. Convert it, in order to generate
> documentation from it.
>
> Signed-off-by: Mauro Carvalho Chehab <mche...@s-opensource.com>
Acked-by: Hans Verkuil <hans.verk...@cisco.com>
> ---
> include/media/v4l2-dv-timings.h | 14 ++++++++------
> 1 file changed, 8 insertions(+), 6 deletions(-)
>
> diff --git a/include/media/v4l2-dv-timings.h b/include/media/v4l2-dv-timings.h
> index 61a18893e004..c0855887ad87 100644
> --- a/include/media/v4l2-dv-timings.h
> +++ b/include/media/v4l2-dv-timings.h
> @@ -203,13 +203,15 @@ struct v4l2_fract v4l2_calc_aspect_ratio(u8
> hor_landscape, u8 vert_portrait);
> */
> struct v4l2_fract v4l2_dv_timings_aspect_ratio(const struct v4l2_dv_timings
> *t);
>
> -/*
> - * reduce_fps - check if conditions for reduced fps are true.
> - * bt - v4l2 timing structure
> +/**
> + * can_reduce_fps - check if conditions for reduced fps are true.
> + * @bt: v4l2 timing structure
> + *
> * For different timings reduced fps is allowed if following conditions
> - * are met -
> - * For CVT timings: if reduced blanking v2 (vsync == 8) is true.
> - * For CEA861 timings: if V4L2_DV_FL_CAN_REDUCE_FPS flag is true.
> + * are met:
> + *
> + * - For CVT timings: if reduced blanking v2 (vsync == 8) is true.
> + * - For CEA861 timings: if %V4L2_DV_FL_CAN_REDUCE_FPS flag is true.
> */
> static inline bool can_reduce_fps(struct v4l2_bt_timings *bt)
> {
>
