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

[media] videobuf2-v4l2: document two helper functions

Document vb2_ops_wait_prepare() and vb2_ops_wait_finish(),
in order to fix those two warnings:
Documentation/media/kapi/v4l2-dev.rst:166: WARNING: c:func reference target not found: vb2_ops_wait_prepare
Documentation/media/kapi/v4l2-dev.rst:166: WARNING: c:func reference target not found: vb2_ops_wait_finish

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

+15 -2
+15 -2
include/media/videobuf2-v4l2.h
··· 268 268 unsigned long len, unsigned long pgoff, unsigned long flags); 269 269 #endif 270 270 271 - /* struct vb2_ops helpers, only use if vq->lock is non-NULL. */ 272 - 271 + /** 272 + * vb2_ops_wait_prepare - helper function to lock a struct &vb2_queue 273 + * 274 + * @vq: pointer to struct vb2_queue 275 + * 276 + * ..note:: only use if vq->lock is non-NULL. 277 + */ 273 278 void vb2_ops_wait_prepare(struct vb2_queue *vq); 279 + 280 + /** 281 + * vb2_ops_wait_finish - helper function to unlock a struct &vb2_queue 282 + * 283 + * @vq: pointer to struct vb2_queue 284 + * 285 + * ..note:: only use if vq->lock is non-NULL. 286 + */ 274 287 void vb2_ops_wait_finish(struct vb2_queue *vq); 275 288 276 289 #endif /* _MEDIA_VIDEOBUF2_V4L2_H */