Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

media: v4l2-dv-timings.h: convert comment into kernel-doc markup

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.

Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Acked-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

+9 -7
+9 -7
include/media/v4l2-dv-timings.h
··· 203 203 */ 204 204 struct v4l2_fract v4l2_dv_timings_aspect_ratio(const struct v4l2_dv_timings *t); 205 205 206 - /* 207 - * reduce_fps - check if conditions for reduced fps are true. 208 - * bt - v4l2 timing structure 209 - * For different timings reduced fps is allowed if following conditions 210 - * are met - 211 - * For CVT timings: if reduced blanking v2 (vsync == 8) is true. 212 - * For CEA861 timings: if V4L2_DV_FL_CAN_REDUCE_FPS flag is true. 206 + /** 207 + * can_reduce_fps - check if conditions for reduced fps are true. 208 + * @bt: v4l2 timing structure 209 + * 210 + * For different timings reduced fps is allowed if the following conditions 211 + * are met: 212 + * 213 + * - For CVT timings: if reduced blanking v2 (vsync == 8) is true. 214 + * - For CEA861 timings: if %V4L2_DV_FL_CAN_REDUCE_FPS flag is true. 213 215 */ 214 216 static inline bool can_reduce_fps(struct v4l2_bt_timings *bt) 215 217 {