diff options
| author | Tharit Tangkijwanichakul <tharitt97@gmail.com> | 2026-07-13 23:24:03 +0700 |
|---|---|---|
| committer | Hans Verkuil <hverkuil+cisco@kernel.org> | 2026-07-15 17:12:55 +0200 |
| commit | cd05b6174e505c09304bee49894096706df4cc99 (patch) | |
| tree | 606eaa58c4ae84401fc220d86ce5feb2817e8258 /include | |
| parent | 3839365cf0d4ca08bf1026d5adaa50b9c7ffca41 (diff) | |
| download | linux-stable-cd05b6174e505c09304bee49894096706df4cc99.tar.gz linux-stable-cd05b6174e505c09304bee49894096706df4cc99.zip | |
media: videobuf2: move vb2_querybuf() kernel-doc to header
Move the function documentation for vb2_querybuf() from videobuf2-v4l2.c
to videobuf2-v4l2.h to match other functions.
Leaving the comment in the source file prevents the kernel-doc parser
from extracting it - thus become missing from the generated HTML.
Additionally, format the comment block to be the same style as other
functions in the header.
Signed-off-by: Tharit Tangkijwanichakul <tharitt97@gmail.com>
Signed-off-by: Hans Verkuil <hverkuil+cisco@kernel.org>
Diffstat (limited to 'include')
| -rw-r--r-- | include/media/videobuf2-v4l2.h | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/include/media/videobuf2-v4l2.h b/include/media/videobuf2-v4l2.h index 71d2864fb235..d51e10c10fc0 100644 --- a/include/media/videobuf2-v4l2.h +++ b/include/media/videobuf2-v4l2.h @@ -72,6 +72,19 @@ struct vb2_v4l2_buffer { */ struct vb2_buffer *vb2_find_buffer(struct vb2_queue *q, u64 timestamp); +/** + * vb2_querybuf() - Query video buffer information + * @q: pointer to &struct vb2_queue with videobuf2 queue. + * @b: buffer structure passed from userspace to + * &v4l2_ioctl_ops->vidioc_querybuf handler in driver + * + * Should be called from vidioc_querybuf ioctl handler in driver. + * This function will verify the passed v4l2_buffer structure and fill the + * relevant information for the userspace. + * + * The return values from this function are intended to be directly returned + * from vidioc_querybuf handler in driver. + */ int vb2_querybuf(struct vb2_queue *q, struct v4l2_buffer *b); /** |